org.openscience.cdk.io
Class CDKSourceCodeWriter

java.lang.Object
  org.openscience.cdk.io.ChemObjectIO
      org.openscience.cdk.io.DefaultChemObjectWriter
          org.openscience.cdk.io.CDKSourceCodeWriter

All Implemented Interfaces:

Closeable, IChemObjectIO, IChemObjectWriter

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

Converts a Molecule into CDK source code that would build the same molecule. It's typical use is:

 StringWriter stringWriter = new StringWriter();
 ChemObjectWriter writer = new CDKSourceCodeWriter(stringWriter);
 writer.write((Molecule)molecule);
 writer.close();
 System.out.print(stringWriter.toString());
 

Author:

Egon Willighagen

Keywords:

file format, CDK source code

Created on:

2003-10-01

Belongs to CDK module:

io

Source code:

cdk-1.4.x

Constructor Summary

CDKSourceCodeWriter()

CDKSourceCodeWriter(OutputStream out)

CDKSourceCodeWriter(Writer out)
Constructs a new CDKSourceCodeWriter.

Method Summary

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.
int	getRequiredDataFeatures()
int	getSupportedDataFeatures()
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) Writes the content of "object" to output

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

addChemObjectIOListener, addSetting, addSettings, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListener

Methods inherited from class java.lang.Object

equals, 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 Detail

CDKSourceCodeWriter

public CDKSourceCodeWriter(Writer out)

Constructs a new CDKSourceCodeWriter.

Parameters:

out - The Writer to write to

CDKSourceCodeWriter

public CDKSourceCodeWriter(OutputStream out)

CDKSourceCodeWriter

public CDKSourceCodeWriter()

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

close

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

Flushes the output and closes this object.

Throws:

IOException

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 CDKException

Description copied from interface: IChemObjectWriter

Writes the content of "object" to output

Parameters:

object - the object of which the content is outputed

Throws:

CDKException - is thrown if the output does not support the data in the object

getSupportedDataFeatures

public int getSupportedDataFeatures()

getRequiredDataFeatures

public int getRequiredDataFeatures()