Package org.bukkit

Enum DyeColor

All Implemented Interfaces:
Serializable, Comparable<DyeColor>, Constable

public enum DyeColor
extends Enum<DyeColor>
All supported color values for dyes and cloth
  • Enum Constant Details

  • Method Details

    • values

      public static DyeColor[] 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 DyeColor 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
    • getWoolData

      @Deprecated public byte getWoolData()
      Deprecated.
      Magic value
      Gets the associated wool data value representing this color.
      Returns:
      A byte containing the wool data value of this color
      See Also:
      getDyeData()
    • getDyeData

      @Deprecated public byte getDyeData()
      Deprecated.
      Magic value
      Gets the associated dye data value representing this color.
      Returns:
      A byte containing the dye data value of this color
      See Also:
      getWoolData()
    • getColor

      @NotNull public Color getColor()
      Gets the color that this dye represents.
      Returns:
      The Color that this dye represents
    • getFireworkColor

      @NotNull public Color getFireworkColor()
      Gets the firework color that this dye represents.
      Returns:
      The Color that this dye represents
    • getByWoolData

      @Deprecated @Nullable public static DyeColor getByWoolData​(byte data)
      Deprecated.
      Magic value
      Gets the DyeColor with the given wool data value.
      Parameters:
      data - Wool data value to fetch
      Returns:
      The DyeColor representing the given value, or null if it doesn't exist
      See Also:
      getByDyeData(byte)
    • getByDyeData

      @Deprecated @Nullable public static DyeColor getByDyeData​(byte data)
      Deprecated.
      Magic value
      Gets the DyeColor with the given dye data value.
      Parameters:
      data - Dye data value to fetch
      Returns:
      The DyeColor representing the given value, or null if it doesn't exist
      See Also:
      getByWoolData(byte)
    • getByColor

      @Nullable public static DyeColor getByColor​(@NotNull Color color)
      Gets the DyeColor with the given color value.
      Parameters:
      color - Color value to get the dye by
      Returns:
      The DyeColor representing the given value, or null if it doesn't exist
    • getByFireworkColor

      @Nullable public static DyeColor getByFireworkColor​(@NotNull Color color)
      Gets the DyeColor with the given firework color value.
      Parameters:
      color - Color value to get dye by
      Returns:
      The DyeColor representing the given value, or null if it doesn't exist
    • legacyValueOf

      @Deprecated @NotNull public static DyeColor legacyValueOf​(@Nullable String name)
      Deprecated.
      legacy use only
      Gets the DyeColor for the given name, possibly doing legacy transformations.
      Parameters:
      name - dye name
      Returns:
      dye color