com.buckosoft.fibs.domain

Class GroupOfPlayers

java.lang.Object

com.buckosoft.fibs.domain.GroupOfPlayers

public class GroupOfPlayers
extends java.lang.Object

A group of Players.

Since:

2010/12/30

Version:

$Revision: 1.9 $
$Date: 2011/05/10 05:48:45 $

Author:

Dick Balaska

See Also:

PlayerGroup, cvs GroupOfPlayers.java

Constructor Summary

Constructors

Constructor and Description
GroupOfPlayers() Default empty constructor
GroupOfPlayers(java.lang.String groupName, java.awt.Color color) Convienence constructor to set some fields

Method Summary

Modifier and Type	Method and Description
void	addPlayer(int playerId) Add this player to this group.
java.awt.Color	getColor() Get the color to display group members in.
long	getColorStore() Get the color in a database friendly format.
java.lang.String	getGroupName() Get the name of this group.
int	getId() Return the unique id for this GroupOfPlayers
java.util.List<PlayerGroup>	getPlayerGroups() Get the PlayserGroup list, the database likes to do this for saving
java.util.LinkedList<java.lang.Integer>	getPlayers() Get the list of Players in this group.
boolean	isActive() Did the user select this Group to be active?
boolean	isDirty() Does this Group need to be saved to disk?
boolean	isIgnore() Is this a list of players to ignore?
void	setActive(boolean active) The user changed this Group's active state.
void	setColor(java.awt.Color color) Set the color to display group members in.
void	setColorStore(long rgb) Set the color from a database friendly format.
void	setDirty(boolean dirty) Set whether this Group needs to be saved or not.
void	setGroupName(java.lang.String groupName) Set the name of this group.
void	setId(int id) Set the unique id for this GroupOfPlayers
void	setIgnore(boolean ignore) Are ignoring this list of players
void	setPlayerGroups(java.util.List<PlayerGroup> playerGroups) Set the PlayerGroup list, usually after loading it from the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupOfPlayers

public GroupOfPlayers()

Default empty constructor

GroupOfPlayers

public GroupOfPlayers(java.lang.String groupName,
                      java.awt.Color color)

Convienence constructor to set some fields

Parameters:

groupName - The name of this new GroupOfPlayers

color - The color to display this group in.

Method Detail

getId

public int getId()

Return the unique id for this GroupOfPlayers

Returns:

the id

setId

public void setId(int id)

Set the unique id for this GroupOfPlayers

Parameters:

id - the id to set

getGroupName

public java.lang.String getGroupName()

Get the name of this group.

Returns:

the name

setGroupName

public void setGroupName(java.lang.String groupName)

Set the name of this group.

Parameters:

groupName - the name to set

getColor

public java.awt.Color getColor()

Get the color to display group members in.

Returns:

the color

setColor

public void setColor(java.awt.Color color)

Set the color to display group members in.

Parameters:

color - the color to set

getColorStore

public long getColorStore()

Get the color in a database friendly format.

Returns:

the RGB triple in a long format

setColorStore

public void setColorStore(long rgb)

Set the color from a database friendly format.

Parameters:

rgb -

getPlayers

public java.util.LinkedList<java.lang.Integer> getPlayers()

Get the list of Players in this group.

Returns:

the players

getPlayerGroups

public java.util.List<PlayerGroup> getPlayerGroups()

Get the PlayserGroup list, the database likes to do this for saving

Returns:

A reference to the PlayerGroup list.

setPlayerGroups

public void setPlayerGroups(java.util.List<PlayerGroup> playerGroups)

Set the PlayerGroup list, usually after loading it from the database. Upon setting this, update the handy players list.

Parameters:

playerGroups - The PlayerGroups for this group

addPlayer

public void addPlayer(int playerId)

Add this player to this group.

Parameters:

playerId - The id of the player to add to this group.

isIgnore

public boolean isIgnore()

Is this a list of players to ignore?

Returns:

the ignore

setIgnore

public void setIgnore(boolean ignore)

Are ignoring this list of players

Parameters:

ignore - the ignore to set

isActive

public boolean isActive()

Did the user select this Group to be active?

Returns:

the active

setActive

public void setActive(boolean active)

The user changed this Group's active state.

Parameters:

active - the active to set

isDirty

public boolean isDirty()

Does this Group need to be saved to disk?

Returns:

the dirty

setDirty

public void setDirty(boolean dirty)

Set whether this Group needs to be saved or not.

Parameters:

dirty - the dirty to set