net.sf.freecol.server.ai
Class AIMain

java.lang.Object
  net.sf.freecol.server.ai.AIMain

All Implemented Interfaces:

FreeColGameObjectListener

public class AIMain
extends java.lang.Object
implements FreeColGameObjectListener

The main AI-class. Keeps references to all other AI-classes.

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LICENSE
static java.lang.String	REVISION

Constructor Summary

AIMain(FreeColServer freeColServer)
Creates a new AIMain and searches the current game for FreeColGameObjects.

AIMain(FreeColServer freeColServer, org.w3c.dom.Element element)
Creates a new AIMain and reads the given element.

AIMain(FreeColServer freeColServer, javax.xml.stream.XMLStreamReader in)
Creates a new AIMain and reads the given element.

Method Summary

void	addAIObject(java.lang.String id, AIObject aiObject) Adds a reference to the given AIObject.
boolean	checkIntegrity() Checks the integrity of this AIMain by checking if there are any uninitialized objects.
void	findNewObjects(boolean overwrite) Searches for new FreeColGameObjects.
AIObject	getAIObject(FreeColGameObject fcgo) Gets the AIObject for the given FreeColGameObject.
AIObject	getAIObject(java.lang.String id) Gets the AIObject identified by the given ID.
FreeColGameObject	getFreeColGameObject(java.lang.String id) Gets the FreeColGameObject with the given ID.
FreeColServer	getFreeColServer() Gets the main controller object for the server.
Game	getGame() Returns the game.
java.lang.String	getNextID() Gets a unique ID for identifying an AIObject.
PseudoRandom	getRandom() Returns an instance of PseudoRandom.
static java.lang.String	getXMLElementTagName() Returns the tag name of the root element representing this object.
void	ownerChanged(FreeColGameObject source, Player oldOwner, Player newOwner)
void	readFromXML(javax.xml.stream.XMLStreamReader in) Reads all the AIObjects and other AI-related information from XML data.
void	readFromXMLElement(org.w3c.dom.Element element) Initialize this object from an XML-representation of this object.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Reads all the AIObjects and other AI-related information from XML data.
void	removeAIObject(java.lang.String id) Removes a reference to the given AIObject.
void	removeFreeColGameObject(java.lang.String id) Removes the AIObject for the given FreeColGameObject.
void	setFreeColGameObject(java.lang.String id, FreeColGameObject freeColGameObject) Creates a new AIObject for a given FreeColGameObject.
void	toXML(javax.xml.stream.XMLStreamWriter out) Writes all of the AIObjects and other AI-related information to an XML-stream.
org.w3c.dom.Element	toXMLElement(org.w3c.dom.Document document) This method writes an XML-representation of this object to the given stream.
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) Writes all of the AIObjects and other AI-related information to an XML-stream.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

AIMain

public AIMain(FreeColServer freeColServer)

Creates a new AIMain and searches the current game for FreeColGameObjects.

Parameters:

freeColServer - The main controller object for the server.

See Also:

findNewObjects()

AIMain

public AIMain(FreeColServer freeColServer,
              org.w3c.dom.Element element)

Creates a new AIMain and reads the given element.

Parameters:

freeColServer - The main controller object for the server.

element - The Element (in a DOM-parsed XML-tree) that describes this object.

See Also:

readFromXMLElement(org.w3c.dom.Element)

AIMain

public AIMain(FreeColServer freeColServer,
              javax.xml.stream.XMLStreamReader in)
       throws javax.xml.stream.XMLStreamException

Creates a new AIMain and reads the given element.

Parameters:

freeColServer - The main controller object for the server.

in - The input stream containing the XML.

Throws:

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

See Also:

readFromXML(javax.xml.stream.XMLStreamReader)

Method Detail

getFreeColServer

public FreeColServer getFreeColServer()

Gets the main controller object for the server.

Returns:

The FreeColServer-object.

getNextID

public java.lang.String getNextID()

Gets a unique ID for identifying an AIObject.

Returns:

A unique ID.

checkIntegrity

public boolean checkIntegrity()

Checks the integrity of this AIMain by checking if there are any uninitialized objects. Detected problems gets written to the log.

Returns:

true if the Game has been loaded properly.

getGame

public Game getGame()

Returns the game.

Returns:

The Game.

getRandom

public PseudoRandom getRandom()

Returns an instance of PseudoRandom. It that can be used to generate random numbers.

Returns:

The instance of PseudoRandom.

findNewObjects

public void findNewObjects(boolean overwrite)

Searches for new FreeColGameObjects. An AI-object is created for each new object.

Parameters:

overwrite - Determines wether any old AIObject should be overwritten or not.

getAIObject

public AIObject getAIObject(FreeColGameObject fcgo)

Gets the AIObject for the given FreeColGameObject.

Parameters:

fcgo - The FreeColGameObject to find the AIObject for.

Returns:

The AIObject.

See Also:

getAIObject(String)

getAIObject

public AIObject getAIObject(java.lang.String id)

Gets the AIObject identified by the given ID.

Parameters:

id - The ID of the AIObject.

Returns:

The AIObject.

See Also:

getAIObject(FreeColGameObject)

addAIObject

public void addAIObject(java.lang.String id,
                        AIObject aiObject)

Adds a reference to the given AIObject.

Parameters:

id - The ID of the AIObject.

aiObject - The AIObject to store a reference for.

Throws:

java.lang.IllegalStateException - if an AIObject with the same id has already been created.

removeAIObject

public void removeAIObject(java.lang.String id)

Removes a reference to the given AIObject.

Parameters:

id - The ID of the AIObject.

getFreeColGameObject

public FreeColGameObject getFreeColGameObject(java.lang.String id)

Gets the FreeColGameObject with the given ID. This is just a convenience method for: Game.getFreeColGameObject(java.lang.String)

Parameters:

id - The ID of the FreeColGameObject to find.

Returns:

The FreeColGameObject.

ownerChanged

public void ownerChanged(FreeColGameObject source,
                         Player oldOwner,
                         Player newOwner)

Specified by:

ownerChanged in interface FreeColGameObjectListener

setFreeColGameObject

public void setFreeColGameObject(java.lang.String id,
                                 FreeColGameObject freeColGameObject)

Creates a new AIObject for a given FreeColGameObject. This method gets called whenever a new object gets added to the Game.

Specified by:

setFreeColGameObject in interface FreeColGameObjectListener

Parameters:

id - The ID of the FreeColGameObject to add.

freeColGameObject - The FreeColGameObject to add.

See Also:

AIObject, FreeColGameObject, FreeColGameObject.getID()

removeFreeColGameObject

public void removeFreeColGameObject(java.lang.String id)

Removes the AIObject for the given FreeColGameObject.

Specified by:

removeFreeColGameObject in interface FreeColGameObjectListener

Parameters:

id - The ID of the FreeColGameObject.

toXMLElement

public org.w3c.dom.Element toXMLElement(org.w3c.dom.Document document)

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

Parameters:

document - The Document.

Returns:

An XML-representation of this object.

readFromXMLElement

public void readFromXMLElement(org.w3c.dom.Element element)

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

Parameters:

element - An XML-element that will be used to initialize this object.

toXMLImpl

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

Writes all of the AIObjects and other AI-related information to an XML-stream.

Parameters:

out - The target stream.

Throws:

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

toXML

public void toXML(javax.xml.stream.XMLStreamWriter out)
           throws javax.xml.stream.XMLStreamException

Writes all of the AIObjects and other AI-related information to an XML-stream.

Parameters:

out - The target stream.

Throws:

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

readFromXML

public void readFromXML(javax.xml.stream.XMLStreamReader in)
                 throws javax.xml.stream.XMLStreamException

Reads all the AIObjects and other AI-related information from XML data.

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if an error occured during parsing.

readFromXMLImpl

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

Reads all the AIObjects and other AI-related information from XML data.

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if an error occured during parsing.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

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

Returns:

"aiMain"