Package net.darkhax.bookshelf.common.api.text.format

Enum Class PropertyFormat

java.lang.Object

java.lang.Enum<PropertyFormat>

net.darkhax.bookshelf.common.api.text.format.PropertyFormat

All Implemented Interfaces:

Serializable, Comparable<PropertyFormat>, Constable, IPropertyFormat

public enum PropertyFormat
extends Enum<PropertyFormat>
implements IPropertyFormat

Formats a property string using various separator patterns.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTER	Formats a property with the separator aligned in the center.
LEFT	Formats a property with the separator aligned to the left.
NONE	Formats a property without a separator.
RIGHT	Formats a property with the separator aligned to the right.
SPACED	Formats a property using a single space as the separator.

Method Summary

Modifier and Type	Method	Description
net.minecraft.resources.ResourceLocation	formatKey()	A namespaced identifier that is used to derive localization keys for the format.
static PropertyFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyFormat[]	values()	Returns an array containing the constants of this enum class, 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

Methods inherited from interface net.darkhax.bookshelf.common.api.text.format.IPropertyFormat

format

Enum Constant Details

RIGHT

public static final PropertyFormat RIGHT

Formats a property with the separator aligned to the right. Example: "property: value".

CENTER

public static final PropertyFormat CENTER

Formats a property with the separator aligned in the center. Example: "property : value".

LEFT

public static final PropertyFormat LEFT

Formats a property with the separator aligned to the left. Example: "property :value".

SPACED

public static final PropertyFormat SPACED

Formats a property using a single space as the separator. Example: "property value".

NONE

public static final PropertyFormat NONE

Formats a property without a separator. Example: "propertyvalue".

Method Details

values

public static PropertyFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PropertyFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

formatKey

public net.minecraft.resources.ResourceLocation formatKey()

Description copied from interface: IPropertyFormat

A namespaced identifier that is used to derive localization keys for the format.

Specified by:

formatKey in interface IPropertyFormat

Returns:

The namespace ID for the format.