Package adams.gui.tools.previewbrowser.notes

Class PropertiesNotesWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.previewbrowser.notes.AbstractNotesWriter

adams.gui.tools.previewbrowser.notes.PropertiesNotesWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class PropertiesNotesWriter
extends AbstractNotesWriter

Writes the notes in Java properties format.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected String	doWrite(Map<String,String> notes, PlaceholderFile file)	Writes the notes to the specified file.
AbstractNotesReader	getCorrespondingReader()	Returns the corresponding reader.
protected String	getDefaultFileName()	Returns the default file name for the notes file.
String	getDefaultFormatExtension()	Returns the default extension of the format.
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.

Methods inherited from class adams.gui.tools.previewbrowser.notes.AbstractNotesWriter

check, getSortedFiles, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Constructor Detail

PropertiesNotesWriter

public PropertiesNotesWriter()

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

getFormatDescription

public String getFormatDescription()

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

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Returns:

the extension (without the dot!)

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

Returns:

the default extension (without the dot!)

getDefaultFileName

protected String getDefaultFileName()

Returns the default file name for the notes file.

Specified by:

getDefaultFileName in class AbstractNotesWriter

Returns:

the name, no path

getCorrespondingReader

public AbstractNotesReader getCorrespondingReader()

Returns the corresponding reader.

Specified by:

getCorrespondingReader in class AbstractNotesWriter

Returns:

the reader, null if not available

doWrite

protected String doWrite(Map<String,String> notes,
                         PlaceholderFile file)

Writes the notes to the specified file.

Specified by:

doWrite in class AbstractNotesWriter

Parameters:

notes - the notes to write

file - the file to store the notes in

Returns:

null if successfully written, otherwise error message