Module org.cloudburstmc.api

Package org.cloudburstmc.api.item.data

Enum Class Coal

java.lang.Object

java.lang.Enum<Coal>

org.cloudburstmc.api.item.data.Coal

All Implemented Interfaces:

Serializable, Comparable<Coal>, Constable

public enum Coal
extends Enum<Coal>

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
CHARCOAL	Represents a charcoal item.
REGULAR	Represents a regular coal item.

Method Summary

Modifier and Type	Method	Description
boolean	isCharcoal()	Returns whether or not this item is charcoal.
String	toString()
static Coal	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Coal[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REGULAR

public static final Coal REGULAR

Represents a regular coal item.

CHARCOAL

public static final Coal CHARCOAL

Represents a charcoal item.

Method Details

values

public static Coal[] 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 Coal 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

isCharcoal

public final boolean isCharcoal()

Returns whether or not this item is charcoal.

Returns:

whether or not this item is charcoal

toString

public final String toString()

Overrides:

toString in class Enum<Coal>