Overview  Package   Class  Use  Deprecated  Index
Home >> All >> joelib >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

joelib.io
Interface MoleculeFileType  

All Known Implementing Classes:

SimpleImageWriter

---

public interface MoleculeFileType

Interface for implementing molecule reader/writer classes.

---

Method Summary
void	closeReader()           Description of the Method
void	closeWriter()           Description of the Method
void	initReader(java.io.InputStream is)           Description of the Method
void	initWriter(java.io.OutputStream os)           Description of the Method
java.lang.String	inputDescription()           Description of the Method
java.lang.String[]	inputFileExtensions()           Description of the Method
java.lang.String	outputDescription()           Description of the Method
java.lang.String[]	outputFileExtensions()           Description of the Method
java.lang.String	read()           Reads an molecule entry as (unparsed) String representation.
boolean	read(joelib.molecule.JOEMol mol)           Reads an molecule entry from the initialized molecule reader.
boolean	read(joelib.molecule.JOEMol mol, java.lang.String title)           Reads an molecule entry from the initialized molecule reader.
boolean	readable()           Returns true if this molecule data type is readable.
boolean	skipReaderEntry()           Skips an molecule or the rest of a molecule entry to grant the next read(JOEMol mol) invocation a proper starting position.
boolean	write(joelib.molecule.JOEMol mol)           Reads an molecule entry from the initialized molecule reader.
boolean	write(joelib.molecule.JOEMol mol, java.lang.String title)           Reads an molecule entry from the initialized molecule reader.
boolean	writeable()           Returns true if this molecule data type is writeable.

 

Method Detail

closeReader

public void closeReader()
                 throws java.io.IOException

Description of the Method

---

closeWriter

public void closeWriter()
                 throws java.io.IOException

Description of the Method

---

initReader

public void initReader(java.io.InputStream is)
                throws java.io.IOException

Description of the Method

---

initWriter

public void initWriter(java.io.OutputStream os)
                throws java.io.IOException

Description of the Method

---

inputDescription

public java.lang.String inputDescription()

Description of the Method

---

inputFileExtensions

public java.lang.String[] inputFileExtensions()

Description of the Method

---

outputDescription

public java.lang.String outputDescription()

Description of the Method

---

outputFileExtensions

public java.lang.String[] outputFileExtensions()

Description of the Method

---

read

public java.lang.String read()
                      throws java.io.IOException

Reads an molecule entry as (unparsed) String representation.

---

read

public boolean read(joelib.molecule.JOEMol mol)
             throws java.io.IOException,
                    MoleculeIOException

Reads an molecule entry from the initialized molecule reader. If an MoleculeIOException occurs the molecule reader stream should be set to the start of the next molecule entry. Use: skipReaderEntry()

---

read

public boolean read(joelib.molecule.JOEMol mol,
                    java.lang.String title)
             throws java.io.IOException,
                    MoleculeIOException

Reads an molecule entry from the initialized molecule reader. If an MoleculeIOException occurs the molecule reader stream should be set to the start of the next molecule entry. Use: skipReaderEntry()

---

readable

public boolean readable()

Returns true if this molecule data type is readable.

---

skipReaderEntry

public boolean skipReaderEntry()
                        throws java.io.IOException

Skips an molecule or the rest of a molecule entry to grant the next read(JOEMol mol) invocation a proper starting position. This method should always be called if you plan to throw an MoleculeIOException.

---

write

public boolean write(joelib.molecule.JOEMol mol)
              throws java.io.IOException,
                     MoleculeIOException

Reads an molecule entry from the initialized molecule reader.

---

write

public boolean write(joelib.molecule.JOEMol mol,
                     java.lang.String title)
              throws java.io.IOException,
                     MoleculeIOException

Reads an molecule entry from the initialized molecule reader.

---

writeable

public boolean writeable()

Returns true if this molecule data type is writeable.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> joelib >> [ io overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---