rails.game.specific._18AL
Class NameTrains

java.lang.Object
  extended by rails.game.special.SpecialProperty
      extended by rails.game.specific._18AL.NameTrains
All Implemented Interfaces:
ConfigurableComponentI, Moveable, SpecialPropertyI

public class NameTrains
extends SpecialProperty
implements Moveable


Nested Class Summary
 
Nested classes/interfaces inherited from interface rails.game.special.SpecialPropertyI
SpecialPropertyI.Priority
 
Field Summary
 
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.move.Moveable
AT_END
 
Fields inherited from interface rails.game.special.SpecialPropertyI
DEFAULT_PRIORITY
 
Constructor Summary
NameTrains()
           
 
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 getName()
           
 java.util.List<NamedTrainToken> getTokens()
           
 boolean isExecutionable()
           
 void setExercised()
          Tokens can be reassigned indefinitely, so the ability is never set to exercised.
 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, 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
 
Methods inherited from interface rails.game.move.Moveable
getHolder, moveTo
 

Constructor Detail

NameTrains

public NameTrains()
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

getTokens

public java.util.List<NamedTrainToken> getTokens()

isExecutionable

public boolean isExecutionable()
Specified by:
isExecutionable in interface SpecialPropertyI

setExercised

public void setExercised()
Tokens can be reassigned indefinitely, so the ability is never set to exercised.

Specified by:
setExercised in interface SpecialPropertyI
Overrides:
setExercised in class SpecialProperty

getName

public java.lang.String getName()
Specified by:
getName in interface Moveable
Specified by:
getName in interface SpecialPropertyI

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

toString

public java.lang.String toString()
Overrides:
toString 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