org.openscience.cdk.io

Class CrystClustWriter

java.lang.Object

org.openscience.cdk.io.DefaultChemObjectWriter

org.openscience.cdk.io.CrystClustWriter

All Implemented Interfaces:

IChemObjectIO, IChemObjectWriter

@TestClass(value="org.openscience.cdk.io.CrystClustWriterTest")
public class CrystClustWriter
extends DefaultChemObjectWriter

Rather stupid file format used for storing crystal information.

Author:

Egon Willighagen

Created on:

2004-01-01

Constructor Summary

Constructors

Constructor and Description
CrystClustWriter()
CrystClustWriter(OutputStream output)
CrystClustWriter(Writer out) Constructs a new CrystClustWriter class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(Class classObject) Returns whether the given IChemObject can be read or written.
void	close() Flushes the output and closes this object
IResourceFormat	getFormat() Returns the IResourceFormat class for this IO class.
void	setWriter(OutputStream output) Sets the OutputStream from which this ChemObjectWriter should write the contents.
void	setWriter(Writer out) Sets the Writer from which this ChemObjectWriter should write the contents.
void	write(IChemObject object) Serializes the IChemObject to CrystClust format and redirects it to the output Writer.

Methods inherited from class org.openscience.cdk.io.DefaultChemObjectWriter

addChemObjectIOListener, getIOSettings, removeChemObjectIOListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrystClustWriter

public CrystClustWriter(Writer out)

Constructs a new CrystClustWriter class. Output will be stored in the Writer class given as parameter.

Parameters:

out - Writer to redirect the output to.

CrystClustWriter

public CrystClustWriter(OutputStream output)

CrystClustWriter

public CrystClustWriter()

Method Detail

getFormat

@TestMethod(value="testGetFormat")
public IResourceFormat getFormat()

Description copied from interface: IChemObjectIO

Returns the IResourceFormat class for this IO class.

setWriter

public void setWriter(Writer out)
               throws CDKException

Description copied from interface: IChemObjectWriter

Sets the Writer from which this ChemObjectWriter should write the contents.

Throws:

CDKException

setWriter

public void setWriter(OutputStream output)
               throws CDKException

Description copied from interface: IChemObjectWriter

Sets the OutputStream from which this ChemObjectWriter should write the contents.

Throws:

CDKException

accepts

@TestMethod(value="testAccepts")
public boolean accepts(Class classObject)

Description copied from interface: IChemObjectIO

Returns whether the given IChemObject 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.

write

public void write(IChemObject object)
           throws UnsupportedChemObjectException

Serializes the IChemObject to CrystClust format and redirects it to the output Writer.

Parameters:

object - A Molecule of MoleculeSet object

Throws:

UnsupportedChemObjectException

close

@TestMethod(value="testClose")
public void close()
           throws IOException

Flushes the output and closes this object

Throws:

IOException