Package adams.data.conversion

Class DataContainerToString.DummyWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractDataContainerWriter<DataContainerToString.DummyContainer>

adams.data.conversion.DataContainerToString.DummyWriter

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<DataContainerWriter>, SizeOfHandler, DataContainerWriter<DataContainerToString.DummyContainer>, StreamableDataContainerWriter<DataContainerToString.DummyContainer>, StreamableTextBasedDataContainerWriter<DataContainerToString.DummyContainer>, Serializable, Comparable

Enclosing class:

DataContainerToString

public static class DataContainerToString.DummyWriter
extends AbstractDataContainerWriter<DataContainerToString.DummyContainer>
implements StreamableTextBasedDataContainerWriter<DataContainerToString.DummyContainer>

Dummy writer.

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

m_Output, m_OutputIsFile

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
DummyWriter()

Method Summary

Modifier and Type	Method	Description
boolean	canWriteMultiple()	Returns whether writing of multiple containers is supported.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
boolean	write(OutputStream stream, DataContainerToString.DummyContainer data)	Performs checks and writes the data to the stream.
boolean	write(OutputStream stream, List<DataContainerToString.DummyContainer> data)	Performs checks and writes the data to the stream.
protected boolean	writeData(List<DataContainerToString.DummyContainer> data)	Performs the actual writing.

Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

checkData, cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getOutput, getWriters, isOutputFile, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.data.io.output.DataContainerWriter

getOutput, isOutputFile, outputTipText, setOutput, write, write

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Constructor Detail

DummyWriter

public DummyWriter()

Method Detail

globalInfo

public String globalInfo()

Description copied from class: AbstractOptionHandler

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Description copied from class: AbstractDataContainerWriter

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractDataContainerWriter<DataContainerToString.DummyContainer>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Description copied from class: AbstractDataContainerWriter

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractDataContainerWriter<DataContainerToString.DummyContainer>

Returns:

the extension(s) (without the dot!)

canWriteMultiple

public boolean canWriteMultiple()

Description copied from class: AbstractDataContainerWriter

Returns whether writing of multiple containers is supported.

Specified by:

canWriteMultiple in interface DataContainerWriter<DataContainerToString.DummyContainer>

Specified by:

canWriteMultiple in class AbstractDataContainerWriter<DataContainerToString.DummyContainer>

Returns:

true if multiple containers are supported

writeData

protected boolean writeData(List<DataContainerToString.DummyContainer> data)

Description copied from class: AbstractDataContainerWriter

Performs the actual writing.

Specified by:

writeData in class AbstractDataContainerWriter<DataContainerToString.DummyContainer>

Parameters:

data - the data to write

Returns:

true if successfully written

write

public boolean write(OutputStream stream,
                     DataContainerToString.DummyContainer data)

Description copied from interface: StreamableDataContainerWriter

Performs checks and writes the data to the stream.

Specified by:

write in interface StreamableDataContainerWriter<DataContainerToString.DummyContainer>

Parameters:

stream - the stream to write to

data - the data to write

Returns:

true if successfully written

See Also:

StreamableDataContainerWriter.write(OutputStream stream, List)

write

public boolean write(OutputStream stream,
                     List<DataContainerToString.DummyContainer> data)

Description copied from interface: StreamableDataContainerWriter

Performs checks and writes the data to the stream.

Specified by:

write in interface StreamableDataContainerWriter<DataContainerToString.DummyContainer>

Parameters:

stream - the stream to write to

data - the data to write

Returns:

true if successfully written