IChemFormatMatcher (cdk 2.9 API)

All Superinterfaces:

IChemFormat, IResourceFormat

All Known Implementing Classes:

ABINITFormat, Aces2Format, ADFFormat, CACheFormat, CDKOWLFormat, CIFFormat, CMLFormat, CrystClustFormat, CTXFormat, DaltonFormat, GamessFormat, Gaussian03Format, Gaussian90Format, Gaussian92Format, Gaussian94Format, Gaussian95Format, Gaussian98Format, GhemicalMMFormat, GhemicalSPMFormat, HINFormat, INChIFormat, INChIPlainTextFormat, JaguarFormat, MDLFormat, MDLRXNFormat, MDLRXNV2000Format, MDLRXNV3000Format, MDLV2000Format, MDLV3000Format, Mol2Format, MOPAC2002Format, MOPAC2007Format, MOPAC2009Format, MOPAC2012Format, MOPAC7Format, MOPAC7InputFormat, MOPAC93Format, MOPAC97Format, MoSSOutputFormat, NWChemFormat, PDBFormat, PMPFormat, PubChemASNFormat, PubChemCompoundsXMLFormat, PubChemCompoundXMLFormat, PubChemSubstancesASNFormat, PubChemSubstancesXMLFormat, PubChemSubstanceXMLFormat, QChemFormat, RGroupQueryFormat, SDFFormat, ShelXFormat, SpartanFormat, VASPFormat, ZMatrixFormat
```
public interface IChemFormatMatcher
extends IChemFormat
```
This interface is used for classes that are able to match a certain chemical file format. For example: Chemical Markup Language, PDB etc.

Author:

Egon Willighagen <egonw@sci.kun.nl>

Source code:
main

Belongs to CDK module:
ioformats

Created on:

2004-10-25

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`IChemFormatMatcher.MatchResult`	Simple class holds whether a format matcher matched, when it matched and what the format was.

Field Summary

Fields
Modifier and Type Field Description

static IChemFormatMatcher.MatchResult NO_MATCH
Convenience method for indicating a format did not match.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IChemFormatMatcher.MatchResult`	`matches(List<String> lines)`	Method that checks whether the given lines are part of the format read by this reader.

Methods inherited from interface org.openscience.cdk.io.formats.IChemFormat
getReaderClassName, getRequiredDataFeatures, getSupportedDataFeatures, getWriterClassName

Methods inherited from interface org.openscience.cdk.io.formats.IResourceFormat
getFormatName, getMIMEType, getNameExtensions, getPreferredNameExtension, isXMLBased

- Field Detail
  - NO_MATCH
```
static final IChemFormatMatcher.MatchResult NO_MATCH
```
    Convenience method for indicating a format did not match.
- Method Detail
  - matches
```
IChemFormatMatcher.MatchResult matches(List<String> lines)
```
    Method that checks whether the given lines are part of the format read by this reader.
    
    Parameters:
    
    lines - lines of the input to be checked
    
    Returns:
    
    whether the format matched and when it matched