Class Options

java.lang.Object

net.sf.colossus.common.Options

All Implemented Interfaces:

IOptions

public final class Options
extends Object
implements IOptions

Class Options lists game options for Colossus.

Author:

David Ripton TODO constants should be all uppercase

Nested Class Summary

Nested classes/interfaces inherited from interface IOptions

IOptions.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	activePreferencesTab
static final String	aiDelay
static final String	aiTimeLimit
static final String	allStacksVisible
static final String	antialias
static final String	autoAcquireAngels
static final String	autoCarrySingle
static final String	autoConcede
static final String	autoFlee
static final String	autoForcedStrike
static final String	autoMasterMove
static final String	autoNegotiate
static final String	autoPickColor
static final String	autoPickEngagements
static final String	autoPickEntrySide
static final String	autoPickLord
static final String	autoPickMarker
static final String	autoPickRecruiter
static final String	autoPlay
static final String	autoQuit
static final String	autoRangeSingle
static final String	autoRecruit
static final String	autoReinforce
static final String	autoSansLordBattles
static final String	autosave
static final String	autosaveMaxKeep
static final String	autosaveVerboseNames
static final String	autoSplit
static final String	autoStop
static final String	autoSummonAngels
static final String	balancedTowers
static final String	BattleTerrainHazardWindow
static final String	confirmConcedeWithTitan
static final String	confirmNoMove
static final String	confirmNoRecruit
static final String	confirmNoSplit
static final String	cumulativeSlow
private final String	dataPath
static final String	doNotInvertDefender
static final String	dubiousAsBlanks
static final String	editModeActive
static final String	enableEditingMode
static final String	eventExpiring
static final String[]	eventExpiringChoices
static final String	eventExpiringNever
static final String	favoriteColors
static final String	favoriteLookFeel
static final String	FORCE_BOARD
private static boolean	functionalTestOngoing
static final String[]	globalGameOptions
static final String	goOnWithoutObserver
static final String	hotSeatMode
static final String	keepAccepting
static final String	legionMoveConfirmationNoConfirm
static final String	legionMoveConfirmationNoMove
static final String	legionMoveConfirmationNoUnvisitedMove
static final int	legionMoveConfirmationNumMove
static final int	legionMoveConfirmationNumNoConfirm
static final int	legionMoveConfirmationNumUnvisitedMove
static final String	legionMoveConfirmationSubMenu
private final Map<String, List<IOptions.Listener>>	listeners
static final String	loadGameFileName
static final String	locX
static final String	locY
private static final Logger	LOGGER
static final String	maxPlayersWeb
static final String	minPlayersWeb
static final String	nextMove
static final String	nextMuster
static final String	nextSplitAllSplitable
static final String	nextSplitLeftClick
static final String	nextSplitNoClick
static final int	nextSplitNumLeftClick
static final int	nextSplitNumNoClick
static final int	nextSplitNumRightClick
static final String	nextSplitRightClick
static final String	nextSplitSubMenu
static final String	noBaseColor
private boolean	noFile
static final String	noFirstTurnT2TTeleport
static final String	noFirstTurnTeleport
static final String	noFirstTurnWarlockRecruit
static final String	nonRandomBattleDice
static final String	noTitanTeleport
static final String	noTowerTeleport
static final String	oneHexAllowed
static final String	onlyOwnLegions
private final String	owner
static final String	playerColoredAngels
static final String	playerName
static final String	playerType
private static String	propNameStresstestRounds
static final String	proposedGamesTableOption
private final Properties	props
private final boolean	readOnly
static final String	runClientHost
static final String	runClientPlayer
static final String	runClientPort
static final String	runSpectatorClient
static final String	scale
static final String	serveAtPort
static final String	serverName
static final String	showAllRecruitChits
static final String	showAutoInspector
static final String	showCaretaker
static final String	showConnectionLogWindow
static final String	showDiceAjustmentsRange
static final String	showDiceAjustmentsTerrain
static final String	showEngagementResults
static final String	showEventViewer
static final String	showHitThreshold
static final String	showLogWindow
static final String	showMarker
static final String	showRecruitChitsAll
static final String	showRecruitChitsNone
static final int	showRecruitChitsNumAll
static final int	showRecruitChitsNumNone
static final int	showRecruitChitsNumRecruitHint
static final int	showRecruitChitsNumStrongest
static final String	showRecruitChitsRecruitHint
static final String	showRecruitChitsStrongest
static final String	showRecruitChitsSubmenu
static final String	showStatusScreen
static final String	showWebClient
static final String	sizeX
static final String	sizeY
private static boolean	startupTestOngoing
static final String	stealFocus
static final String	suppressedWelcomeDialog
static final String	targPlayersWeb
static final String	towerToTowerTeleportOnly
static final String	turnStartBeep
static final String	turnStartToFront
static final String	unlimitedMulligans
static final String	useColoredBorders
static final String	useOverlay
static final String	variant
static final String	variantFileWithFullPath
static final String	viewableAll
static final int	viewableAllNum
static final String	viewableEver
static final int	viewableEverNum
static final String	viewableLast
static final int	viewableLastNum
static final String	viewableOwn
static final int	viewableOwnNum
static final String	viewMode
static final String[]	viewModeArray
static final String	webClientLogin
static final String	webClientPassword
static final String	webFlagFileName
static final String	webServerHost
static final String	webServerPort

Constructor Summary

Constructors

Constructor	Description
Options(String owner)
Options(String owner, boolean noFile)
Options(String owner, String customPath, boolean noFile)
Options(String owner, String customPath, boolean noFile, boolean readOnly)

Method Summary

Modifier and Type	Method	Description
void	addListener(String optname, IOptions.Listener listener)	Adds a listener to get callbacks for changes on the specified option.
void	clear()	Wipe everything.
void	clearPlayerInfo()	Remove all playerName and playerType entries.
static int	getHowManyStresstestRoundsProperty()
int	getIntOption(String optname)	Return -1 if the option's value has not been set.
private List<IOptions.Listener>	getListenersForOption(String optname)
int	getNumberForLegionMoveConfirmation(String s)
int	getNumberForNextSplit(String s)
int	getNumberForRecruitChitSelection(String s)
int	getNumberForViewMode(String viewMode)
boolean	getOption(String optname)
boolean	getOption(String optname, boolean defaultValue)
String	getOptionsFilename()
String	getStringOption(String optname)
String	getStringOption(String optname, String defaultValue)
boolean	isEmpty()
static boolean	isFunctionalTest()
boolean	isOptionUndefined(String optname)
static boolean	isStartupTest()
static boolean	isStresstest()
void	loadOptions()
Enumeration<String>	propertyNames()
void	removeListener(IOptions.Listener listener)	Removes the listener from all options it is subscribed to.
void	removeOption(String optname)
void	saveOptions()
static void	setFunctionalTest(boolean val)
void	setOption(String optname, boolean value)
void	setOption(String optname, int value)
void	setOption(String optname, String value)
static void	setStartupTest(boolean val)
String	toString()
private void	triggerAllOptions()
private void	triggerBooleanOption(String optname, boolean oldValue, boolean newValue)
private void	triggerIntOption(String optname, int oldValue, int newValue)
private void	triggerStringOption(String optname, String oldValue, String newValue)

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

playerName

public static final String playerName

See Also:

• Constant Field Values

playerType

public static final String playerType

See Also:

• Constant Field Values

runClientPlayer

public static final String runClientPlayer

See Also:

• Constant Field Values

runClientHost

public static final String runClientHost

See Also:

• Constant Field Values

runClientPort

public static final String runClientPort

See Also:

• Constant Field Values

runSpectatorClient

public static final String runSpectatorClient

See Also:

• Constant Field Values

loadGameFileName

public static final String loadGameFileName

See Also:

• Constant Field Values

webFlagFileName

public static final String webFlagFileName

See Also:

• Constant Field Values

serveAtPort

public static final String serveAtPort

See Also:

• Constant Field Values

FORCE_BOARD

public static final String FORCE_BOARD

See Also:

• Constant Field Values

webServerHost

public static final String webServerHost

See Also:

• Constant Field Values

webServerPort

public static final String webServerPort

See Also:

• Constant Field Values

webClientLogin

public static final String webClientLogin

See Also:

• Constant Field Values

webClientPassword

public static final String webClientPassword

See Also:

• Constant Field Values

proposedGamesTableOption

public static final String proposedGamesTableOption

See Also:

• Constant Field Values

autosave

public static final String autosave

See Also:

• Constant Field Values

autosaveMaxKeep

public static final String autosaveMaxKeep

See Also:

• Constant Field Values

autosaveVerboseNames

public static final String autosaveVerboseNames

See Also:

• Constant Field Values

autoStop

public static final String autoStop

See Also:

• Constant Field Values

autoQuit

public static final String autoQuit

See Also:

• Constant Field Values

goOnWithoutObserver

public static final String goOnWithoutObserver

See Also:

• Constant Field Values

hotSeatMode

public static final String hotSeatMode

See Also:

• Constant Field Values

keepAccepting

public static final String keepAccepting

See Also:

• Constant Field Values

variant

public static final String variant

See Also:

• Constant Field Values

variantFileWithFullPath

public static final String variantFileWithFullPath

See Also:

• Constant Field Values

viewMode

public static final String viewMode

See Also:

• Constant Field Values

dubiousAsBlanks

public static final String dubiousAsBlanks

See Also:

• Constant Field Values

showMarker

public static final String showMarker

See Also:

• Constant Field Values

minPlayersWeb

public static final String minPlayersWeb

See Also:

• Constant Field Values

targPlayersWeb

public static final String targPlayersWeb

See Also:

• Constant Field Values

maxPlayersWeb

public static final String maxPlayersWeb

See Also:

• Constant Field Values

viewableOwn

public static final String viewableOwn

See Also:

• Constant Field Values

viewableLast

public static final String viewableLast

See Also:

• Constant Field Values

viewableEver

public static final String viewableEver

See Also:

• Constant Field Values

viewableAll

public static final String viewableAll

See Also:

• Constant Field Values

viewModeArray

public static final String[] viewModeArray

viewableOwnNum

public static final int viewableOwnNum

See Also:

• Constant Field Values

viewableLastNum

public static final int viewableLastNum

See Also:

• Constant Field Values

viewableEverNum

public static final int viewableEverNum

See Also:

• Constant Field Values

viewableAllNum

public static final int viewableAllNum

See Also:

• Constant Field Values

eventExpiring

public static final String eventExpiring

See Also:

• Constant Field Values

eventExpiringNever

public static final String eventExpiringNever

See Also:

• Constant Field Values

eventExpiringChoices

public static final String[] eventExpiringChoices

balancedTowers

public static final String balancedTowers

See Also:

• Constant Field Values

allStacksVisible

public static final String allStacksVisible

See Also:

• Constant Field Values

onlyOwnLegions

public static final String onlyOwnLegions

See Also:

• Constant Field Values

cumulativeSlow

public static final String cumulativeSlow

See Also:

• Constant Field Values

oneHexAllowed

public static final String oneHexAllowed

See Also:

• Constant Field Values

nonRandomBattleDice

public static final String nonRandomBattleDice

See Also:

• Constant Field Values

autoSansLordBattles

public static final String autoSansLordBattles

See Also:

• Constant Field Values

noFirstTurnT2TTeleport

public static final String noFirstTurnT2TTeleport

See Also:

• Constant Field Values

noFirstTurnTeleport

public static final String noFirstTurnTeleport

See Also:

• Constant Field Values

towerToTowerTeleportOnly

public static final String towerToTowerTeleportOnly

See Also:

• Constant Field Values

noTowerTeleport

public static final String noTowerTeleport

See Also:

• Constant Field Values

noTitanTeleport

public static final String noTitanTeleport

See Also:

• Constant Field Values

noFirstTurnWarlockRecruit

public static final String noFirstTurnWarlockRecruit

See Also:

• Constant Field Values

unlimitedMulligans

public static final String unlimitedMulligans

See Also:

• Constant Field Values

enableEditingMode

public static final String enableEditingMode

See Also:

• Constant Field Values

globalGameOptions

public static final String[] globalGameOptions

stealFocus

public static final String stealFocus

See Also:

• Constant Field Values

turnStartBeep

public static final String turnStartBeep

See Also:

• Constant Field Values

turnStartToFront

public static final String turnStartToFront

See Also:

• Constant Field Values

BattleTerrainHazardWindow

public static final String BattleTerrainHazardWindow

See Also:

• Constant Field Values

showCaretaker

public static final String showCaretaker

See Also:

• Constant Field Values

showStatusScreen

public static final String showStatusScreen

See Also:

• Constant Field Values

showAutoInspector

public static final String showAutoInspector

See Also:

• Constant Field Values

showEventViewer

public static final String showEventViewer

See Also:

• Constant Field Values

showLogWindow

public static final String showLogWindow

See Also:

• Constant Field Values

showConnectionLogWindow

public static final String showConnectionLogWindow

See Also:

• Constant Field Values

showWebClient

public static final String showWebClient

See Also:

• Constant Field Values

suppressedWelcomeDialog

public static final String suppressedWelcomeDialog

See Also:

• Constant Field Values

showEngagementResults

public static final String showEngagementResults

See Also:

• Constant Field Values

useOverlay

public static final String useOverlay

See Also:

• Constant Field Values

noBaseColor

public static final String noBaseColor

See Also:

• Constant Field Values

playerColoredAngels

public static final String playerColoredAngels

See Also:

• Constant Field Values

useColoredBorders

public static final String useColoredBorders

See Also:

• Constant Field Values

doNotInvertDefender

public static final String doNotInvertDefender

See Also:

• Constant Field Values

showHitThreshold

public static final String showHitThreshold

See Also:

• Constant Field Values

showDiceAjustmentsTerrain

public static final String showDiceAjustmentsTerrain

See Also:

• Constant Field Values

showDiceAjustmentsRange

public static final String showDiceAjustmentsRange

See Also:

• Constant Field Values

showAllRecruitChits

public static final String showAllRecruitChits

See Also:

• Constant Field Values

showRecruitChitsSubmenu

public static final String showRecruitChitsSubmenu

See Also:

• Constant Field Values

showRecruitChitsNone

public static final String showRecruitChitsNone

See Also:

• Constant Field Values

showRecruitChitsStrongest

public static final String showRecruitChitsStrongest

See Also:

• Constant Field Values

showRecruitChitsRecruitHint

public static final String showRecruitChitsRecruitHint

See Also:

• Constant Field Values

showRecruitChitsAll

public static final String showRecruitChitsAll

See Also:

• Constant Field Values

showRecruitChitsNumNone

public static final int showRecruitChitsNumNone

See Also:

• Constant Field Values

showRecruitChitsNumStrongest

public static final int showRecruitChitsNumStrongest

See Also:

• Constant Field Values

showRecruitChitsNumRecruitHint

public static final int showRecruitChitsNumRecruitHint

See Also:

• Constant Field Values

showRecruitChitsNumAll

public static final int showRecruitChitsNumAll

See Also:

• Constant Field Values

antialias

public static final String antialias

See Also:

• Constant Field Values

scale

public static final String scale

See Also:

• Constant Field Values

locX

public static final String locX

See Also:

• Constant Field Values

locY

public static final String locY

See Also:

• Constant Field Values

sizeX

public static final String sizeX

See Also:

• Constant Field Values

sizeY

public static final String sizeY

See Also:

• Constant Field Values

autoPickColor

public static final String autoPickColor

See Also:

• Constant Field Values

autoPickMarker

public static final String autoPickMarker

See Also:

• Constant Field Values

autoSplit

public static final String autoSplit

See Also:

• Constant Field Values

autoMasterMove

public static final String autoMasterMove

See Also:

• Constant Field Values

autoPickEntrySide

public static final String autoPickEntrySide

See Also:

• Constant Field Values

autoPickLord

public static final String autoPickLord

See Also:

• Constant Field Values

autoPickEngagements

public static final String autoPickEngagements

See Also:

• Constant Field Values

autoFlee

public static final String autoFlee

See Also:

• Constant Field Values

autoConcede

public static final String autoConcede

See Also:

• Constant Field Values

autoNegotiate

public static final String autoNegotiate

See Also:

• Constant Field Values

autoForcedStrike

public static final String autoForcedStrike

See Also:

• Constant Field Values

autoCarrySingle

public static final String autoCarrySingle

See Also:

• Constant Field Values

autoRangeSingle

public static final String autoRangeSingle

See Also:

• Constant Field Values

autoSummonAngels

public static final String autoSummonAngels

See Also:

• Constant Field Values

autoAcquireAngels

public static final String autoAcquireAngels

See Also:

• Constant Field Values

autoRecruit

public static final String autoRecruit

See Also:

• Constant Field Values

autoPickRecruiter

public static final String autoPickRecruiter

See Also:

• Constant Field Values

autoReinforce

public static final String autoReinforce

See Also:

• Constant Field Values

autoPlay

public static final String autoPlay

See Also:

• Constant Field Values

confirmNoRecruit

public static final String confirmNoRecruit

See Also:

• Constant Field Values

confirmNoMove

public static final String confirmNoMove

See Also:

• Constant Field Values

confirmNoSplit

public static final String confirmNoSplit

See Also:

• Constant Field Values

confirmConcedeWithTitan

public static final String confirmConcedeWithTitan

See Also:

• Constant Field Values

legionMoveConfirmationSubMenu

public static final String legionMoveConfirmationSubMenu

See Also:

• Constant Field Values

legionMoveConfirmationNoMove

public static final String legionMoveConfirmationNoMove

See Also:

• Constant Field Values

legionMoveConfirmationNoUnvisitedMove

public static final String legionMoveConfirmationNoUnvisitedMove

See Also:

• Constant Field Values

legionMoveConfirmationNoConfirm

public static final String legionMoveConfirmationNoConfirm

See Also:

• Constant Field Values

legionMoveConfirmationNumNoConfirm

public static final int legionMoveConfirmationNumNoConfirm

See Also:

• Constant Field Values

legionMoveConfirmationNumMove

public static final int legionMoveConfirmationNumMove

See Also:

• Constant Field Values

legionMoveConfirmationNumUnvisitedMove

public static final int legionMoveConfirmationNumUnvisitedMove

See Also:

• Constant Field Values

nextSplitSubMenu

public static final String nextSplitSubMenu

See Also:

• Constant Field Values

nextMove

public static final String nextMove

See Also:

• Constant Field Values

nextMuster

public static final String nextMuster

See Also:

• Constant Field Values

nextSplitAllSplitable

public static final String nextSplitAllSplitable

See Also:

• Constant Field Values

nextSplitLeftClick

public static final String nextSplitLeftClick

See Also:

• Constant Field Values

nextSplitRightClick

public static final String nextSplitRightClick

See Also:

• Constant Field Values

nextSplitNoClick

public static final String nextSplitNoClick

See Also:

• Constant Field Values

nextSplitNumNoClick

public static final int nextSplitNumNoClick

See Also:

• Constant Field Values

nextSplitNumLeftClick

public static final int nextSplitNumLeftClick

See Also:

• Constant Field Values

nextSplitNumRightClick

public static final int nextSplitNumRightClick

See Also:

• Constant Field Values

aiTimeLimit

public static final String aiTimeLimit

See Also:

• Constant Field Values

aiDelay

public static final String aiDelay

See Also:

• Constant Field Values

favoriteColors

public static final String favoriteColors

See Also:

• Constant Field Values

favoriteLookFeel

public static final String favoriteLookFeel

See Also:

• Constant Field Values

serverName

public static final String serverName

See Also:

• Constant Field Values

activePreferencesTab

public static final String activePreferencesTab

See Also:

• Constant Field Values

editModeActive

public static final String editModeActive

See Also:

• Constant Field Values

props

private final Properties props

owner

private final String owner

dataPath

private final String dataPath

noFile

private boolean noFile

readOnly

private final boolean readOnly

listeners

private final Map<String, List<IOptions.Listener>> listeners

functionalTestOngoing

private static boolean functionalTestOngoing

startupTestOngoing

private static boolean startupTestOngoing

propNameStresstestRounds

private static String propNameStresstestRounds

Constructor Details

Options

public Options(String owner,
 String customPath,
 boolean noFile,
 boolean readOnly)

Options

public Options(String owner,
 String customPath,
 boolean noFile)

Options

public Options(String owner)

Options

public Options(String owner,
 boolean noFile)

Method Details

getOptionsFilename

public String getOptionsFilename()

loadOptions

public void loadOptions()

saveOptions

public void saveOptions()

setOption

public void setOption(String optname,
 String value)

Specified by:

setOption in interface IOptions

setOption

public void setOption(String optname,
 boolean value)

Specified by:

setOption in interface IOptions

setOption

public void setOption(String optname,
 int value)

Specified by:

setOption in interface IOptions

getStringOption

public String getStringOption(String optname)

Specified by:

getStringOption in interface IOptions

getStringOption

public String getStringOption(String optname,
 String defaultValue)

getOption

public boolean getOption(String optname)

Specified by:

getOption in interface IOptions

getOption

public boolean getOption(String optname,
 boolean defaultValue)

Specified by:

getOption in interface IOptions

getIntOption

public int getIntOption(String optname)

Return -1 if the option's value has not been set.

Specified by:

getIntOption in interface IOptions

isOptionUndefined

public boolean isOptionUndefined(String optname)

removeOption

public void removeOption(String optname)

propertyNames

public Enumeration<String> propertyNames()

clearPlayerInfo

public void clearPlayerInfo()

Remove all playerName and playerType entries.

clear

public void clear()

Wipe everything.

isEmpty

public boolean isEmpty()

toString

public String toString()

Overrides:

toString in class Object

getNumberForViewMode

public int getNumberForViewMode(String viewMode)

getNumberForRecruitChitSelection

public int getNumberForRecruitChitSelection(String s)

getNumberForLegionMoveConfirmation

public int getNumberForLegionMoveConfirmation(String s)

getNumberForNextSplit

public int getNumberForNextSplit(String s)

setFunctionalTest

public static void setFunctionalTest(boolean val)

isFunctionalTest

public static boolean isFunctionalTest()

setStartupTest

public static void setStartupTest(boolean val)

isStartupTest

public static boolean isStartupTest()

isStresstest

public static boolean isStresstest()

getHowManyStresstestRoundsProperty

public static int getHowManyStresstestRoundsProperty()

addListener

public void addListener(String optname,
 IOptions.Listener listener)

Description copied from interface: IOptions

Adds a listener to get callbacks for changes on the specified option. The listener should be called only on true changes, not if an option gets set to the value it has anyway.

Specified by:

addListener in interface IOptions

getListenersForOption

private List<IOptions.Listener> getListenersForOption(String optname)

removeListener

public void removeListener(IOptions.Listener listener)

Description copied from interface: IOptions

Removes the listener from all options it is subscribed to. TODO there is a chance of leakage if classes subscribe to the options but never remove their listeners.

Specified by:

removeListener in interface IOptions

triggerBooleanOption

private void triggerBooleanOption(String optname,
 boolean oldValue,
 boolean newValue)

triggerIntOption

private void triggerIntOption(String optname,
 int oldValue,
 int newValue)

triggerStringOption

private void triggerStringOption(String optname,
 String oldValue,
 String newValue)

triggerAllOptions

private void triggerAllOptions()