net.sf.freecol.common.model
Class StanceTradeItem

java.lang.Object
  net.sf.freecol.common.model.FreeColObject
      net.sf.freecol.common.model.TradeItem
          net.sf.freecol.common.model.StanceTradeItem

public class StanceTradeItem
extends TradeItem

Field Summary

private Player.Stance

stance The stance between source and destination.

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

game

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

StanceTradeItem(Game game, Player source, Player destination, Player.Stance stance)
Creates a new StanceTradeItem instance.

StanceTradeItem(Game game, javax.xml.stream.XMLStreamReader in)
Creates a new StanceTradeItem instance.

Method Summary

Player.Stance	getStance() Get the stance to trade.
static java.lang.String	getXMLElementTagName() Gets the tag name of the root element representing this object.
boolean	isUnique() Returns whether this TradeItem must be unique.
boolean	isValid() Returns whether this TradeItem is valid.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Initialize this object from an XML-representation of this object.
void	setStance(Player.Stance stance) Set the stance to trade.
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.

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

getColony, getDestination, getGold, getGoods, getSource, getUnit, setColony, setDestination, setGold, setGoods, setSource, setUnit

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, hasAbility, hasAttribute, hasListeners, readAttributes, readAttributes, readChild, readChild, readChildren, readChildren, readFromArrayElement, readFromArrayElement, readFromListElement, readFromXML, readFromXMLElement, readFromXMLImpl, readFromXMLPartialImpl, removePropertyChangeListener, removePropertyChangeListener, save, save, setId, setSpecification, toXML, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, toXMLPartialImpl, writeAttribute, writeChildren

Methods inherited from class java.lang.Object

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

Field Detail

stance

private Player.Stance stance

The stance between source and destination.

Constructor Detail

StanceTradeItem

public StanceTradeItem(Game game,
                       Player source,
                       Player destination,
                       Player.Stance stance)

Creates a new StanceTradeItem instance.

Parameters:

game - a Game value

source - a Player value

destination - a Player value

stance - an Stance value

StanceTradeItem

public StanceTradeItem(Game game,
                       javax.xml.stream.XMLStreamReader in)
                throws javax.xml.stream.XMLStreamException

Creates a new StanceTradeItem instance.

Parameters:

game - a Game value

in - a XMLStreamReader value

Throws:

javax.xml.stream.XMLStreamException

Method Detail

isValid

public boolean isValid()

Returns whether this TradeItem is valid.

Specified by:

isValid in class TradeItem

Returns:

a boolean value

isUnique

public boolean isUnique()

Returns whether this TradeItem must be unique. This is true for the StanceTradeItem and the GoldTradeItem, and false for all others.

Specified by:

isUnique in class TradeItem

Returns:

a boolean value

getStance

public Player.Stance getStance()

Get the stance to trade.

Overrides:

getStance in class TradeItem

Returns:

The stance to trade.

setStance

public void setStance(Player.Stance stance)

Set the stance to trade.

Overrides:

setStance in class TradeItem

Parameters:

stance - The new Stance to trade.

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.

Specified by:

toXMLImpl in class FreeColObject

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. To be overridden by any object that uses the toXML(XMLStreamWriter, String) call.

Overrides:

writeAttributes in class TradeItem

Parameters:

out - The target stream.

Throws:

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

readFromXMLImpl

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

Initialize this object from an XML-representation of this object.

Overrides:

readFromXMLImpl in class TradeItem

Parameters:

in - The input stream with the XML.

Throws:

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

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

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

Returns:

"stanceTradeItem".