Player

java.lang.Object
- com.buckosoft.fibs.domain.Player

All Implemented Interfaces:

java.lang.Comparable<Player>
```
public class Player
extends java.lang.Object
implements java.lang.Comparable<Player>
```
Describe one FIBS player.
Most of these fields don't have setters because this object is mostly filled out from FIBS. See parsePlayer(String).

Since:

2008/03/31

Version:

$Revision: 1.7 $
$Date: 2011/05/06 23:45:54 $

Author:

Dick Balaska

See Also:

cvs Player.java

Constructor Summary

Constructors
Constructor and Description

Player()
Create a default/empty Player

Player(java.lang.String playerName)
Convienence constructor to set the player's name.

Constructors
Constructor and Description
`Player()` Create a default/empty Player
`Player(java.lang.String playerName)` Convienence constructor to set the player's name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Player o)` String compare the name of this player with that one.
`int`	`getBfFlag()` Get the BuckoFIBS flag (not used yet)
`java.lang.String`	`getBfStatus()` If this player has a special status string, like an invite warning, it goes here.
`java.lang.String`	`getClient()` What client is this player using?
`java.lang.String`	`getEmail()` What is this player's email address?
`int`	`getExperience()` Get the number of games this player has played
`java.lang.String`	`getHostName()` Get the hostname of the machine this player is playing on.
`int`	`getId()` Get the local player id.
`int`	`getIdleTime()` How long has this player been idle?
`long`	`getLoginTime()` When did this player log in?
`java.lang.String`	`getMissManners()` If this player has a MissManners warning, this is it.
`java.lang.String`	`getName()` Get the username of this player
`java.lang.String`	`getOpponent()` If this player is playing someone, then return the opponent's name.
`double`	`getRating()` Get the rating for this player
`java.lang.String`	`getSavedMatch()` If you have a saved match with this player, then this string describes it.
`java.lang.String`	`getWatching()` If this player is watching someone, then return the name of the player we are watching.
`WinLoss`	`getWinLoss()` Return a string of your won/loss record against this player.
`boolean`	`isAway()` Has this player marked himself as away?
`boolean`	`isInvited()` Have we invited this player?
`boolean`	`isPlaying()` Return true if this player is playing someone.
`boolean`	`isReady()` Is this player ready to play?
`boolean`	`parsePlayer(java.lang.String s)` Parse this player from a FIBS string.
`void`	`setBfFlag(int bfFlag)` Set the BuckoFIBS flag (not used yet)
`void`	`setBfStatus(java.lang.String bfStatus)` If this player has a special status string, like an invite warning, it goes here.
`void`	`setClient(java.lang.String client)` Set the name of the client that this player is using.
`void`	`setId(int id)` Set the local player id.
`void`	`setInvited(boolean invited)`
`void`	`setMissManners(java.lang.String missManners)` Set the MissManners warning issued about this player
`void`	`setName(java.lang.String name)` Set the username of this player.
`void`	`setSavedMatch(java.lang.String savedMatch)` Set the savedMatch (tooltip) text
`void`	`setWinLoss(int wins, int losses)` Set the string of your won/loss record against this player.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Player
```
public Player()
```
    Create a default/empty Player
  - Player
```
public Player(java.lang.String playerName)
```
    Convienence constructor to set the player's name.
    
    Parameters:
    
    playerName - The name of this new player.
- Method Detail
  - getId
```
public int getId()
```
    Get the local player id. This is a key to our local database, and is not a FIBS number at all.
    
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Set the local player id. This is a key to our local database, and is not a FIBS number at all.
    
    Parameters:
    
    id - the id to set
  - getName
```
public java.lang.String getName()
```
    Get the username of this player
    
    Returns:
    
    The username
  - setName
```
public void setName(java.lang.String name)
```
    Set the username of this player. This is useful when we get an invite from an unknown player.
    
    Parameters:
    
    name - The player's name
  - isPlaying
```
public boolean isPlaying()
```
    Return true if this player is playing someone. This field is derived from the opponent field.
    
    Returns:
    
    true if playing.
  - getOpponent
```
public java.lang.String getOpponent()
```
    If this player is playing someone, then return the opponent's name.
    
    Returns:
    
    The opponent's name or the empty string if not playing anyone.
  - getWatching
```
public java.lang.String getWatching()
```
    If this player is watching someone, then return the name of the player we are watching.
    
    Returns:
    
    The player being watched or the empty string if not watching anyone.
  - isReady
```
public boolean isReady()
```
    Is this player ready to play?
    
    Returns:
    
    true if ready to play.
  - isAway
```
public boolean isAway()
```
    Has this player marked himself as away?
    
    Returns:
    
    true = yes
  - getRating
```
public double getRating()
```
    Get the rating for this player
    
    Returns:
    
    The rating
  - getExperience
```
public int getExperience()
```
    Get the number of games this player has played
    
    Returns:
    
    The Experience
  - getIdleTime
```
public int getIdleTime()
```
    How long has this player been idle?
    
    Returns:
    
    The number of seconds he has not done anything.
  - getLoginTime
```
public long getLoginTime()
```
    When did this player log in?
    
    Returns:
    
    The number of seconds since Jan. 1, 1970
  - getHostName
```
public java.lang.String getHostName()
```
    Get the hostname of the machine this player is playing on.
    
    Returns:
    
    The hostname
  - getClient
```
public java.lang.String getClient()
```
    What client is this player using?
    
    Returns:
    
    The name of the client.
  - setClient
```
public void setClient(java.lang.String client)
```
    Set the name of the client that this player is using.
    
    Parameters:
    
    client -
  - getEmail
```
public java.lang.String getEmail()
```
    What is this player's email address?
    
    Returns:
    
    The email address that the player gave to FIBS (probably not a real email address).
  - getWinLoss
```
public WinLoss getWinLoss()
```
    Return a string of your won/loss record against this player.
    
    Returns:
    
    the winLoss
  - setWinLoss
```
public void setWinLoss(int wins,
                       int losses)
```
    Set the string of your won/loss record against this player.
    
    Parameters:
    
    wins - The number of times you have beaten this opponent.
    
    losses - The number of times you have lost to this opponent.
  - getBfFlag
```
public int getBfFlag()
```
    Get the BuckoFIBS flag (not used yet)
    
    Returns:
    
    the bfFlag
  - setBfFlag
```
public void setBfFlag(int bfFlag)
```
    Set the BuckoFIBS flag (not used yet)
    
    Parameters:
    
    bfFlag - the bfFlag to set
  - getBfStatus
```
public java.lang.String getBfStatus()
```
    If this player has a special status string, like an invite warning, it goes here.
    
    Returns:
    
    the bfStatus The status string.
  - setBfStatus
```
public void setBfStatus(java.lang.String bfStatus)
```
    If this player has a special status string, like an invite warning, it goes here.
    
    Parameters:
    
    bfStatus - the bfStatus to set
  - isInvited
```
public boolean isInvited()
```
    Have we invited this player?
    
    Returns:
    
    the invited
  - setInvited
```
public void setInvited(boolean invited)
```
    Parameters:
    
    invited - the invited to set
  - getSavedMatch
```
public java.lang.String getSavedMatch()
```
    If you have a saved match with this player, then this string describes it.
    
    Returns:
    
    the savedMatch or null if none
  - setSavedMatch
```
public void setSavedMatch(java.lang.String savedMatch)
```
    Set the savedMatch (tooltip) text
    
    Parameters:
    
    savedMatch - the savedMatch to set
  - getMissManners
```
public java.lang.String getMissManners()
```
    If this player has a MissManners warning, this is it.
    
    Returns:
    
    the missManners warning, or null if this player has none.
  - setMissManners
```
public void setMissManners(java.lang.String missManners)
```
    Set the MissManners warning issued about this player
    
    Parameters:
    
    missManners - the missManners to set
  - parsePlayer
```
public boolean parsePlayer(java.lang.String s)
```
    Parse this player from a FIBS string. Fills in most of this object's fields from the FIBS who info line.
    
    Parameters:
    
    s - The who info line from FIBS
    
    Returns:
    
    success
  - compareTo
```
public int compareTo(Player o)
```
    String compare the name of this player with that one.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Player>
    
    Parameters:
    
    o - The other player to compare

Class Player

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Player

Player

Method Detail

getId

setId

getName

setName

isPlaying

getOpponent

getWatching

isReady

isAway

getRating

getExperience

getIdleTime

getLoginTime

getHostName

getClient

setClient

getEmail

getWinLoss

setWinLoss

getBfFlag

setBfFlag

getBfStatus

setBfStatus

isInvited

setInvited

getSavedMatch

setSavedMatch

getMissManners

setMissManners

parsePlayer

compareTo