net.tridentsdk.base.board

Enum BoardType

java.lang.Object

java.lang.Enum<BoardType>

net.tridentsdk.base.board.BoardType

All Implemented Interfaces:

Serializable, Comparable<BoardType>

public enum BoardType
extends Enum<BoardType>

The type of board, also where it is displayed

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
BELOW_NAME
LIST
SIDEBAR

Method Summary

Modifier and Type	Method and Description
byte	asByte() Returns the byte value of the BoardType
static BoardType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoardType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LIST

public static final BoardType LIST

SIDEBAR

public static final BoardType SIDEBAR

BELOW_NAME

public static final BoardType BELOW_NAME

Method Detail

values

public static BoardType[] 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 (BoardType c : BoardType.values())
    System.out.println(c);

Returns:

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

valueOf

public static BoardType 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

asByte

public byte asByte()

Returns the byte value of the BoardType

Returns:

byte value of the BoardType