net.sf.freecol.common.option
Class IntegerOption

java.lang.Object
  extended by net.sf.freecol.common.model.FreeColObject
      extended by net.sf.freecol.common.option.AbstractOption
          extended by net.sf.freecol.common.option.IntegerOption
All Implemented Interfaces:
Option
Direct Known Subclasses:
PercentageOption

public class IntegerOption
extends AbstractOption

Represents an option where the valid choice is an integer.


Field Summary
 
Fields inherited from class net.sf.freecol.common.option.AbstractOption
NO_ID
 
Fields inherited from class net.sf.freecol.common.model.FreeColObject
ID_ATTRIBUTE_TAG
 
Constructor Summary
IntegerOption(java.lang.String id, OptionGroup optionGroup, int minimumValue, int maximumValue, int defaultValue)
          Deprecated.  
IntegerOption(javax.xml.stream.XMLStreamReader in)
          Creates a new IntegerOption.
 
Method Summary
 int getMaximumValue()
          Returns the maximum allowed value.
 int getMinimumValue()
          Returns the minimum allowed value.
 int getValue()
          Gets the current value of this IntegerOption.
static java.lang.String getXMLElementTagName()
          Gets the tag name of the root element representing this object.
 void setValue(int value)
          Sets the value of this IntegerOption.
 
Methods inherited from class net.sf.freecol.common.option.AbstractOption
getGroup, getName, getShortDescription, isPreviewEnabled, setGroup, setPreviewEnabled, toString
 
Methods inherited from class net.sf.freecol.common.model.FreeColObject
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAttribute, getAttribute, getAttribute, getAttribute, getId, getPropertyChangeListeners, getPropertyChangeListeners, hasAbility, hasAttribute, hasListeners, readFromXML, readFromXMLElement, removePropertyChangeListener, removePropertyChangeListener, toXML, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, writeAttribute, writeFreeColGameObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.sf.freecol.common.option.Option
addPropertyChangeListener, getId, readFromXML, readFromXMLElement, removePropertyChangeListener, toXML, toXMLElement
 

Constructor Detail

IntegerOption

public IntegerOption(java.lang.String id,
                     OptionGroup optionGroup,
                     int minimumValue,
                     int maximumValue,
                     int defaultValue)
Deprecated. 

Creates a new IntegerOption.

Parameters:
id - The identifier for this option. This is used when the object should be found in an OptionGroup.
optionGroup - The OptionGroup this option belongs to.
minimumValue - The minimum allowed value.
maximumValue - The maximum allowed value.
defaultValue - The default value of this option.

IntegerOption

public IntegerOption(javax.xml.stream.XMLStreamReader in)
              throws javax.xml.stream.XMLStreamException
Creates a new IntegerOption.

Parameters:
in - The XMLStreamReader containing the data.
Throws:
javax.xml.stream.XMLStreamException
Method Detail

getMinimumValue

public int getMinimumValue()
Returns the minimum allowed value.

Returns:
The minimum value allowed by this option.

getMaximumValue

public int getMaximumValue()
Returns the maximum allowed value.

Returns:
The maximum value allowed by this option.

getValue

public int getValue()
Gets the current value of this IntegerOption.

Returns:
The value.

setValue

public void setValue(int value)
Sets the value of this IntegerOption.

Parameters:
value - The value to be set.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()
Gets the tag name of the root element representing this object.

Returns:
"integerOption".