Package adams.data.conversion

Class FileToString

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.FileToString

All Implemented Interfaces:

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

public class FileToString
extends AbstractConversionToString
implements ForwardSlashSupporter

Turns a File object into a String.

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

-absolute <boolean> (property: absolutePath)
    If enabled, absolute paths are generated.
    default: false
 

-use-forward-slashes <boolean> (property: useForwardSlashes)
    If enabled, forward slashes are used in the output (but the '\\' prefix 
    of UNC paths is not converted).
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AbsolutePath	whether to output an absolute path.
protected boolean	m_UseForwardSlashes	whether to output forward slashes.

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

Method Summary

Modifier and Type	Method	Description
String	absolutePathTipText()	Returns the tip text for this property.
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.
boolean	getAbsolutePath()	Returns whether to create absolute paths.
boolean	getUseForwardSlashes()	Returns whether to use forward slashes in the output.
String	globalInfo()	Returns a string describing the object.
void	setAbsolutePath(boolean value)	Sets whether to create absolute paths.
void	setUseForwardSlashes(boolean value)	Sets whether to use forward slashes in the output.
String	useForwardSlashesTipText()	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_AbsolutePath

protected boolean m_AbsolutePath

whether to output an absolute path.

m_UseForwardSlashes

protected boolean m_UseForwardSlashes

whether to output forward slashes.

Constructor Detail

FileToString

public FileToString()

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

setAbsolutePath

public void setAbsolutePath(boolean value)

Sets whether to create absolute paths.

Parameters:

value - if true then absolute paths are created

getAbsolutePath

public boolean getAbsolutePath()

Returns whether to create absolute paths.

Returns:

true if absolute paths are created

absolutePathTipText

public String absolutePathTipText()

Returns the tip text for this property.

Returns:

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

setUseForwardSlashes

public void setUseForwardSlashes(boolean value)

Sets whether to use forward slashes in the output.

Specified by:

setUseForwardSlashes in interface ForwardSlashSupporter

Parameters:

value - if true then use forward slashes

getUseForwardSlashes

public boolean getUseForwardSlashes()

Returns whether to use forward slashes in the output.

Specified by:

getUseForwardSlashes in interface ForwardSlashSupporter

Returns:

true if forward slashes are used

useForwardSlashesTipText

public String useForwardSlashesTipText()

Returns the tip text for this property.

Specified by:

useForwardSlashesTipText in interface ForwardSlashSupporter

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