Package net.md_5.bungee.api.chat

Enum ComponentBuilder.FormatRetention

java.lang.Object

java.lang.Enum<ComponentBuilder.FormatRetention>

net.md_5.bungee.api.chat.ComponentBuilder.FormatRetention

All Implemented Interfaces:

Serializable, Comparable<ComponentBuilder.FormatRetention>

Enclosing class:

ComponentBuilder

public static enum ComponentBuilder.FormatRetention
extends Enum<ComponentBuilder.FormatRetention>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Specify that we want to retain everything from the previous component.
EVENTS	Specify that we want the events retained from the previous component.
FORMATTING	Specify that we want the formatting retained from the previous component.
NONE	Specify that we do not want to retain anything from the previous component.

Method Summary

Modifier and Type	Method	Description
static ComponentBuilder.FormatRetention	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ComponentBuilder.FormatRetention[]	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

NONE

public static final ComponentBuilder.FormatRetention NONE

Specify that we do not want to retain anything from the previous component.

FORMATTING

public static final ComponentBuilder.FormatRetention FORMATTING

Specify that we want the formatting retained from the previous component.

EVENTS

public static final ComponentBuilder.FormatRetention EVENTS

Specify that we want the events retained from the previous component.

ALL

public static final ComponentBuilder.FormatRetention ALL

Specify that we want to retain everything from the previous component.

Method Detail

values

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

Returns:

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

valueOf

public static ComponentBuilder.FormatRetention 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