Package adams.core.option

Class StringOption

java.lang.Object

adams.core.option.AbstractOption

adams.core.option.AbstractArgumentOption

adams.core.option.StringOption

All Implemented Interfaces:

CleanUpHandler, VariableChangeListener, Serializable

public class StringOption
extends AbstractArgumentOption

Handles options with string arguments.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractArgumentOption

m_BaseClass, m_Multiple, m_Variable, m_VariableModified, m_VariableReferencesObject

Fields inherited from class adams.core.option.AbstractOption

m_Commandline, m_Debug, m_DefaultValue, m_MinUserMode, m_OutputDefaultValue, m_Owner, m_Property, TOOLTIP_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringOption(OptionManager owner, String commandline, String property, Object defValue, boolean outputDefValue, UserMode minUserMode)	Initializes the option.
protected	StringOption(OptionManager owner, String commandline, String property, Object defValue, UserMode minUserMode)	Initializes the option.

Method Summary

Modifier and Type	Method	Description
protected boolean	compareValues(Object value, Object defValue)	Compares the two values.
protected boolean	isParseable(String s)	Allows additional checks whether to include that particular string represents a valid option, i.e., is parseable.
String	toString(Object obj)	Returns a string representation of the specified object.
String	valueOf(String s)	Turns the string into the appropriate object.

Methods inherited from class adams.core.option.AbstractArgumentOption

cleanUp, getBaseClass, getVariable, getVariableName, hasBaseClass, isDefaultValue, isDefaultValue, isMultiple, isVariableAttached, isVariableModified, isVariableReferencingObject, setVariable, toArray, toString, updateVariable, updateVariable, updateVariable, variableChanged

Methods inherited from class adams.core.option.AbstractOption

getCommandline, getCurrentValue, getDebug, getDefaultValue, getDescriptor, getMinUserMode, getOptionHandler, getOutputDefaultValue, getOwner, getProperty, getReadMethod, getToolTipMethod, getWriteMethod, setCurrentValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringOption

protected StringOption(OptionManager owner,
                       String commandline,
                       String property,
                       Object defValue,
                       UserMode minUserMode)

Initializes the option. Will always output the default value.

Parameters:

owner - the owner of this option

commandline - the commandline string to identify the option (no leading dash)

property - the name of bean property

defValue - the default value, if null then the owner's current state is used

minUserMode - the minimum user mode before showing this option

StringOption

protected StringOption(OptionManager owner,
                       String commandline,
                       String property,
                       Object defValue,
                       boolean outputDefValue,
                       UserMode minUserMode)

Initializes the option.

Parameters:

owner - the owner of this option

commandline - the commandline string to identify the option (no leading dash)

property - the name of bean property

defValue - the default value, if null then the owner's current state is used

outputDefValue - whether to output the default value or not

minUserMode - the minimum user mode before showing this option

Method Detail

compareValues

protected boolean compareValues(Object value,
                                Object defValue)

Compares the two values.

Specified by:

compareValues in class AbstractArgumentOption

Parameters:

value - the value to compare against the default value

defValue - the default value to compare against

Returns:

true if both are equal

valueOf

public String valueOf(String s)
               throws Exception

Turns the string into the appropriate object.

Specified by:

valueOf in class AbstractArgumentOption

Parameters:

s - the string to parse

Returns:

the generated object

Throws:

Exception - if parsing of string fails

isParseable

protected boolean isParseable(String s)

Allows additional checks whether to include that particular string represents a valid option, i.e., is parseable.

Any string is valid, even empty ones.

Parameters:

s - the option string to test.

Returns:

always true

toString

public String toString(Object obj)

Returns a string representation of the specified object.

Specified by:

toString in class AbstractArgumentOption

Parameters:

obj - the object to turn into a string

Returns:

the string representation