Package adams.flow.source.valuedefinition

Class EnumValueDefinition

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.valuedefinition.AbstractValueDefinition

adams.flow.source.valuedefinition.EnumValueDefinition

All Implemented Interfaces:

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

public class EnumValueDefinition
extends AbstractValueDefinition

Specialized definition for enums.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

EnterManyValues, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseClassname	m_EnumClass	the enum to select.

Fields inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

m_Display, m_Enabled, m_FlowContext, m_Help, m_Name

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

Method Summary

Modifier and Type	Method	Description
boolean	addToPanel(PropertiesParameterPanel panel)	Adds the value to the panel.
void	defineOptions()	Adds options to the internal list of options.
String	enumClassTipText()	Returns the tip text for this property.
String	getDefaultValueAsString()	Returns the default of the value as string.
BaseClassname	getEnumClass()	Returns the enum class to select.
protected String[]	getEnumValues()	Returns the available enum values.
PropertiesParameterPanel.PropertyType	getType()	Returns the type of the value.
String	globalInfo()	Returns a string describing the object.
String	headlessInteraction()	Prompts the user to enter a value in headless mode and returns it.
protected boolean	requiresFlowContext()	Returns whether flow context is required.
void	setDefaultValueAsString(String value)	Sets the default value as string.
void	setEnumClass(BaseClassname value)	Sets the enum class to select.

Methods inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

canBeRestored, check, displayTipText, enabledTipText, getDisplay, getEnabled, getFlowContext, getHelp, getName, helpTipText, nameTipText, setDisplay, setEnabled, setFlowContext, setHelp, setName

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_EnumClass

protected BaseClassname m_EnumClass

the enum to select.

Constructor Detail

EnumValueDefinition

public EnumValueDefinition()

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 AbstractValueDefinition

setEnumClass

public void setEnumClass(BaseClassname value)

Sets the enum class to select.

Parameters:

value - the class

getEnumClass

public BaseClassname getEnumClass()

Returns the enum class to select.

Returns:

the class

enumClassTipText

public String enumClassTipText()

Returns the tip text for this property.

Returns:

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

getType

public PropertiesParameterPanel.PropertyType getType()

Returns the type of the value.

Specified by:

getType in class AbstractValueDefinition

Returns:

the type

setDefaultValueAsString

public void setDefaultValueAsString(String value)

Sets the default value as string.

Specified by:

setDefaultValueAsString in class AbstractValueDefinition

Parameters:

value - the default value

getDefaultValueAsString

public String getDefaultValueAsString()

Returns the default of the value as string.

Specified by:

getDefaultValueAsString in class AbstractValueDefinition

Returns:

the default

requiresFlowContext

protected boolean requiresFlowContext()

Returns whether flow context is required.

Specified by:

requiresFlowContext in class AbstractValueDefinition

Returns:

true if required

getEnumValues

protected String[] getEnumValues()

Returns the available enum values.

Returns:

the values

addToPanel

public boolean addToPanel(PropertiesParameterPanel panel)

Adds the value to the panel.

Specified by:

addToPanel in class AbstractValueDefinition

Parameters:

panel - the panel to add to

Returns:

true if successfully added

headlessInteraction

public String headlessInteraction()

Prompts the user to enter a value in headless mode and returns it.

Specified by:

headlessInteraction in class AbstractValueDefinition

Returns:

the entered value, null if canceled