Package com.booksaw.betterTeams

Enum Class PlayerRank

java.lang.Object

java.lang.Enum<PlayerRank>

com.booksaw.betterTeams.PlayerRank

All Implemented Interfaces:

Serializable, Comparable<PlayerRank>, Constable

public enum PlayerRank
extends Enum<PlayerRank>

This class is used to define all the possible ranks that a player can be within a team

Author:

booksaw

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN	This player has permissions to invite new players to the team and kick default users, but cannot ban people or change team settings
DEFAULT	The starting rank with the lowest number of permissions
OWNER	The highest rank, this rank has full permissions over the team

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

Modifier and Type	Method	Description
String	getPrefix()
static PlayerRank	getRank(int value)
static PlayerRank	getRank(String string)
static PlayerRank	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerRank[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final PlayerRank DEFAULT

The starting rank with the lowest number of permissions

OWNER

public static final PlayerRank OWNER

The highest rank, this rank has full permissions over the team

ADMIN

public static final PlayerRank ADMIN

This player has permissions to invite new players to the team and kick default users, but cannot ban people or change team settings

Field Details

value

public final int value

Method Details

values

public static PlayerRank[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PlayerRank valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getRank

public static PlayerRank getRank(String string)

getRank

public static PlayerRank getRank(int value)

getPrefix

public String getPrefix()

Returns:

the prefix for that player rank