net.sf.freecol.server.ai.mission
Class PrivateerMission

java.lang.Object
  net.sf.freecol.common.model.FreeColObject
      net.sf.freecol.server.ai.AIObject
          net.sf.freecol.server.ai.mission.Mission
              net.sf.freecol.server.ai.mission.PrivateerMission

public class PrivateerMission
extends Mission

Nested Class Summary

private static class

PrivateerMission.PrivateerMissionState

Field Summary

private static java.util.logging.Logger	logger
private Location	nearestPort
private PrivateerMission.PrivateerMissionState	state
private Tile	target
private boolean	valid

Fields inherited from class net.sf.freecol.server.ai.mission.Mission

MINIMUM_TRANSPORT_PRIORITY, NO_MORE_MOVES_LEFT, NO_PATH_TO_TARGET, NORMAL_TRANSPORT_PRIORITY

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

uninitialized

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

ARRAY_SIZE, ID_ATTRIBUTE, ID_ATTRIBUTE_TAG, INFINITY, NO_ID, PARTIAL_ATTRIBUTE, UNDEFINED, VALUE_TAG

Constructor Summary

PrivateerMission(AIMain aiMain, AIUnit aiUnit)
Creates a mission for the given AIUnit.

PrivateerMission(AIMain aiMain, org.w3c.dom.Element element)
Loads a mission from the given element.

PrivateerMission(AIMain aiMain, javax.xml.stream.XMLStreamReader in)
Creates a new UnitWanderHostileMission and reads the given element.

Method Summary

void	doMission(Connection connection) Performs the mission.
private void	dumpCargoInPort(Connection connection)
private void	findNearestPort()
java.lang.String	getDebuggingInfo() Gets debugging information about this mission.
static int	getModifierValueForTarget(CombatModel combatModel, Unit attacker, Unit defender) Calculates the modifier used when assessing the value of a target to a privateer.
private PathNode	getValidPathForNearestPort()
static java.lang.String	getXMLElementTagName() Returns the tag name of the root element representing this object.
private void	gotoNearestPort(Connection connection)
private void	hunt4Target(Connection connection)
private boolean	isUnitInPort()
boolean	isValid() Checks if this mission is still valid to perform.
static boolean	isValid(AIUnit aiUnit) Checks if this mission is valid for the given unit.
protected void	readAttributes(javax.xml.stream.XMLStreamReader in)
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) Writes all of the AIObjects and other AI-related information to an XML-stream.
protected void	writeAttributes(javax.xml.stream.XMLStreamWriter out)

Methods inherited from class net.sf.freecol.server.ai.mission.Mission

dispose, findNearestOtherSettlement, findTarget, getAIRandom, getAIUnit, getEuropeanAIPlayer, getPathStartTile, getTransportDestination, getTransportPriority, getUnit, isOneTime, moveButDontAttack, moveRandomly, moveTowards, moveTowards, moveUnitToAmerica, moveUnitToEurope, sellCargoInEurope, setAIUnit, shouldTakeTransportToTile, travelToTarget, unitLeavesShip, unloadCargoInColony

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

getAIMain, getGame, getSpecification, isUninitialized, readFromXML

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, hasAbility, hasAttribute, hasListeners, readAttributes, readChild, readChild, readChildren, readChildren, readFromArrayElement, readFromArrayElement, readFromListElement, readFromXMLElement, readFromXMLImpl, 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

logger

private static final java.util.logging.Logger logger

state

private PrivateerMission.PrivateerMissionState state

nearestPort

private Location nearestPort

target

private Tile target

valid

private boolean valid

Constructor Detail

PrivateerMission

public PrivateerMission(AIMain aiMain,
                        AIUnit aiUnit)

Creates a mission for the given AIUnit.

Parameters:

aiMain - The main AI-object.

aiUnit - The AIUnit this mission is created for.

PrivateerMission

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

Loads a mission from the given element.

Parameters:

aiMain - The main AI-object.

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

PrivateerMission

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

Creates a new UnitWanderHostileMission and reads the given element.

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)

Method Detail

doMission

public void doMission(Connection connection)

Performs the mission. This is done by searching for hostile units that are located within one tile and attacking them. If no such units are found, then wander in a random direction.

Specified by:

doMission in class Mission

Parameters:

connection - The Connection to the server.

hunt4Target

private void hunt4Target(Connection connection)

gotoNearestPort

private void gotoNearestPort(Connection connection)

getValidPathForNearestPort

private PathNode getValidPathForNearestPort()

findNearestPort

private void findNearestPort()

isUnitInPort

private boolean isUnitInPort()

dumpCargoInPort

private void dumpCargoInPort(Connection connection)

isValid

public static boolean isValid(AIUnit aiUnit)

Checks if this mission is valid for the given unit.

Parameters:

aiUnit - The unit.

Returns:

true if this mission is valid to perform and false otherwise.

isValid

public boolean isValid()

Checks if this mission is still valid to perform.

Overrides:

isValid in class Mission

Returns:

True if the mission is still valid.

getDebuggingInfo

public java.lang.String getDebuggingInfo()

Gets debugging information about this mission. This string is a short representation of this object's state.

Overrides:

getDebuggingInfo in class Mission

Returns:

"".

getModifierValueForTarget

public static int getModifierValueForTarget(CombatModel combatModel,
                                            Unit attacker,
                                            Unit defender)

Calculates the modifier used when assessing the value of a target to a privateer. Note: it gives a modifier value, other parameters should be considered as well Note: we assume the unit given is a privateer, no test is made

Parameters:

combatModel - The Combat Model used.

attacker - The Unit attacking, should be a privateer.

defender - The Unit the attacker is considering as a target.

Returns:

The modifier value the defender is worth as a target to the privateer

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.

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

Description copied from class: Mission

Overrides:

writeAttributes in class Mission

Parameters:

out - The target stream.

Throws:

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

readAttributes

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

Description copied from class: Mission

Overrides:

readAttributes in class Mission

Parameters:

in - The XML input stream.

Throws:

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

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

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

Returns:

"privateerMission"