|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.model.FreeColObject
net.sf.freecol.common.model.TradeItem
net.sf.freecol.common.model.ColonyTradeItem
public class ColonyTradeItem
Field Summary |
---|
Fields inherited from class net.sf.freecol.common.model.FreeColObject |
---|
ID_ATTRIBUTE_TAG |
Constructor Summary | |
---|---|
ColonyTradeItem(Game game,
Player source,
Player destination,
Colony colony)
Creates a new ColonyTradeItem instance. |
|
ColonyTradeItem(Game game,
javax.xml.stream.XMLStreamReader in)
Creates a new ColonyTradeItem instance. |
Method Summary | |
---|---|
Colony |
getColony()
Get the Colony value. |
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. |
java.util.List<FreeColGameObject> |
makeTrade()
Concludes the trade. |
void |
setColony(Colony newColony)
Set the Colony value. |
void |
toXMLImpl(javax.xml.stream.XMLStreamWriter out)
This method writes an XML-representation of this object to the given stream. |
Methods inherited from class net.sf.freecol.common.model.TradeItem |
---|
getDestination, getGame, getSource, setDestination, setGame, setSource |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ColonyTradeItem(Game game, Player source, Player destination, Colony colony)
ColonyTradeItem
instance.
game
- a Game
valuesource
- a Player
valuedestination
- a Player
valuecolony
- a Colony
valuepublic ColonyTradeItem(Game game, javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
ColonyTradeItem
instance.
game
- a Game
valuein
- a XMLStreamReader
value
javax.xml.stream.XMLStreamException
Method Detail |
---|
public final Colony getColony()
Colony
value.
Colony
valuepublic final void setColony(Colony newColony)
Colony
value.
newColony
- The new Colony value.public boolean isValid()
isValid
in class TradeItem
boolean
valuepublic boolean isUnique()
isUnique
in class TradeItem
boolean
valuepublic java.util.List<FreeColGameObject> makeTrade()
makeTrade
in class TradeItem
public void toXMLImpl(javax.xml.stream.XMLStreamWriter out) throws javax.xml.stream.XMLStreamException
toXMLImpl
in class TradeItem
out
- The target stream.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.public static java.lang.String getXMLElementTagName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |