rails.game.special
Class SpecialTokenLay

java.lang.Object
  rails.game.special.SpecialProperty
      rails.game.special.SpecialTokenLay

All Implemented Interfaces:

ConfigurableComponentI, Moveable, SpecialPropertyI

public class SpecialTokenLay
extends SpecialProperty

Nested Class Summary

Nested classes/interfaces inherited from interface rails.game.special.SpecialPropertyI

SpecialPropertyI.Priority

Field Summary

(package private) boolean	connected
(package private) boolean	extra
(package private) boolean	free
(package private) java.lang.String	locationCodes
(package private) java.util.List<MapHex>	locations
(package private) int	numberAvailable
(package private) int	numberUsed
(package private) TokenI	token
(package private) java.lang.Class<? extends Token>	tokenClass

Fields inherited from class rails.game.special.SpecialProperty

closingValue, conditionText, description, exercised, gameManager, holder, isORProperty, isSRProperty, lastIndex, log, originalCompany, permanent, priority, spMap, transferText, uniqueId, usableDuringOR, usableDuringSR, usableDuringTileLayingStep, usableDuringTokenLayingStep, usableIfOwnedByCompany, usableIfOwnedByPlayer, whenText

Fields inherited from interface rails.game.special.SpecialPropertyI

DEFAULT_PRIORITY

Fields inherited from interface rails.game.move.Moveable

AT_END

Constructor Summary

SpecialTokenLay()

Method Summary

void	configureFromXML(Tag tag) Instructs the component to configure itself from the provided XML element.
void	finishConfiguration(GameManagerI gameManager) This method is intended to be called for each configurable component, to perforn any initialisation activities that require any other components to be initialised first.
java.lang.String	getInfo() Default Info text.
java.lang.String	getLocationCodeString()
java.util.List<MapHex>	getLocations()
java.lang.String	getName()
int	getNumberLeft()
TokenI	getToken()
java.lang.Class<? extends Token>	getTokenClass()
boolean	isExecutionable()
boolean	isExtra()
boolean	isFree()
java.lang.String	toMenu() Default menu item text, should be by all special properties that can appear as a menu item
java.lang.String	toString()

Methods inherited from class rails.game.special.SpecialProperty

getByUniqueId, getClosingValue, getHelp, getHolder, getOriginalCompany, getPriority, getTransferText, getUniqueId, init, isExercised, isORProperty, isSRProperty, isUsableDuringOR, isUsableDuringSR, isUsableDuringTileLayingStep, isUsableDuringTokenLayingStep, isUsableIfOwnedByCompany, isUsableIfOwnedByPlayer, moveTo, setCompany, setExercised, setExercised, setHolder, setPriority, setUsableDuringOR, setUsableDuringSR, setUsableDuringTileLayingStep, setUsableDuringTokenLayingStep, setUsableIfOwnedByCompany, setUsableIfOwnedByPlayer

Methods inherited from class java.lang.Object

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

Field Detail

locationCodes

java.lang.String locationCodes

locations

java.util.List<MapHex> locations

extra

boolean extra

free

boolean free

connected

boolean connected

tokenClass

java.lang.Class<? extends Token> tokenClass

token

TokenI token

numberAvailable

int numberAvailable

numberUsed

int numberUsed

Constructor Detail

SpecialTokenLay

public SpecialTokenLay()

Method Detail

configureFromXML

public void configureFromXML(Tag tag)
                      throws ConfigurationException

Description copied from interface: ConfigurableComponentI

Instructs the component to configure itself from the provided XML element.

Specified by:

configureFromXML in interface ConfigurableComponentI

Overrides:

configureFromXML in class SpecialProperty

Throws:

ConfigurationException

finishConfiguration

public void finishConfiguration(GameManagerI gameManager)
                         throws ConfigurationException

Description copied from interface: ConfigurableComponentI

This method is intended to be called for each configurable component, to perforn any initialisation activities that require any other components to be initialised first. This includes creating any required relationships to other configured components and objects.

This method should be called where necessary after all XML file parsing has completed, so that all objects that need to be related to do exist.

Specified by:

finishConfiguration in interface ConfigurableComponentI

Overrides:

finishConfiguration in class SpecialProperty

Parameters:

gameManager - The 'parent' configurable component is passed to allow the 'child' to access any other object without the need to resort to static calls where possible.

Throws:

ConfigurationException

isExecutionable

public boolean isExecutionable()

getNumberLeft

public int getNumberLeft()

isExtra

public boolean isExtra()

isFree

public boolean isFree()

getLocations

public java.util.List<MapHex> getLocations()

getLocationCodeString

public java.lang.String getLocationCodeString()

getTokenClass

public java.lang.Class<? extends Token> getTokenClass()

getToken

public TokenI getToken()

getName

public java.lang.String getName()

toString

public java.lang.String toString()

Overrides:

toString in class SpecialProperty

toMenu

public java.lang.String toMenu()

Description copied from class: SpecialProperty

Default menu item text, should be by all special properties that can appear as a menu item

Specified by:

toMenu in interface SpecialPropertyI

Overrides:

toMenu in class SpecialProperty

getInfo

public java.lang.String getInfo()

Description copied from class: SpecialProperty

Default Info text. To be overridden where useful.

Specified by:

getInfo in interface SpecialPropertyI

Overrides:

getInfo in class SpecialProperty