Package org.bitbrawl.foodfight.field

Enum MatchType

java.lang.Object

java.lang.Enum<MatchType>

org.bitbrawl.foodfight.field.MatchType

All Implemented Interfaces:

Serializable, Comparable<MatchType>

public enum MatchType
extends Enum<MatchType>

A type of match. There are three types of matches, and each match is of one of the three types.

Author:

Finn

Enum Constant Summary

Enum Constants

Enum Constant	Description
DUEL	A 1v1 duel between two players.
FREE_FOR_ALL	A 1v1v1 free-for-all between three players.
TEAM	A 2v2 team match for four players.

Method Summary

Modifier and Type	Method	Description
static MatchType	byNumberOfPlayers(int numPlayers)	Returns the match type that has the given number of players.
int	getNumberOfPlayers()	Returns the total number of players in matches of this type.
int	getNumberOfTeams()	Returns the number of teams in matches of this type.
String	toString()	Returns a human-readable name for this match type, either "Duel", "Free-for-all", or "Team".
static MatchType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatchType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DUEL

public static final MatchType DUEL

A 1v1 duel between two players.

FREE_FOR_ALL

public static final MatchType FREE_FOR_ALL

A 1v1v1 free-for-all between three players.

TEAM

public static final MatchType TEAM

A 2v2 team match for four players.

Method Detail

values

public static MatchType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatchType c : MatchType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatchType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns a human-readable name for this match type, either "Duel", "Free-for-all", or "Team". This is primarily intended for debugging purposes.

Overrides:

toString in class Enum<MatchType>

Returns:

a human-readable name for this match type

getNumberOfTeams

public int getNumberOfTeams()

Returns the number of teams in matches of this type. For duels and team matches, this will be 2, and for free-for-alls, this will be 3.

Returns:

the number of teams in this match type

getNumberOfPlayers

public int getNumberOfPlayers()

Returns the total number of players in matches of this type. For duels, this will be 2, for free-for-alls, this will be 3, and for team matches, this will be 4.

Returns:

the total number of players in this match type

byNumberOfPlayers

public static MatchType byNumberOfPlayers(int numPlayers)

Returns the match type that has the given number of players. In other words, getNumberOfPlayers() will return numPlayers for the returned match type.

Parameters:

numPlayers - the number of players in the desired match type

Returns:

the match type with the desired number of players

Throws:

IllegalArgumentException - if numPlayers is not 2, 3, or 4