org.bukkit
Enum TreeSpecies

java.lang.Object
  extended by java.lang.Enum<TreeSpecies>
      extended by org.bukkit.TreeSpecies
All Implemented Interfaces:
Serializable, Comparable<TreeSpecies>

public enum TreeSpecies
extends Enum<TreeSpecies>

Represents the different species of trees regardless of size.


Enum Constant Summary
BIRCH
          Represents birches.
GENERIC
          Represents the common tree species.
JUNGLE
          Represents jungle trees.
REDWOOD
          Represents the darker barked/leaved tree species.
 
Method Summary
static TreeSpecies getByData(byte data)
          Deprecated. Magic value
 byte getData()
          Deprecated. Magic value
static TreeSpecies valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TreeSpecies[] 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

GENERIC

public static final TreeSpecies GENERIC
Represents the common tree species.


REDWOOD

public static final TreeSpecies REDWOOD
Represents the darker barked/leaved tree species.


BIRCH

public static final TreeSpecies BIRCH
Represents birches.


JUNGLE

public static final TreeSpecies JUNGLE
Represents jungle trees.

Method Detail

values

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

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

valueOf

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

getData

@Deprecated
public byte getData()
Deprecated. Magic value

Gets the associated data value representing this species

Returns:
A byte containing the data value of this tree species

getByData

@Deprecated
public static TreeSpecies getByData(byte data)
Deprecated. Magic value

Gets the TreeSpecies with the given data value

Parameters:
data - Data value to fetch
Returns:
The TreeSpecies representing the given value, or null if it doesn't exist


Copyright © 2014. All rights reserved.