Package org.openscience.cdk.io
Class XYZReader
java.lang.Object
org.openscience.cdk.io.ChemObjectIO
org.openscience.cdk.io.DefaultChemObjectReader
org.openscience.cdk.io.XYZReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,IChemObjectIO
,IChemObjectReader
,ISimpleChemObjectReader
Reads an object from XYZ formated input.
This class is based on Dan Gezelter's XYZReader from Jmol
- Source code:
- main
- Belongs to CDK module:
- io
- Keywords:
- file format, XYZ
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.openscience.cdk.io.IChemObjectReader
IChemObjectReader.Mode
-
Field Summary
Fields inherited from class org.openscience.cdk.io.DefaultChemObjectReader
errorHandler, mode
-
Constructor Summary
ConstructorsConstructorDescriptionXYZReader
(InputStream input) Construct a new reader from a Reader type object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
accepts
(Class<? extends IChemObject> classObject) Returns whether the givenIChemObject
can be read or written.void
close()
Closes this IChemObjectIO's resources.Returns theIResourceFormat
class for this IO class.<T extends IChemObject>
Tread
(T object) reads the content from a XYZ input.void
setReader
(InputStream input) Sets the InputStream from which this ChemObjectReader should read the contents.void
Sets the Reader from which this ChemObjectReader should read the contents.Methods inherited from class org.openscience.cdk.io.DefaultChemObjectReader
fireFrameRead, handleError, handleError, handleError, handleError, setErrorHandler, setReaderMode
Methods inherited from class org.openscience.cdk.io.ChemObjectIO
addChemObjectIOListener, addSetting, addSettings, fireIOSettingQuestion, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.openscience.cdk.io.IChemObjectIO
addChemObjectIOListener, addSetting, addSettings, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListener
-
Constructor Details
-
XYZReader
Construct a new reader from a Reader type object.- Parameters:
input
- reader from which input is read
-
XYZReader
-
XYZReader
public XYZReader()
-
-
Method Details
-
getFormat
Description copied from interface:IChemObjectIO
Returns theIResourceFormat
class for this IO class. -
setReader
Description copied from interface:IChemObjectReader
Sets the Reader from which this ChemObjectReader should read the contents.- Throws:
CDKException
-
setReader
Description copied from interface:IChemObjectReader
Sets the InputStream from which this ChemObjectReader should read the contents.- Throws:
CDKException
-
accepts
Description copied from interface:IChemObjectIO
Returns whether the givenIChemObject
can be read or written.- Parameters:
classObject
-IChemObject
of which is tested if it can be handled.- Returns:
- true, if the
IChemObject
can be handled.
-
read
reads the content from a XYZ input. It can only return a IChemObject of type ChemFile- Parameters:
object
- class must be of type ChemFile- Returns:
- returns an object of that contains the content (or part) of the input content
- Throws:
CDKException
- it is thrown if the type of information is not available from the input- See Also:
-
close
Description copied from interface:IChemObjectIO
Closes this IChemObjectIO's resources.- Throws:
IOException
- when the wrapper IO class cannot be closed.
-