Package net.sf.freecol.common.option

Class TextOption

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColSpecObject

net.sf.freecol.common.option.AbstractOption<java.lang.String>

net.sf.freecol.common.option.TextOption

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<FreeColObject>, ObjectWithId, Option<java.lang.String>

public class TextOption
extends AbstractOption<java.lang.String>

Represents an option that can be an arbitrary string.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	CHOICE_TAG
private static java.util.logging.Logger	logger
static java.lang.String	TAG
private java.lang.String	value	The value of this option.

Fields inherited from class net.sf.freecol.common.option.AbstractOption

ACTION_TAG, DEFAULT_VALUE_TAG, isDefined

Fields inherited from class net.sf.freecol.common.model.FreeColObject

ARRAY_SIZE_TAG, DEFAULT_CLASS_INDEX, fcoComparator, ID_ATTRIBUTE_TAG, PARTIAL_ATTRIBUTE_TAG, VALUE_TAG

Constructor Summary

Constructors

Constructor	Description
TextOption(java.lang.String id, Specification specification)	Creates a new TextOption.
TextOption(Specification specification)	Creates a new TextOption.

Method Summary

Modifier and Type	Method	Description
TextOption	cloneOption()	Clone this option.
java.lang.String	getValue()	Gets the value of this option.
java.lang.String	getXMLTagName()	Get the serialization tag for this object.
void	setValue(java.lang.String value)	Sets the value of this option.
protected void	setValue(java.lang.String valueString, java.lang.String defaultValueString)	Sets the value of this option from the given string representation.
java.lang.String	toString()
protected void	writeAttributes(FreeColXMLWriter xw)	Write the attributes of this object to a stream.

Methods inherited from class net.sf.freecol.common.option.AbstractOption

generateChoices, getEnabledBy, getGroup, isNullValueOK, readAttributes, readOption, setGroup, setValues

Methods inherited from class net.sf.freecol.common.model.FreeColSpecObject

copyIn, getSpecification, setSpecification

Methods inherited from class net.sf.freecol.common.model.FreeColObject

addAbility, addFeatures, addModifier, addPropertyChangeListener, addPropertyChangeListener, apply, apply, applyModifiers, applyModifiers, arrayKey, compareIds, compareTo, containsAbilityKey, containsModifierKey, copy, copy, copy, copy, copyInCast, dumpObject, equals, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAbilities, getAbilities, getAbilities, getAbilities, getClassIndex, getDefenceModifiers, getDisplayObject, getFeatureContainer, getFreeColObjectClass, getFreeColObjectClassByName, getGame, getId, getIdNumber, getIdType, getIdTypeByName, getModifiers, getModifiers, getModifiers, getModifiers, getObjectClassIndex, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getSortedAbilities, getSortedModifiers, getSuffix, getSuffix, hasAbility, hasAbility, hasAbility, hashCode, hasListeners, hasModifier, hasModifier, hasModifier, idEquals, invokeMethod, logFreeColObjects, readChild, readChildren, readFromXML, readFromXMLPartial, removeAbilities, removeAbility, removeFeatures, removeModifier, removeModifiers, removePropertyChangeListener, removePropertyChangeListener, save, save, save, save, serialize, serialize, serialize, serialize, setGame, setId, toXML, toXML, toXMLPartial, toXMLPartial, writeChildren

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.freecol.common.ObjectWithId

getId

Methods inherited from interface net.sf.freecol.common.option.Option

readFromXML, toXML

Field Detail

logger

private static final java.util.logging.Logger logger

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

value

private java.lang.String value

The value of this option.

CHOICE_TAG

private static final java.lang.String CHOICE_TAG

See Also:

Constant Field Values

Constructor Detail

TextOption

public TextOption(Specification specification)

Creates a new TextOption.

Parameters:

specification - The Specification to refer to.

TextOption

public TextOption(java.lang.String id,
                  Specification specification)

Creates a new TextOption.

Parameters:

id - The object identifier.

specification - The Specification to refer to.

Method Detail

cloneOption

public TextOption cloneOption()

Clone this option.

Specified by:

cloneOption in interface Option<java.lang.String>

Specified by:

cloneOption in class AbstractOption<java.lang.String>

Returns:

A clone of this option.

getValue

public java.lang.String getValue()

Gets the value of this option.

Specified by:

getValue in interface Option<java.lang.String>

Specified by:

getValue in class AbstractOption<java.lang.String>

Returns:

The value of this Option.

setValue

public void setValue(java.lang.String value)

Sets the value of this option.

Specified by:

setValue in interface Option<java.lang.String>

Specified by:

setValue in class AbstractOption<java.lang.String>

Parameters:

value - The new value of this Option.

setValue

protected void setValue(java.lang.String valueString,
                        java.lang.String defaultValueString)

Sets the value of this option from the given string representation. Both parameters must not be null at the same time. This method does nothing. Override it if the option has a suitable string representation.

Overrides:

setValue in class AbstractOption<java.lang.String>

Parameters:

valueString - The string representation of the value of this Option.

defaultValueString - The string representation of the default value of this Option.

writeAttributes

protected void writeAttributes(FreeColXMLWriter xw)
                        throws javax.xml.stream.XMLStreamException

Write the attributes of this object to a stream. To be overridden if required by any object that has attributes and uses the toXML(FreeColXMLWriter, String) call.

Overrides:

writeAttributes in class AbstractOption<java.lang.String>

Parameters:

xw - The FreeColXMLWriter to write to.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

getXMLTagName

public java.lang.String getXMLTagName()

Get the serialization tag for this object.

Specified by:

getXMLTagName in class FreeColObject

Returns:

The tag.

toString

public java.lang.String toString()

Specified by:

toString in interface Option<java.lang.String>

Overrides:

toString in class FreeColObject