A B C D F G I J L M N P R S T U V W

A

addGamePlace(GamePlace) - Method in interface de.spieleck.game.base.GameRoom
adds a GamePlace to this GameRoom
addGamePlace(GamePlace) - Method in class de.spieleck.game.base.GameRoomBase
adds a GamePlace to this GameRoom
addListener(ScheduleListener) - Method in interface de.spieleck.game.util.Schedule
 
addRule(GameRule) - Method in class de.spieleck.game.base.GameRoomBase
We keep a set of rules to be allowed in a certain room.
AnonymousSpectator - class de.spieleck.game.base.AnonymousSpectator.
Implementation of a Spectator not yet signed on.
AnonymousSpectator() - Constructor for class de.spieleck.game.base.AnonymousSpectator
 

B

BaseGameException - exception de.spieleck.game.base.BaseGameException.
Exception thrown internally by game.base Classes.
BaseGameException(String) - Constructor for class de.spieleck.game.base.BaseGameException
 
BaseGameException(String, Throwable) - Constructor for class de.spieleck.game.base.BaseGameException
 
BUILD_STAMP - Static variable in interface de.spieleck.game.TStamp
 

C

canJoin(GamePlayer) - Method in class de.spieleck.game.base.PlayerCollectionBase
can join, can be matter rights, roles, game rules or whatever.
canJoin(GamePlayer) - Method in interface de.spieleck.game.base.PlayerCollection
Deprecated. can join, can be matter rights, roles, game rules or whatever.
canJoin(GamePlayer) - Method in class de.spieleck.game.base.GameTableBase
GameState/PlayerCollection API.
canJoin(GamePlayer) - Method in class de.spieleck.game.numfield.NumfieldState
 
canLeave(GamePlayer) - Method in class de.spieleck.game.base.PlayerCollectionBase
can leave, can be matter rights, roles, game rules or whatever.
canLeave(GamePlayer) - Method in interface de.spieleck.game.base.PlayerCollection
Deprecated. can leave, can be matter rights, roles, game rules or whatever.
canLeave(GamePlayer) - Method in class de.spieleck.game.base.GameTableBase
GameState/PlayerCollection API.
canLeave(GamePlayer) - Method in class de.spieleck.game.numfield.NumfieldState
 
canWatch(GameSpectator) - Method in class de.spieleck.game.base.GamePlaceBase
 
canWatch(GameSpectator) - Method in class de.spieleck.game.base.SpectatorCollectionBase
can join, can be matter rights, roles, game rules or whatever.
canWatch(GameSpectator) - Method in interface de.spieleck.game.base.SpectatorCollection
can join, can be matter rights, roles, game rules or whatever.
checkFrozen() - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
createGameTable() - Method in interface de.spieleck.game.base.GameTableBuilder
creates a new GameTable with the specified settings
createMove(GamePlayer) - Method in interface de.spieleck.game.base.GameState
creates an empty or default @link{PlayerMove}s for a player
createMove(GamePlayer) - Method in class de.spieleck.game.base.GameTableBase
GameState API.

D

de.spieleck.game - package de.spieleck.game
Root package of the Spieleck Game Framework.
de.spieleck.game.base - package de.spieleck.game.base
These classes are aimed to provide an abstract framework to catch the semantics of an arbitrary (maybe not exactly real time) game.
de.spieleck.game.base.msg - package de.spieleck.game.base.msg
 
de.spieleck.game.numfield - package de.spieleck.game.numfield
This implementation of Numfield is meant to be an example and test implementation of the Spieleck Game Framework.
de.spieleck.game.util - package de.spieleck.game.util
The usual util package, in this case for the Spieleck Game Framework.
dispatchUpdateMessage(UpdateMessage) - Method in class de.spieleck.game.base.GamePlaceBase
A Spectable can be made responsible to distribute certain Events to it's Spectators.
dispatchUpdateMessage(UpdateMessage) - Method in class de.spieleck.game.base.SpectatorCollectionBase
delegated to its Spectable
dispatchUpdateMessage(UpdateMessage) - Method in interface de.spieleck.game.base.Spectable
A Spectable can be made responsible to distribute certain Events to it's Spectators.
dispatchUpdateMessage(UpdateMessage) - Method in class de.spieleck.game.base.PlayerCollectionBase
A Spectable can be made responsible to distribute certain Events to it's Spectators.
doTurn() - Method in interface de.spieleck.game.base.GameState
By calling this method all Move are processed and a new GameState is created.
doTurn() - Method in class de.spieleck.game.base.GameTableBase
GameState API.

F

freeze() - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 

G

GameBean - interface de.spieleck.game.base.GameBean.
Interface to mark all components in the game environment which are "beanlike".
GameException - exception de.spieleck.game.GameException.
SuperException by all Game-System classes.
GameException(String) - Constructor for class de.spieleck.game.GameException
 
GameException(String, Throwable) - Constructor for class de.spieleck.game.GameException
 
GamePersist - interface de.spieleck.game.base.GamePersist.
Currently a marker interface for all classes which could need a persistence engine.
GamePlace - interface de.spieleck.game.base.GamePlace.
A GameSite represents a collection of GameRooms
GamePlaceBase - class de.spieleck.game.base.GamePlaceBase.
A default implementation for GamePlace
GamePlaceBase() - Constructor for class de.spieleck.game.base.GamePlaceBase
 
GamePlayer - interface de.spieleck.game.base.GamePlayer.
Interface describing a veritable game Player.
GameRoom - interface de.spieleck.game.base.GameRoom.
A GameRoom represents a collection of places, where gaming goes on.
GameRoomBase - class de.spieleck.game.base.GameRoomBase.
A GameRoom represents a collection of places, where gaming goes on.
GameRoomBase() - Constructor for class de.spieleck.game.base.GameRoomBase
A simple constructor.
GameRule - interface de.spieleck.game.base.GameRule.
This interface represents a Rule of a game.
GameRuleCustomizer - interface de.spieleck.game.base.GameRuleCustomizer.
 
GameSpectator - interface de.spieleck.game.base.GameSpectator.
Essentially a marker interface for everything/everyone who/which can observe a certain game on a certain table.
GameState - interface de.spieleck.game.base.GameState.
 
GameStateBase - class de.spieleck.game.base.GameStateBase.
Interface a GameTable, i.e. a virtual place, where some players play a game.
GameStateBase() - Constructor for class de.spieleck.game.base.GameStateBase
 
GameTable - interface de.spieleck.game.base.GameTable.
Interface for a virtual place, where some GamePlayers play actually play a single game with a GameRule and a GameRuleCustomizer.
GameTableBase - class de.spieleck.game.base.GameTableBase.
A implementation of GameTable, i.e. a virtual place, where some GamePlayers play actually play a single game with a GameRule and a GameRuleCustomizer.
GameTableBase(GameSpectator) - Constructor for class de.spieleck.game.base.GameTableBase
 
GameTableBuilder - interface de.spieleck.game.base.GameTableBuilder.
A GameTableBuilder is used for building GameTables consisting of the starting players, a GameRule and a GameRuleCustomizer.
getCustomizer() - Method in interface de.spieleck.game.base.GameRule
Return a bean allowing for customization of the rules of a game.
getCustomizer() - Method in class de.spieleck.game.numfield.NumfieldRule
 
getGameName() - Method in interface de.spieleck.game.base.GameRule
Give the game a name.
getGameName() - Method in class de.spieleck.game.numfield.NumfieldRule
 
getGamePlaces() - Method in interface de.spieleck.game.base.GameRoom
returns an Iterator of all GamePlace connected to this GameRoom
getGamePlaces() - Method in class de.spieleck.game.base.GameRoomBase
returns an Iterator of all GamePlace connected to this GameRoom
getGameRule() - Method in interface de.spieleck.game.base.VisibleGameState
Exhibit the rule for the played game.
getGameRule() - Method in class de.spieleck.game.base.GameTableBase
VisibleGameState API.
getGameRule() - Method in class de.spieleck.game.base.GameStateBase
VisibleGameState API.
getGameRuleCustomizer() - Method in interface de.spieleck.game.base.VisibleGameState
Get the GameRuleCustomizer for the Game.
getGameRuleCustomizer() - Method in class de.spieleck.game.base.GameTableBase
VisibleGameState API.
getGameRuleCustomizer() - Method in class de.spieleck.game.base.GameStateBase
VisibleGameState API.
getGames() - Method in interface de.spieleck.game.base.GamePlayer
Return a list of all Games the Player participates in.
getid() - Method in class de.spieleck.game.base.GameRoomBase
poor mens unique id.
getId() - Method in interface de.spieleck.game.base.GameRoom
Generate unique id's for children
getInitialState(PlayerCollection, GameRuleCustomizer) - Method in interface de.spieleck.game.base.GameRule
Return an valid initial state for a game.
getInitialState(PlayerCollection, GameRuleCustomizer) - Method in class de.spieleck.game.numfield.NumfieldRule
 
getInstance() - Static method in class de.spieleck.game.numfield.NumfieldRule
 
getMaster() - Method in class de.spieleck.game.base.GameTableBase
GameTable.getMaster() API.
getMaster() - Method in interface de.spieleck.game.base.GameTable
 
getMaxBet() - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
getMinBet() - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
getParent() - Method in class de.spieleck.game.base.GamePlaceBase
Get the Places parent Place.
getParent() - Method in interface de.spieleck.game.base.GamePlace
Get the Places parent Place.
getPlace() - Method in interface de.spieleck.game.base.UpdateMessage
Get Place where the change happened.
getPlace() - Method in class de.spieleck.game.base.UpdateMessageBase
 
getPlaceLocalName() - Method in interface de.spieleck.game.base.GamePlace
Every GamePlace can also have a shorter (local) name.
getPlaceLocalName() - Method in class de.spieleck.game.base.GameTableBase
GamePlaceAPI
getPlaceName() - Method in class de.spieleck.game.base.GamePlaceBase
Every GamePlace should have a name.
getPlaceName() - Method in interface de.spieleck.game.base.GamePlace
Every GamePlace should have a name.
getPlayer() - Method in class de.spieleck.game.base.msg.PlayerMessage
 
getPlayerCount() - Method in class de.spieleck.game.base.GamePlaceBase
 
getPlayerCount() - Method in class de.spieleck.game.base.PlayerCollectionBase
Return the number of Players currently in the collection
getPlayerCount() - Method in interface de.spieleck.game.base.ReadablePlayerCollection
Return the number of players currently in the game
getPlayerCount() - Method in class de.spieleck.game.base.GameStateBase
PlayerCollection API.
getPlayers() - Method in class de.spieleck.game.base.GamePlaceBase
GameState API.
getPlayers() - Method in class de.spieleck.game.base.PlayerCollectionBase
get at an Iterator over all Players in this Collection
getPlayers() - Method in interface de.spieleck.game.base.ReadablePlayerCollection
List the GamePlayers involved in a Game.
getPlayers() - Method in class de.spieleck.game.base.GameStateBase
PlayerCollection API.
getRules() - Method in interface de.spieleck.game.base.GameRoom
return the list of allowed Rules in this Room.
getRules() - Method in class de.spieleck.game.base.GameRoomBase
return the list of allowed Rules in this Room.
getSchedule() - Method in class de.spieleck.game.base.GameTableBase
Get the game Schedule.
getSchedule() - Method in interface de.spieleck.game.base.GameTable
Get the game Schedule.
getSpectator() - Method in class de.spieleck.game.base.msg.SpectatorMessage
 
getSpectatorName() - Method in class de.spieleck.game.base.GamePlaceBase
 
getSpectatorName() - Method in interface de.spieleck.game.base.GameSpectator
 
getSpectatorName() - Method in class de.spieleck.game.base.GameTableBase
GameSpectator API
getSpectatorName() - Method in class de.spieleck.game.base.AnonymousSpectator
 
getSpectators() - Method in class de.spieleck.game.base.GamePlaceBase
get Spectators
getSpectators() - Method in class de.spieleck.game.base.SpectatorCollectionBase
get at an Iterator over all Spectators in this Collection
getSpectators() - Method in interface de.spieleck.game.base.ReadableSpectatorCollection
get at an Iterator over all Spectators in this Collection
getSpectatorsCount() - Method in class de.spieleck.game.base.GamePlaceBase
 
getSpectatorsCount() - Method in class de.spieleck.game.base.SpectatorCollectionBase
Return the number of Spectators currently in the collection
getSpectatorsCount() - Method in interface de.spieleck.game.base.ReadableSpectatorCollection
Return the number of Spectators currently in the collection
getVisibleGameState(GameSpectator) - Method in interface de.spieleck.game.base.GameState
Get the part of the GameState, that is visible to a certain spectator.
getVisibleGameState(GameSpectator) - Method in class de.spieleck.game.base.GameTableBase
GameState.getVisibleGameState(de.spieleck.game.base.GameSpectator) API.
go() - Method in class de.spieleck.game.base.GameTableBase
ScheduleListener API.
go() - Method in interface de.spieleck.game.util.ScheduleListener
Do something on time.

I

id - Static variable in class de.spieleck.game.base.GameRoomBase
unique child id
isFrozen() - Method in interface de.spieleck.game.base.GameRuleCustomizer
We need to check weather state can still be customized or has to be considered read-only from now.
isFrozen() - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
isIn(GamePlayer) - Method in class de.spieleck.game.base.GamePlaceBase
GameState API.
isIn(GamePlayer) - Method in class de.spieleck.game.base.PlayerCollectionBase
Check weather a certain Players is in the collection.
isIn(GamePlayer) - Method in interface de.spieleck.game.base.ReadablePlayerCollection
Check weather a certain player plays in this game.
isIn(GamePlayer) - Method in class de.spieleck.game.base.GameStateBase
PlayerCollection API.
isWatching(GameSpectator) - Method in class de.spieleck.game.base.GamePlaceBase
 
isWatching(GameSpectator) - Method in class de.spieleck.game.base.SpectatorCollectionBase
Check weather a certain Spectator is in the collection.
isWatching(GameSpectator) - Method in interface de.spieleck.game.base.ReadableSpectatorCollection
Check weather a certain Spectator is in the collection.

J

join(GamePlayer) - Method in class de.spieleck.game.base.GamePlaceBase
 
join(GamePlayer) - Method in class de.spieleck.game.base.PlayerCollectionBase
add a new Spectator if joining is not allowed, an Exception is thrown
join(GamePlayer) - Method in interface de.spieleck.game.base.PlayerCollection
Deprecated. add a new Player if joining is not allowed, an Exception is thrown
join(GamePlayer) - Method in class de.spieleck.game.base.GameStateBase
PlayerCollection API.

L

leave(GamePlayer) - Method in class de.spieleck.game.base.GamePlaceBase
 
leave(GamePlayer) - Method in class de.spieleck.game.base.PlayerCollectionBase
removes the given Spectator from the players list
leave(GamePlayer) - Method in interface de.spieleck.game.base.PlayerCollection
Deprecated. removes the given player from the players list
leave(GamePlayer) - Method in class de.spieleck.game.base.GameStateBase
PlayerCollection API.
localName - Variable in class de.spieleck.game.base.GameTableBase
Kind of an unique id

M

master - Variable in class de.spieleck.game.base.GameTableBase
The GameMaster on this table

N

notifyUpdate(UpdateMessage) - Method in interface de.spieleck.game.base.GameSpectator
 
notifyUpdate(UpdateMessage) - Method in class de.spieleck.game.base.GameTableBase
Spectator API XXX do we really siply want to pass along all events??
notifyUpdate(UpdateMessage) - Method in class de.spieleck.game.base.AnonymousSpectator
 
NumfieldException - exception de.spieleck.game.numfield.NumfieldException.
This is the NumfieldException, essentially an Umbrella for the GameException.
NumfieldException(String) - Constructor for class de.spieleck.game.numfield.NumfieldException
 
NumfieldRule - class de.spieleck.game.numfield.NumfieldRule.
This interface represents a Rule of a game.
NumfieldRuleCustomizer - class de.spieleck.game.numfield.NumfieldRuleCustomizer.
This interface represents the rules of a game.
NumfieldState - class de.spieleck.game.numfield.NumfieldState.
State of an numfield game.

P

place - Variable in class de.spieleck.game.base.UpdateMessageBase
 
places - Variable in class de.spieleck.game.base.GameRoomBase
GamePlaces below this one
player - Variable in class de.spieleck.game.base.msg.PlayerMessage
Keep the involved player
PlayerCollection - interface de.spieleck.game.base.PlayerCollection.
Deprecated. use SpectatorCollection and PlayerCollectionBase instead
PlayerCollectionBase - class de.spieleck.game.base.PlayerCollectionBase.
A PlayerCollectionBase contains Players This can be used to handle roles and rights.
PlayerCollectionBase() - Constructor for class de.spieleck.game.base.PlayerCollectionBase
Create a new instance of PlayerCollectionBase
PlayerJoinMessage - class de.spieleck.game.base.msg.PlayerJoinMessage.
 
PlayerJoinMessage(GamePlace, GamePlayer) - Constructor for class de.spieleck.game.base.msg.PlayerJoinMessage
 
PlayerLeaveMessage - class de.spieleck.game.base.msg.PlayerLeaveMessage.
XXX This would be even short if it subclassed PlayerJoinMessage?!
PlayerLeaveMessage(GamePlace, GamePlayer) - Constructor for class de.spieleck.game.base.msg.PlayerLeaveMessage
 
PlayerMessage - class de.spieleck.game.base.msg.PlayerMessage.
 
PlayerMessage(GamePlace, GamePlayer) - Constructor for class de.spieleck.game.base.msg.PlayerMessage
 
PlayerMove - interface de.spieleck.game.base.PlayerMove.
This interface represents a move of a player in a game at a certain gamestate.
players - Variable in class de.spieleck.game.base.PlayerCollectionBase
 
printStackTrace() - Method in class de.spieleck.game.GameException
Partially extend the API to handle the wrapping case cracefully.

R

ReadablePlayerCollection - interface de.spieleck.game.base.ReadablePlayerCollection.
Any device that can "contain" Players.
ReadableSpectatorCollection - interface de.spieleck.game.base.ReadableSpectatorCollection.
Any read-only device that can contain Spectators
removeGamePlace(GamePlace) - Method in interface de.spieleck.game.base.GameRoom
removes the GamePlace from this GameRoom
removeGamePlace(GamePlace) - Method in class de.spieleck.game.base.GameRoomBase
removes the GamePlace from this GameRoom
removeListener(ScheduleListener) - Method in interface de.spieleck.game.util.Schedule
 
removeRule(GameRule) - Method in class de.spieleck.game.base.GameRoomBase
 
rules - Variable in class de.spieleck.game.base.GameRoomBase
Rules available in this Room

S

schedule - Variable in class de.spieleck.game.base.GameTableBase
The current Schedule for this game
Schedule - interface de.spieleck.game.util.Schedule.
Describe the Schedule for example for a Game.
ScheduleException - exception de.spieleck.game.util.ScheduleException.
Exception to be thrown while Scheduling
ScheduleException(String) - Constructor for class de.spieleck.game.util.ScheduleException
 
ScheduleException(String, Throwable) - Constructor for class de.spieleck.game.util.ScheduleException
 
ScheduleListener - interface de.spieleck.game.util.ScheduleListener.
Describe the Schedule for example for a Game.
setGameCustomizer(GameRuleCustomizer) - Method in class de.spieleck.game.base.GameStateBase
 
setGameRule(GameRule) - Method in interface de.spieleck.game.base.GameTableBuilder
sets the GameRule
setGameRule(GameRule) - Method in class de.spieleck.game.base.GameStateBase
 
setGameRuleCustomizer(GameRuleCustomizer) - Method in interface de.spieleck.game.base.GameTableBuilder
sets the GameRuleCustomizer
setInitialGameState(GameRule, PlayerCollection, GameRuleCustomizer) - Method in class de.spieleck.game.base.GameTableBase
set the initial state of the game.
setMaxBet(int) - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
setMinBet(int) - Method in class de.spieleck.game.numfield.NumfieldRuleCustomizer
 
setParent(GamePlace) - Method in class de.spieleck.game.base.GamePlaceBase
We use a Parent link at times.
setParent(GamePlace) - Method in interface de.spieleck.game.base.GamePlace
We use a Parent link at times.
setPlayerMove(GamePlayer, PlayerMove) - Method in interface de.spieleck.game.base.GameState
Set the turn for the player.
setPlayerMove(GamePlayer, PlayerMove) - Method in class de.spieleck.game.base.GameTableBase
GameState API.
setPlayers(PlayerCollection) - Method in class de.spieleck.game.base.GamePlaceBase
Since we want to manage Players we use a PlayerCollection
setPlayers(PlayerCollection) - Method in class de.spieleck.game.base.GameStateBase
Store the players in the GameState.
setSchedule(Schedule) - Method in class de.spieleck.game.base.GameTableBase
Set the game a Schedule.
setSchedule(Schedule) - Method in interface de.spieleck.game.base.GameTable
Set the game a Schedule.
setSpectators(SpectatorCollection) - Method in class de.spieleck.game.base.GamePlaceBase
Since we want to manage Players we use a PlayerCollection
Spectable - interface de.spieleck.game.base.Spectable.
A Spectable can dispatch Message to Spectators.
spectator - Variable in class de.spieleck.game.base.msg.SpectatorMessage
Keep the involved spectator
SpectatorCollection - interface de.spieleck.game.base.SpectatorCollection.
Any device that can contain Spectators.
SpectatorCollectionBase - class de.spieleck.game.base.SpectatorCollectionBase.
Base implementation of a SpectatorCollection which can dispatch messages to its Spectators
SpectatorCollectionBase() - Constructor for class de.spieleck.game.base.SpectatorCollectionBase
Creates a new instance of SpectatorCollectionBase
SpectatorJoinMessage - class de.spieleck.game.base.msg.SpectatorJoinMessage.
 
SpectatorJoinMessage(GamePlace, GameSpectator) - Constructor for class de.spieleck.game.base.msg.SpectatorJoinMessage
 
SpectatorLeaveMessage - class de.spieleck.game.base.msg.SpectatorLeaveMessage.
XXX This would be even short if it subclassed SpectatorJoinMessage?!
SpectatorLeaveMessage(GamePlace, GameSpectator) - Constructor for class de.spieleck.game.base.msg.SpectatorLeaveMessage
 
SpectatorMessage - class de.spieleck.game.base.msg.SpectatorMessage.
 
SpectatorMessage(GamePlace, GameSpectator) - Constructor for class de.spieleck.game.base.msg.SpectatorMessage
 
spectators - Variable in class de.spieleck.game.base.SpectatorCollectionBase
 
state - Variable in class de.spieleck.game.base.GameTableBase
The current State of the game on this table

T

toString() - Method in class de.spieleck.game.GameException
Partially extend the API to handle the wrapping case cracefully.
TStamp - interface de.spieleck.game.TStamp.
Marker Interface to hold generation stamp at build time.
turnAway(GameSpectator) - Method in class de.spieleck.game.base.GamePlaceBase
 
turnAway(GameSpectator) - Method in class de.spieleck.game.base.SpectatorCollectionBase
removes the given Spectator from the Spectators list
turnAway(GameSpectator) - Method in interface de.spieleck.game.base.SpectatorCollection
removes the given Spectator from the spectators list

U

UpdateMessage - interface de.spieleck.game.base.UpdateMessage.
Message distributed to GameSpectator-Objects on a Game Update.
UpdateMessageBase - class de.spieleck.game.base.UpdateMessageBase.
Message distributed to GameSpectator-Objects on a Game Update.
UpdateMessageBase(GamePlace) - Constructor for class de.spieleck.game.base.UpdateMessageBase
 

V

ValidatableInput - interface de.spieleck.game.base.ValidatableInput.
Interface for everything that could be user input.
validate() - Method in interface de.spieleck.game.base.ValidatableInput
Allow the GUI or whateever interface to check validity of a move.
VisibleGameState - interface de.spieleck.game.base.VisibleGameState.
Essentially a marker interface for that part of a GameState which is visible to a certain range.

W

watch(GameSpectator) - Method in class de.spieleck.game.base.GamePlaceBase
 
watch(GameSpectator) - Method in class de.spieleck.game.base.SpectatorCollectionBase
Add a new Spectator.
watch(GameSpectator) - Method in interface de.spieleck.game.base.SpectatorCollection
add a new Spectator if joining is not allowed, an Exception is thrown
wrapped - Variable in class de.spieleck.game.GameException
 

A B C D F G I J L M N P R S T U V W

gameframe project