Package net.minecraft.state.property

Class EnumProperty<T extends Enum<T> & StringIdentifiable>

java.lang.Object

net.minecraft.state.property.Property<T>

net.minecraft.state.property.EnumProperty<T>

Direct Known Subclasses:

DirectionProperty

public class EnumProperty<T extends Enum<T> & StringIdentifiable>
extends Property<T>

Represents a property that has enum values.

Notes on the enum class:

• The enum class is required to have 2 or more values.
• The enum class is required to provide a name for each value by overriding StringIdentifiable.asString().
• The names of the values are required to match the valid name pattern. Otherwise, IllegalArgumentException will be thrown during the validation of a property.

See Properties for example usages.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.state.property.Property

Property.Value<T extends Comparable<T>>

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,T>	byName
private ImmutableSet<T>	values

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnumProperty(String name, Class<T> type, Collection<T> values)

Method Summary

Modifier and Type	Method	Description
int	computeHashCode()
boolean	equals(Object object)
Collection<T>	getValues()	Returns all possible values of this property.
String	name(T t)	Returns the name of the given value of this property.
static <T extends Enum<T> & StringIdentifiable> EnumProperty<T>	of(String name, Class<T> type)	Creates an enum property with all values of the given enum class.
static <T extends Enum<T> & StringIdentifiable> EnumProperty<T>	of(String name, Class<T> type, Collection<T> values)	Creates an enum property with the given values.
static <T extends Enum<T> & StringIdentifiable> EnumProperty<T>	of(String name, Class<T> type, Predicate<T> filter)	Creates an enum property with the values allowed by the given filter.
static <T extends Enum<T> & StringIdentifiable> EnumProperty<T>	of(String name, Class<T> type, T[] values)	Creates an enum property with the given values.
Optional<T>	parse(String name)

Methods inherited from class net.minecraft.state.property.Property

createValue, createValue, getName, getType, getValueCodec, hashCode, stream, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

values

private final ImmutableSet<T extends Enum<T> & StringIdentifiable> values

byName

private final Map<String,T extends Enum<T> & StringIdentifiable> byName

Constructor Details

EnumProperty

protected EnumProperty(String name,
Class<T> type,
Collection<T> values)

Method Details

getValues

public Collection<T> getValues()

Returns all possible values of this property.

Specified by:

getValues in class Property<T extends Enum<T> & StringIdentifiable>

parse

public Optional<T> parse(String name)

Specified by:

parse in class Property<T extends Enum<T> & StringIdentifiable>

name

public String name(T t)

Description copied from class: Property

Returns the name of the given value of this property.

Specified by:

name in class Property<T extends Enum<T> & StringIdentifiable>

equals

public boolean equals(Object object)

Overrides:

equals in class Property<T extends Enum<T> & StringIdentifiable>

computeHashCode

public int computeHashCode()

Overrides:

computeHashCode in class Property<T extends Enum<T> & StringIdentifiable>

of

public static <T extends Enum<T> & StringIdentifiable>
EnumProperty<T> of(String name,
Class<T> type)

Creates an enum property with all values of the given enum class.

See notes on the enum class.

Parameters:

name - the name of the property; see the note on the name

type - the type of the values the property contains

Throws:

IllegalArgumentException - if multiple values have the same name

of

public static <T extends Enum<T> & StringIdentifiable>
EnumProperty<T> of(String name,
Class<T> type,
Predicate<T> filter)

Creates an enum property with the values allowed by the given filter.

See notes on the enum class.

Parameters:

name - the name of the property; see the note on the name

type - the type of the values the property contains

filter - the filter which specifies if a value is allowed; required to allow 2 or more values

Throws:

IllegalArgumentException - if multiple values have the same name

See Also:

of(String, Class)

of

public static <T extends Enum<T> & StringIdentifiable>
EnumProperty<T> of(String name,
Class<T> type,
T[] values)

Creates an enum property with the given values.

See notes on the enum class.

Parameters:

name - the name of the property; see the note on the name

type - the type of the values the property contains

values - the values the property contains; required to have 2 or more values

Throws:

IllegalArgumentException - if multiple values have the same name

See Also:

of(String, Class)

of

public static <T extends Enum<T> & StringIdentifiable>
EnumProperty<T> of(String name,
Class<T> type,
Collection<T> values)

Creates an enum property with the given values.

See notes on the enum class.

Parameters:

name - the name of the property; see the note on the name

type - the type of the values the property contains

values - the values the property contains; required to have 2 or more values

Throws:

IllegalArgumentException - if multiple values have the same name

See Also:

of(String, Class)