rails.game.special
Class ExchangeForShare

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

All Implemented Interfaces:

ConfigurableComponentI, Moveable, SpecialPropertyI

public class ExchangeForShare
extends SpecialProperty

Nested Class Summary

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

SpecialPropertyI.Priority

Field Summary

(package private) java.lang.String	publicCompanyName The public company of which a share can be obtained.
(package private) int	share The share size

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

ExchangeForShare()

Method Summary

void	configureFromXML(Tag tag) Instructs the component to configure itself from the provided XML element.
java.lang.String	getInfo() Default Info text.
java.lang.String	getName()
java.lang.String	getPublicCompanyName()
int	getShare()
boolean	isExecutionable()
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

finishConfiguration, 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

publicCompanyName

java.lang.String publicCompanyName

The public company of which a share can be obtained.

share

int share

The share size

Constructor Detail

ExchangeForShare

public ExchangeForShare()

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

isExecutionable

public boolean isExecutionable()

getPublicCompanyName

public java.lang.String getPublicCompanyName()

Returns:

Returns the publicCompanyName.

getShare

public int getShare()

Returns:

Returns the share.

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