com.buckosoft.fibs.document

Class Document

java.lang.Object

com.buckosoft.fibs.document.Document

public class Document
extends java.lang.Object

Primary document in an MVC model

Since:

2011/03/14

Version:

$Revision: 1.5 $
$Date: 2011/06/18 19:35:05 $

Author:

Dick Balaska

See Also:

cvs Document.java, FIBS Client Protocol Detailed Specification

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Modifier and Type	Method and Description
Board	getBoard() Get the Board.
int	getExperience() How many games have You played?
java.lang.String	getMissMannersString(java.lang.String playerName) If MissManners issued a warning about a player, this is a tooltip string describing it.
java.lang.String	getName() Return the userid that this player logged in as.
double	getRating() What is Your FIBS rating?
int	getRedoubles() Je ne comprends pas
java.lang.String	getSavedMatchString(java.lang.String playerName) If you have a saved match against this player, this is a tooltip string describing it.
java.lang.String	getTimezone() Get your timezone.
boolean	isAllowPip()
boolean	isAskDouble() Does the server push dice at you or wait to see if you want to roll or double
boolean	isAutoBoard()
boolean	isAutoDouble()
boolean	isAutoMove()
boolean	isAway() Have You tagged yourself as away?
boolean	isBell() Like, totally ignored.
boolean	isCrawford() Is this a crawford game?
boolean	isGreedy() Are You using greedy bearoffs?
boolean	isMoreBoards() This is pretty darn useful for client programs, so if you see it toggled off you probably want to toggle it back on.
boolean	isMoves()
boolean	isNotify() Are we being notified when new users log on and off?
boolean	isRatings()
boolean	isReady() Are you ready to play?
boolean	isReport() Are we being notified about the starting and ending of other matches?
boolean	isSilent() Do we receive the shout messages (general chat)? Note that BuckoFIBS always receives the shouts and filters them from display.
SavedMatch	parseMissManners(java.lang.String s) Parse a MissManners warning line from FIBS.
void	parseOwnInfo(java.lang.String s) Parse the Own Info command from FIBS.
SavedMatch	parseSavedMatch(java.lang.String s) Parse a saved match line from FIBS.
void	removeSavedMatch(java.lang.String playerName) Remove a player from the savedMatches list.
void	resetGame() Called at the beginning of a game, resets game user attributes
void	setAskDouble(boolean askDoubles)
void	setAutoBoard(boolean autoBoard)
void	setBoard(Board board)
void	setGreedy(boolean greedy)
void	setReady(boolean ready) Set whether we are ready to play
void	setYouDouble(boolean doubleFlag) Set and clear the state where You push a double to Your opponent.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

getBoard

public Board getBoard()

Get the Board. This is the latest board we have received from FIBS

Returns:

the board

setBoard

public void setBoard(Board board)

Parameters:

board - the board to set

resetGame

public void resetGame()

Called at the beginning of a game, resets game user attributes

setYouDouble

public void setYouDouble(boolean doubleFlag)

Set and clear the state where You push a double to Your opponent.

Parameters:

doubleFlag - true = you have doubled

getName

public java.lang.String getName()

Return the userid that this player logged in as.

Returns:

the name

isAllowPip

public boolean isAllowPip()

Returns:

the allowPip

isAutoBoard

public boolean isAutoBoard()

Returns:

the autoBoard

setAutoBoard

public void setAutoBoard(boolean autoBoard)

Parameters:

autoBoard - the autoBoard to set

isAutoDouble

public boolean isAutoDouble()

Returns:

the autoDouble

isAutoMove

public boolean isAutoMove()

Returns:

the autoMove

isAway

public boolean isAway()

Have You tagged yourself as away?

Returns:

true if You are not accepting invitations

isBell

public boolean isBell()

Like, totally ignored.

Returns:

the bell

isCrawford

public boolean isCrawford()

Is this a crawford game?

Returns:

the crawford

isAskDouble

public boolean isAskDouble()

Does the server push dice at you or wait to see if you want to roll or double

Returns:

the askDouble

setAskDouble

public void setAskDouble(boolean askDoubles)

getExperience

public int getExperience()

How many games have You played?

Returns:

the experience

isGreedy

public boolean isGreedy()

Are You using greedy bearoffs?

Returns:

the greedy

setGreedy

public void setGreedy(boolean greedy)

isMoreBoards

public boolean isMoreBoards()

This is pretty darn useful for client programs, so if you see it toggled off you probably want to toggle it back on.

Returns:

the moreBoards

isMoves

public boolean isMoves()

Returns:

the moves

isNotify

public boolean isNotify()

Are we being notified when new users log on and off?

Returns:

the notify

getRating

public double getRating()

What is Your FIBS rating?

Returns:

the rating

isRatings

public boolean isRatings()

Returns:

the ratings

isReady

public boolean isReady()

Are you ready to play?

Returns:

the ready

setReady

public void setReady(boolean ready)

Set whether we are ready to play

Parameters:

ready - the ready to set

getRedoubles

public int getRedoubles()

Je ne comprends pas

Returns:

the redoubles

isReport

public boolean isReport()

Are we being notified about the starting and ending of other matches?

Returns:

the report

isSilent

public boolean isSilent()

Do we receive the shout messages (general chat)?
Note that BuckoFIBS always receives the shouts and filters them from display.

Returns:

the silent

getTimezone

public java.lang.String getTimezone()

Get your timezone.

Returns:

the timezone

getSavedMatchString

public java.lang.String getSavedMatchString(java.lang.String playerName)

If you have a saved match against this player, this is a tooltip string describing it.

Parameters:

playerName - The player to check for saved matches.

Returns:

A tooltip String or null if no saved match found

parseSavedMatch

public SavedMatch parseSavedMatch(java.lang.String s)

Parse a saved match line from FIBS. Store the match in our local list and return it

Parameters:

s - The string

Returns:

The parsed SavedMatch

removeSavedMatch

public void removeSavedMatch(java.lang.String playerName)

Remove a player from the savedMatches list. Call this after completing any match.

Parameters:

playerName - The name of the player you just finished a match with.

getMissMannersString

public java.lang.String getMissMannersString(java.lang.String playerName)

If MissManners issued a warning about a player, this is a tooltip string describing it.

Parameters:

playerName - The player to check for a MissManners warning.

Returns:

A tooltip String or null if no warning found

parseMissManners

public SavedMatch parseMissManners(java.lang.String s)

Parse a MissManners warning line from FIBS. Store the warning in our local list and return it

Parameters:

s - The string

Returns:

The parsed SavedMatch

parseOwnInfo

public void parseOwnInfo(java.lang.String s)

Parse the Own Info command from FIBS.

Parameters:

s - The Own Info line received from FIBS

See Also:

FIBS Client Protocol Detailed Specification

 0 1    2        3         4          5        6    7    8        9      10         11     12         13    14     15     16      17    18        19     20     21
 2 name allowpip autoboard autodouble automove away bell crawford double experience greedy moreboards moves notify rating ratings ready redoubles report silent timezone
 2 myself 1 1 0 0 0 0 1 1 2396 0 1 0 1 3457.85 0 0 0 0 0 Australia/Melbourne