Package net.kyori.adventure.bossbar

Enum BossBar.Overlay

java.lang.Object

java.lang.Enum<BossBar.Overlay>

net.kyori.adventure.bossbar.BossBar.Overlay

All Implemented Interfaces:

Serializable, Comparable<BossBar.Overlay>

Enclosing interface:

BossBar

public static enum BossBar.Overlay
extends Enum<BossBar.Overlay>

An overlay on the bar component of a boss bar.

Since:

4.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOTCHED_10	A bar with 10 notches.
NOTCHED_12	A bar with 12 notches.
NOTCHED_20	A bar with 20 notches.
NOTCHED_6	A bar with 6 notches.
PROGRESS	A progress bar.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BossBar.Overlay	valueOf(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 Details

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

NOTCHED_10

public static final BossBar.Overlay NOTCHED_10

A bar with 10 notches.

Since:

4.0.0

NOTCHED_12

public static final BossBar.Overlay NOTCHED_12

A bar with 12 notches.

Since:

4.0.0

NOTCHED_20

public static final BossBar.Overlay NOTCHED_20

A bar with 20 notches.

Since:

4.0.0

Field Details

NAMES

public static final Index<String,BossBar.Overlay> NAMES

The name map.

Since:

4.0.0

Method Details

values

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