Package adams.data.conversion

Class LongToString

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionToString

adams.data.conversion.LongToString

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, ConversionToString, Serializable

public class LongToString
extends AbstractConversionToString

Turns a Long into a String.
Can be optionally formatted using a byte format string.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-use-format <boolean> (property: useFormat)
    If enabled, the byte format string will be used.
    default: false
 

-format <adams.core.ByteFormatString> (property: format)
    The byte format string to use.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteFormat	m_ByteFormat	the byteformat instance in use.
protected ByteFormatString	m_Format	the byte format string to use.
protected boolean	m_UseFormat	whether to use byte format string.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

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

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
String	formatTipText()	Returns the tip text for this property.
ByteFormatString	getFormat()	Returns the byte format string.
boolean	getUseFormat()	Returns whether to use the format string.
String	globalInfo()	Returns a string describing the object.
void	setFormat(ByteFormatString value)	Sets the byte format string.
void	setUseFormat(boolean value)	Sets whether to use the format string.
String	useFormatTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversionToString

generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Methods inherited from interface adams.core.Stoppable

stopExecution

Field Detail

m_UseFormat

protected boolean m_UseFormat

whether to use byte format string.

m_Format

protected ByteFormatString m_Format

the byte format string to use.

m_ByteFormat

protected transient ByteFormat m_ByteFormat

the byteformat instance in use.

Constructor Detail

LongToString

public LongToString()

Method Detail

globalInfo

public String globalInfo()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setUseFormat

public void setUseFormat(boolean value)

Sets whether to use the format string.

Parameters:

value - true if to use format

getUseFormat

public boolean getUseFormat()

Returns whether to use the format string.

Returns:

true if to use format

useFormatTipText

public String useFormatTipText()

Returns the tip text for this property.

Returns:

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

setFormat

public void setFormat(ByteFormatString value)

Sets the byte format string.

Parameters:

value - the format

getFormat

public ByteFormatString getFormat()

Returns the byte format string.

Returns:

the format

formatTipText

public String formatTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion