Package adams.flow.source.newlist

Class FixedList

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.newlist.AbstractListGenerator

adams.flow.source.newlist.FixedList

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractListGenerator>, SizeOfHandler, Serializable

public class FixedList
extends AbstractListGenerator

Simply outputs the supplied list elements.

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

-element <adams.core.base.BaseString> [-element ...] (property: elements)
    The list elements to output.
    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 BaseString[]	m_Elements	the list elements to output.

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

Method Summary

Modifier and Type	Method	Description
protected void	check()	Hook method for checks.
void	defineOptions()	Adds options to the internal list of options.
protected List<String>	doGenerate()	Generates the actual list.
String	elementsTipText()	Returns the tip text for this property.
BaseString[]	getElements()	Returns the list elements to output.
String	globalInfo()	Returns a string describing the object.
void	setElements(BaseString[] value)	Sets the list elements to output.

Methods inherited from class adams.flow.source.newlist.AbstractListGenerator

generate, getQuickInfo, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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

Field Detail

m_Elements

protected BaseString[] m_Elements

the list elements to output.

Constructor Detail

FixedList

public FixedList()

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

setElements

public void setElements(BaseString[] value)

Sets the list elements to output.

Parameters:

value - the elements

getElements

public BaseString[] getElements()

Returns the list elements to output.

Returns:

the elements

elementsTipText

public String elementsTipText()

Returns the tip text for this property.

Returns:

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

check

protected void check()
              throws Exception

Hook method for checks.

Ensures that list elements have been supplied.

Overrides:

check in class AbstractListGenerator

Throws:

Exception - if check fails

doGenerate

protected List<String> doGenerate()
                           throws Exception

Generates the actual list.

Specified by:

doGenerate in class AbstractListGenerator

Returns:

the list of elements

Throws:

Exception - if generation fails