net.sf.freecol.common.model
Class Event

java.lang.Object
  net.sf.freecol.common.model.FreeColObject
      net.sf.freecol.common.model.FreeColGameObjectType
          net.sf.freecol.common.model.Event

public class Event
extends FreeColGameObjectType

Field Summary

private java.util.Map<java.lang.String,Limit>	limits Describe limits here.
private int	scoreValue The score value of this event.
private java.lang.String	value A restriction on the scope of the event.

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

ARRAY_SIZE, ID_ATTRIBUTE, ID_ATTRIBUTE_TAG, INFINITY, logger, NO_ID, PARTIAL_ATTRIBUTE, UNDEFINED, VALUE_TAG

Constructor Summary

Event(java.lang.String id, Specification specification)

Method Summary

Limit	getLimit(java.lang.String id) Return the Limit with the given id.
java.util.Collection<Limit>	getLimits() Get the Limits value.
int	getScoreValue() Get the ScoreValue value.
java.lang.String	getValue() Get the Value value.
static java.lang.String	getXMLElementTagName() Returns the tag name of the root element representing this object.
protected void	readAttributes(javax.xml.stream.XMLStreamReader in) Reads the attributes of this object from an XML stream.
protected void	readChild(javax.xml.stream.XMLStreamReader in) Reads a child object.
void	setScoreValue(int newScoreValue) Set the ScoreValue value.
void	setValue(java.lang.String newValue) Set the Value value.
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) This method writes an XML-representation of this object to the given stream.
protected void	writeAttributes(javax.xml.stream.XMLStreamWriter out) Write the attributes of this object to a stream.
protected void	writeChildren(javax.xml.stream.XMLStreamWriter out) Write the children of this object to a stream.

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

addAbility, addModifier, applyDifficultyLevel, getDescriptionKey, getFeatureContainer, getIndex, getModifierIndex, getModifierIndex, getModifierSet, getNameKey, hasAbility, hasAbility, isAbstractType, readChildren, setAbstractType, setFeatureContainer, setIndex, setModifierIndex, toString, toXMLImpl

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

addPropertyChangeListener, addPropertyChangeListener, dumpObject, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getId, getPropertyChangeListeners, getPropertyChangeListeners, getSpecification, hasAttribute, hasListeners, readAttributes, readChild, readChildren, readFromArrayElement, readFromArrayElement, readFromListElement, readFromXML, readFromXMLElement, readFromXMLImpl, readFromXMLImpl, readFromXMLPartialImpl, removePropertyChangeListener, removePropertyChangeListener, save, save, setId, setSpecification, toXML, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, toXMLPartialImpl, writeAttribute

Methods inherited from class java.lang.Object

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

Field Detail

value

private java.lang.String value

A restriction on the scope of the event.

scoreValue

private int scoreValue

The score value of this event.

limits

private java.util.Map<java.lang.String,Limit> limits

Describe limits here.

Constructor Detail

Event

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

Method Detail

getValue

public final java.lang.String getValue()

Get the Value value.

Returns:

a String value

setValue

public final void setValue(java.lang.String newValue)

Set the Value value.

Parameters:

newValue - The new Value value.

getLimits

public final java.util.Collection<Limit> getLimits()

Get the Limits value.

Returns:

a List value

getLimit

public final Limit getLimit(java.lang.String id)

Return the Limit with the given id.

Parameters:

id - a String value

Returns:

a Limit value

getScoreValue

public final int getScoreValue()

Get the ScoreValue value.

Returns:

an int value

setScoreValue

public final void setScoreValue(int newScoreValue)

Set the ScoreValue value.

Parameters:

newScoreValue - The new ScoreValue value.

toXMLImpl

protected void toXMLImpl(javax.xml.stream.XMLStreamWriter out)
                  throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object to the given stream.

Overrides:

toXMLImpl in class FreeColGameObjectType

Parameters:

out - The target stream.

Throws:

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

writeAttributes

protected void writeAttributes(javax.xml.stream.XMLStreamWriter out)
                        throws javax.xml.stream.XMLStreamException

Write the attributes of this object to a stream.

Overrides:

writeAttributes in class FreeColObject

Parameters:

out - The target stream.

Throws:

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

writeChildren

protected void writeChildren(javax.xml.stream.XMLStreamWriter out)
                      throws javax.xml.stream.XMLStreamException

Write the children of this object to a stream.

Overrides:

writeChildren in class FreeColGameObjectType

Parameters:

out - The target stream.

Throws:

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

readAttributes

protected void readAttributes(javax.xml.stream.XMLStreamReader in)
                       throws javax.xml.stream.XMLStreamException

Reads the attributes of this object from an XML stream.

Overrides:

readAttributes in class FreeColGameObjectType

Parameters:

in - The XML input stream.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

readChild

protected void readChild(javax.xml.stream.XMLStreamReader in)
                  throws javax.xml.stream.XMLStreamException

Reads a child object.

Overrides:

readChild in class FreeColGameObjectType

Parameters:

in - The XML stream to read.

Throws:

javax.xml.stream.XMLStreamException - if an error occurs

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

Returns the tag name of the root element representing this object.

Returns:

"event".