org.bukkit
Enum CoalType

java.lang.Object
  java.lang.Enum<CoalType>
      org.bukkit.CoalType

All Implemented Interfaces:

Serializable, Comparable<CoalType>

public enum CoalType
extends Enum<CoalType>

Represents the two types of coal

Enum Constant Summary

CHARCOAL

COAL

Method Summary

static CoalType	getByData(byte data) Gets the type of coal with the given data value
byte	getData() Gets the associated data value representing this type of coal
static CoalType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CoalType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COAL

public static final CoalType COAL

CHARCOAL

public static final CoalType CHARCOAL

Method Detail

values

public static final CoalType[] values()

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

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

Returns:

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

valueOf

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

getData

public byte getData()

Gets the associated data value representing this type of coal

Returns:

A byte containing the data value of this coal type

getByData

public static CoalType getByData(byte data)

Gets the type of coal with the given data value

Parameters:

data - Data value to fetch

Returns:

The CoalType representing the given value, or null if it doesn't exist