Package net.kyori.adventure.bossbar

Enum BossBar.Overlay

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BossBar.Overlay>
    Enclosing interface:
    BossBar
    public static enum BossBar.Overlay
extends java.lang.Enum<BossBar.Overlay>
    An overlay on the bar component of a bossbar.
    Since:
    4.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Index<java.lang.String,​BossBar.Overlay> NAMES
      The name map.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BossBar.Overlay valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BossBar.Overlay[] 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

      • PROGRESS

        public static final BossBar.Overlay PROGRESS
        A progress bar.
        Since:
        4.0.0

      • NOTCHED_6

        public static final BossBar.Overlay NOTCHED_6
        A bar with 6 notches.
        Since:
        4.0.0
        Since Minecraft:
        1.9

      • NOTCHED_10

        public static final BossBar.Overlay NOTCHED_10
        A bar with 10 notches.
        Since:
        4.0.0
        Since Minecraft:
        1.9

      • NOTCHED_12

        public static final BossBar.Overlay NOTCHED_12
        A bar with 12 notches.
        Since:
        4.0.0
        Since Minecraft:
        1.9

      • NOTCHED_20

        public static final BossBar.Overlay NOTCHED_20
        A bar with 20 notches.
        Since:
        4.0.0
        Since Minecraft:
        1.9

    • Field Detail

      • NAMES

        public static final Index<java.lang.String,​BossBar.Overlay> NAMES
        The name map.
        Since:
        4.0.0

    • Method Detail

      • values

        public static BossBar.Overlay[] 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 (BossBar.Overlay c : BossBar.Overlay.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BossBar.Overlay 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