|
||||||||||
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.FreeColGameObject
public abstract class FreeColGameObject
The superclass of all game objects in FreeCol.
Field Summary |
---|
Fields inherited from class net.sf.freecol.common.model.FreeColObject |
---|
ID_ATTRIBUTE_TAG |
Constructor Summary | |
---|---|
FreeColGameObject(Game game)
Creates a new FreeColGameObject with an automatically assigned
ID and registers this object at the specified Game . |
|
FreeColGameObject(Game game,
org.w3c.dom.Element e)
Initiates a new FreeColGameObject from an Element . |
|
FreeColGameObject(Game game,
java.lang.String id)
Initiates a new FreeColGameObject
with the given ID. |
|
FreeColGameObject(Game game,
javax.xml.stream.XMLStreamReader in)
Initiates a new FreeColGameObject from an Element . |
Method Summary | ||
---|---|---|
void |
addToRemoveElement(org.w3c.dom.Element removeElement)
Convenience function to add this object to an element intended to signal removal of the object. |
|
void |
dispose()
Removes all references to this object. |
|
boolean |
equals(FreeColGameObject o)
Checks if the given FreeColGameObject equals this object. |
|
boolean |
equals(java.lang.Object o)
Checks if the given FreeColGameObject equals this object. |
|
|
getFreeColGameObject(javax.xml.stream.XMLStreamReader in,
java.lang.String attributeName,
java.lang.Class<T> returnClass)
|
|
|
getFreeColGameObject(javax.xml.stream.XMLStreamReader in,
java.lang.String attributeName,
java.lang.Class<T> returnClass,
T defaultValue)
|
|
Game |
getGame()
Gets the game object this FreeColGameObject belongs to. |
|
GameOptions |
getGameOptions()
Gets the GameOptions that is associated with the
Game owning this FreeColGameObject . |
|
java.lang.Integer |
getIntegerID()
Gets the ID's integer part of this object. |
|
static java.lang.String |
getXMLElementTagName()
Gets the tag name of the root element representing this object. |
|
int |
hashCode()
|
|
boolean |
hasID(java.lang.String id)
Checks if this object has the specified ID. |
|
boolean |
isDisposed()
Checks if this object has been disposed. |
|
boolean |
isUninitialized()
Checks if this FreeColGameObject
is uninitialized. |
|
void |
readFromXML(javax.xml.stream.XMLStreamReader in)
Initialize this object from an XML-representation of this object. |
|
void |
setGame(Game game)
Sets the game object this FreeColGameObject belongs to. |
|
void |
setId(java.lang.String newID)
Sets the unique ID of this object. |
|
void |
toSavedXML(javax.xml.stream.XMLStreamWriter out)
This method writes an XML-representation of this object to the given stream for the purpose of storing this object as a part of a saved game. |
|
java.lang.String |
toString()
Returns a string representation of the object. |
|
void |
toXML(javax.xml.stream.XMLStreamWriter out,
Player player,
boolean showAll,
boolean toSavedGame)
This method writes an XML-representation of this object to the given stream. |
|
|
updateFreeColGameObject(javax.xml.stream.XMLStreamReader in,
java.lang.Class<T> returnClass)
|
|
void |
updateID()
Updates the id. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FreeColGameObject(Game game)
FreeColGameObject
with an automatically assigned
ID and registers this object at the specified Game
.
game
- The Game
in which this object belong.public FreeColGameObject(Game game, javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
FreeColGameObject
from an Element
.
game
- The Game
in which this object belong.in
- The input stream containing the XML.
javax.xml.stream.XMLStreamException
- if a problem was encountered
during parsing.public FreeColGameObject(Game game, org.w3c.dom.Element e)
FreeColGameObject
from an Element
.
game
- The Game
in which this object belong.e
- An XML-element that will be used to initialize
this object.public FreeColGameObject(Game game, java.lang.String id)
FreeColGameObject
with the given ID. The object should later be
initialized by calling either
readFromXML(XMLStreamReader)
or
FreeColObject.readFromXMLElement(Element)
.
game
- The Game
in which this object belong.id
- The unique identifier for this object.Method Detail |
---|
public Game getGame()
FreeColGameObject
belongs to.
game
.public GameOptions getGameOptions()
GameOptions
that is associated with the
Game
owning this FreeColGameObject
.
GameOptions
-object as returned
by getGame().getGameOptions()
.public void setGame(Game game)
FreeColGameObject
belongs to.
game
- The game
.public void dispose()
public boolean isDisposed()
true
if this object has been disposed.dispose()
public boolean isUninitialized()
FreeColGameObject
is uninitialized. That is: it has been referenced
by another object, but has not yet been updated with
readFromXML(javax.xml.stream.XMLStreamReader)
.
true
if this object is not initialized.public void updateID()
public void toSavedXML(javax.xml.stream.XMLStreamWriter out) throws javax.xml.stream.XMLStreamException
out
- The target stream.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.toXML(XMLStreamWriter, Player, boolean, boolean)
public final void toXML(javax.xml.stream.XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame) throws javax.xml.stream.XMLStreamException
Player
will
be added to that representation if showAll
is
set to false
.
toXML
in class FreeColObject
out
- The target stream.player
- The Player
this XML-representation
should be made for, or null
if
showAll == true
.showAll
- Only attributes visible to player
will be added to the representation if showAll
is set to false.toSavedGame
- If true
then information that
is only needed when saving a game is added.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.public final void readFromXML(javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
readFromXML
in class FreeColObject
in
- The input stream containing the XML.
javax.xml.stream.XMLStreamException
- if a problem was encountered
during parsing.public java.lang.Integer getIntegerID()
public final void setId(java.lang.String newID)
Game
with the new ID.
newID
- the unique ID of this object,public boolean hasID(java.lang.String id)
id
- The ID to check against.
public boolean equals(FreeColGameObject o)
FreeColGameObject
equals this object.
o
- The FreeColGameObject
to compare against this object.
FreeColGameObject
are equal and false otherwise.public boolean equals(java.lang.Object o)
FreeColGameObject
equals this object.
equals
in class java.lang.Object
o
- The FreeColGameObject
to compare against this object.
FreeColGameObject
are equal and false otherwise.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
String
public <T extends FreeColGameObject> T getFreeColGameObject(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, java.lang.Class<T> returnClass)
public <T extends FreeColGameObject> T getFreeColGameObject(javax.xml.stream.XMLStreamReader in, java.lang.String attributeName, java.lang.Class<T> returnClass, T defaultValue)
public <T extends FreeColGameObject> T updateFreeColGameObject(javax.xml.stream.XMLStreamReader in, java.lang.Class<T> returnClass)
public void addToRemoveElement(org.w3c.dom.Element removeElement)
removeElement
- The remove element.public static java.lang.String getXMLElementTagName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |