Package adams.doc.listing

Class AbstractFileBasedListingOutputWithEncoding

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.AbstractListingOutput

adams.doc.listing.AbstractFileBasedListingOutput

adams.doc.listing.AbstractFileBasedListingOutputWithEncoding

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, EncodingSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

HtmlOutput, MarkdownOutput

public abstract class AbstractFileBasedListingOutputWithEncoding
extends AbstractFileBasedListingOutput
implements EncodingSupporter

Ancestor for output schemes that support file encodings.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseCharset	m_Encoding	the encoding to use.

Fields inherited from class adams.doc.listing.AbstractFileBasedListingOutput

m_OutputFile

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
AbstractFileBasedListingOutputWithEncoding()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	encodingTipText()	Returns the tip text for this property.
BaseCharset	getEncoding()	Returns the encoding to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
void	setEncoding(BaseCharset value)	Sets the encoding to use.

Methods inherited from class adams.doc.listing.AbstractFileBasedListingOutput

check, getDefaultOutputFile, getOutputFile, outputFileTipText, setOutputFile

Methods inherited from class adams.doc.listing.AbstractListingOutput

doGenerate, generate, getModules

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Encoding

protected BaseCharset m_Encoding

the encoding to use.

Constructor Detail

AbstractFileBasedListingOutputWithEncoding

public AbstractFileBasedListingOutputWithEncoding()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFileBasedListingOutput

setEncoding

public void setEncoding(BaseCharset value)

Sets the encoding to use.

Specified by:

setEncoding in interface EncodingSupporter

Parameters:

value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

getEncoding

public BaseCharset getEncoding()

Returns the encoding to use.

Specified by:

getEncoding in interface EncodingSupporter

Returns:

the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

encodingTipText

public String encodingTipText()

Returns the tip text for this property.

Specified by:

encodingTipText in interface EncodingSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractFileBasedListingOutput

Returns:

null if no info available, otherwise short string