wwwordz.game

Class Round

java.lang.Object

wwwordz.game.Round

public class Round
extends java.lang.Object

A round has 4 sequential stages

1. join - client join the round
2. play - client retrieves puzzle and player solve puzzle
3. report - clients report points back to server
4. ranking - clients ask for rankings

Each stage has a specific duration and the round method can only be executed within a limited time frame. The duration of each stage can be checked or changed with static setters and getters. The following method should be executed in the associated stages.

1. register() - join
2. getPuzzle() - play
3. setPoints() - register
4. getRanking() - ranking

When executed outside their stages these methods raise a WWWordzException.

Author:

José Paulo Leal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Round.Relative
(package private) static class	Round.Stage

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Date	end
(package private) java.util.Date	join
(package private) java.util.Date	play
(package private) Puzzle	puzzle
(package private) java.util.Date	ranking
(package private) java.util.Date	report
(package private) java.util.Map<java.lang.String,Player>	roundPlayers

Constructor Summary

Constructors

Constructor and Description
Round()

Method Summary

Modifier and Type	Method and Description
static long	getJoinStageDuration() Duration of join stage in milliseconds
static long	getPlayStageDuration() Duration of play stage in milliseconds
Puzzle	getPuzzle() Get table of this round
java.util.List<Rank>	getRanking() List of players in this round sorted by points
static long	getRankingStageSuration() Duration of ranking stage in milliseconds
static long	getReportStageDuration() Duration of report stage in milliseconds
static long	getRoundDuration() Complete duration of a round (all stages)
long	getTimetoNextPlay() Time in milliseconds to the next play stage.
long	register(java.lang.String nick, java.lang.String password) Register user with nick and password for this round
static void	setJoinStageDuration(long joinStageDuration) Change join stage
static void	setPlayStageDuration(long playStageDuration) Change play stage
void	setPoints(java.lang.String nick, int points) Set number of points obtained by user in this round
static void	setRankingStageSuration(long rankingStageDuration) Change ranking stage
static void	setReportStageDuration(long reportStageDuration) Change report stage

Methods inherited from class java.lang.Object

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

Field Detail

join

java.util.Date join

play

java.util.Date play

report

java.util.Date report

ranking

java.util.Date ranking

end

java.util.Date end

roundPlayers

java.util.Map<java.lang.String,Player> roundPlayers

puzzle

Puzzle puzzle

Constructor Detail

Round

public Round()

Method Detail

getJoinStageDuration

public static long getJoinStageDuration()

Duration of join stage in milliseconds

Returns:

join duration in milliseconds

setJoinStageDuration

public static void setJoinStageDuration(long joinStageDuration)

Change join stage

Parameters:

joinStageDuration - in milliseconds

getPlayStageDuration

public static long getPlayStageDuration()

Duration of play stage in milliseconds

Returns:

play duration in milliseconds

setPlayStageDuration

public static void setPlayStageDuration(long playStageDuration)

Change play stage

Parameters:

playStageDuration - in milliseconds

getReportStageDuration

public static long getReportStageDuration()

Duration of report stage in milliseconds

Returns:

report stage duration in milliseconds

setReportStageDuration

public static void setReportStageDuration(long reportStageDuration)

Change report stage

Parameters:

reportStageDuration - in milliseconds

getRankingStageSuration

public static long getRankingStageSuration()

Duration of ranking stage in milliseconds

Returns:

ranking duration in milliseconds

setRankingStageSuration

public static void setRankingStageSuration(long rankingStageDuration)

Change ranking stage

Parameters:

rankingStageDuration - in milliseconds

getRoundDuration

public static long getRoundDuration()

Complete duration of a round (all stages)

Returns:

duration of a round

getTimetoNextPlay

public long getTimetoNextPlay()

Time in milliseconds to the next play stage. If the play stage of this round has already started then the time returned refers to the next round.

Returns:

time in milliseconds

register

public long register(java.lang.String nick,
                     java.lang.String password)
              throws WWWordzException

Register user with nick and password for this round

Parameters:

nick - of registered user

password - of registered user

Returns:

time in milliseconds for next round

Throws:

WWWordzException - if not it join stage or user is invalid

getPuzzle

public Puzzle getPuzzle()
                 throws WWWordzException

Get table of this round

Returns:

table

Throws:

WWWordzException - if not in play stage

setPoints

public void setPoints(java.lang.String nick,
                      int points)
               throws WWWordzException

Set number of points obtained by user in this round

Parameters:

nick - of user with changed points

points - to set to user

Throws:

WWWordzException - if not in report stage

getRanking

public java.util.List<Rank> getRanking()
                                throws WWWordzException

List of players in this round sorted by points

Returns:

list or ranks

Throws:

WWWordzException - if not in ranking stage