Enum DiceType

java.lang.Object

java.lang.Enum<DiceType>

DiceType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DiceType>

public enum DiceType
extends java.lang.Enum<DiceType>

Enumeration representing different types of dice. Ranges from D4 to D20. NOTE: the enum type will automatically add the following methods:

• static DiceType valueOf(java.lang.String name)
• static DiceType[] values()

Even though they show up in the javadoc, you don't need to implement them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
D10 a 10 sided die
D12 a 12 sided die
D20 a 20 sided die
D4 a 4 sided die
D6 a 6 sided die
D8 a 8 sided die

Method Summary

Modifier and Type	Method and Description
static DiceType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DiceType[]	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

D4

public static final DiceType D4

a 4 sided die

D6

public static final DiceType D6

a 6 sided die

D8

public static final DiceType D8

a 8 sided die

D10

public static final DiceType D10

a 10 sided die

D12

public static final DiceType D12

a 12 sided die

D20

public static final DiceType D20

a 20 sided die

Method Detail

values

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

Returns:

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

valueOf

public static DiceType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null