net.sf.freecol.server.ai
Class AIUnit

java.lang.Object
  net.sf.freecol.server.ai.AIObject
      net.sf.freecol.server.ai.AIUnit

All Implemented Interfaces:

Transportable

public class AIUnit
extends AIObject
implements Transportable

Objects of this class contains AI-information for a single Unit.

The method doMission(Connection) is called once each turn, by AIPlayer.startWorking(), to perform the assigned Mission. Most of the methods in this class just delegates the call to that mission.

See Also:

Mission

Field Summary

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

Fields inherited from class net.sf.freecol.server.ai.AIObject

id, uninitialized

Constructor Summary

AIUnit(AIMain aiMain, org.w3c.dom.Element element)
Creates a new AIUnit.

AIUnit(AIMain aiMain, java.lang.String id)
Creates a new AIUnit.

AIUnit(AIMain aiMain, Unit unit)
Creates a new AIUnit.

AIUnit(AIMain aiMain, javax.xml.stream.XMLStreamReader in)
Creates a new AIUnit.

Method Summary

void	abortWish(Wish w) Aborts the given Wish.
void	dispose() Disposes this object and any attached mission.
void	doMission(Connection connection) Performs the mission this unit has been assigned.
java.lang.String	getID() Returns the ID of this AIObject.
Mission	getMission() Gets the mission this unit has been assigned.
AIUnit	getTransport() Gets the carrier responsible for transporting this Transportable.
Location	getTransportDestination() Returns the destination for this Transportable.
Locatable	getTransportLocatable() Gets the Locatable which should be transported.
int	getTransportPriority() Gets the priority of transporting this Transportable to it's destination.
Location	getTransportSource() Returns the source for this Transportable.
Unit	getUnit() Gets the Unit this AIUnit controls.
static java.lang.String	getXMLElementTagName() Returns the tag name of the root element representing this object.
boolean	hasMission() Checks if this unit has been assigned a mission.
void	increaseTransportPriority() Increases the transport priority of this Transportable.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Reads information for this object from an XML stream.
void	setMission(Mission mission) Assignes a mission to unit.
void	setTransport(AIUnit transport) Sets the carrier responsible for transporting this Transportable.
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) Writes this object to an XML stream.

Methods inherited from class net.sf.freecol.server.ai.AIObject

getAIMain, getGame, getRandom, isUninitialized, readFromXML, readFromXMLElement, toXML, toXMLElement

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

AIUnit

public AIUnit(AIMain aiMain,
              Unit unit)

Creates a new AIUnit.

Parameters:

aiMain - The main AI-object.

unit - The unit to make an AIObject for.

AIUnit

public AIUnit(AIMain aiMain,
              org.w3c.dom.Element element)

Creates a new AIUnit.

Parameters:

aiMain - The main AI-object.

element - An Element containing an XML-representation of this object.

AIUnit

public AIUnit(AIMain aiMain,
              javax.xml.stream.XMLStreamReader in)
       throws javax.xml.stream.XMLStreamException

Creates a new AIUnit.

Parameters:

aiMain - The main AI-object.

in - The input stream containing the XML.

Throws:

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

See Also:

AIObject.readFromXML(javax.xml.stream.XMLStreamReader)

AIUnit

public AIUnit(AIMain aiMain,
              java.lang.String id)

Creates a new AIUnit.

Parameters:

aiMain - The main AI-object.

id - The unique ID of this object.

Method Detail

getUnit

public Unit getUnit()

Gets the Unit this AIUnit controls.

Returns:

The Unit.

abortWish

public void abortWish(Wish w)

Aborts the given Wish.

Specified by:

abortWish in interface Transportable

Parameters:

w - The Wish to be aborted.

getTransportLocatable

public Locatable getTransportLocatable()

Gets the Locatable which should be transported.

Specified by:

getTransportLocatable in interface Transportable

Returns:

The Locatable.

getTransportSource

public Location getTransportSource()

Returns the source for this Transportable. This is normally the location of the locatable.

Specified by:

getTransportSource in interface Transportable

Returns:

The source for this Transportable.

getTransportDestination

public Location getTransportDestination()

Returns the destination for this Transportable. This can either be the target Tile of the transport or the target for the entire Transportable's mission. The target for the tansport is determined by TransportMission in the latter case.

Specified by:

getTransportDestination in interface Transportable

Returns:

The destination for this Transportable.

getTransportPriority

public int getTransportPriority()

Gets the priority of transporting this Transportable to it's destination.

Specified by:

getTransportPriority in interface Transportable

Returns:

The priority of the transport.

increaseTransportPriority

public void increaseTransportPriority()

Increases the transport priority of this Transportable. This method gets called every turn the Transportable have not been put on a carrier's transport list.

Specified by:

increaseTransportPriority in interface Transportable

getTransport

public AIUnit getTransport()

Gets the carrier responsible for transporting this Transportable.

Specified by:

getTransport in interface Transportable

Returns:

The AIUnit which has this Transportable in it's transport list. This Transportable has not been scheduled for transport if this value is null.

setTransport

public void setTransport(AIUnit transport)

Sets the carrier responsible for transporting this Transportable.

Specified by:

setTransport in interface Transportable

Parameters:

transport - The AIUnit which has this Transportable in it's transport list. This Transportable has not been scheduled for transport if this value is null.

getMission

public Mission getMission()

Gets the mission this unit has been assigned.

Returns:

The Mission.

hasMission

public boolean hasMission()

Checks if this unit has been assigned a mission.

Returns:

true if this unit has a mission.

setMission

public void setMission(Mission mission)

Assignes a mission to unit. The dynamic priority is reset.

Parameters:

mission - The new Mission.

doMission

public void doMission(Connection connection)

Performs the mission this unit has been assigned.

Parameters:

connection - The Connection to use when communicating with the server.

dispose

public void dispose()

Disposes this object and any attached mission.

Overrides:

dispose in class AIObject

getID

public java.lang.String getID()

Returns the ID of this AIObject.

Specified by:

getID in interface Transportable

Specified by:

getID in class AIObject

Returns:

The same ID as the Unit this AIObject controls.

toXMLImpl

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

Writes this object to an XML stream.

Specified by:

toXMLImpl in class AIObject

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

Reads information for this object from an XML stream.

Specified by:

readFromXMLImpl in class AIObject

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems reading from the stream.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

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

Returns:

"aiUnit"