Package org.bukkit

Enum TreeSpecies

java.lang.Object
java.lang.Enum<TreeSpecies>
org.bukkit.TreeSpecies
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TreeSpecies>, java.lang.constant.Constable

public enum TreeSpecies
extends java.lang.Enum<TreeSpecies>
Represents the different species of trees regardless of size.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ACACIA
    Represents acacia trees.
    BIRCH
    Represents birches.
    DARK_OAK
    Represents dark oak trees.
    GENERIC
    Represents the common tree species.
    JUNGLE
    Represents jungle trees.
    REDWOOD
    Represents the darker barked/leaved tree species.
  • Method Summary

    Modifier and Type Method Description
    static TreeSpecies getByData​(byte data)
    Deprecated.
    Magic value
    byte getData()
    Deprecated.
    Magic value
    static TreeSpecies valueOf​(java.lang.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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

  • Method Details

    • values

      public static TreeSpecies[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

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