org.spongepowered.api.item.inventory.property

Class AbstractInventoryProperty<K,V>

java.lang.Object

org.spongepowered.api.item.inventory.property.AbstractInventoryProperty<K,V>

Type Parameters:

K - Key type, use String if no particular key type is required

V - Value type

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<K,V>, InventoryProperty<K,V>

Direct Known Subclasses:

AcceptsItems, EquipmentSlotType, GuiIdProperty, Identifiable, IntProperty, InventoryDimension, InventoryTitle, MappedIntProperty, SlotPos, SlotSide, StringProperty

public abstract class AbstractInventoryProperty<K,V>
extends Object
implements InventoryProperty<K,V>

Base class for InventoryProperty implementations which stubs out all of the common boilerplate functionality.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.Property

Property.Operator

Field Summary

Fields

Modifier and Type	Field and Description
protected Property.Operator	operator Operator for comparing to other properties.
protected V	value The value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInventoryProperty() Initialise internal values to defaults, use this ctor if you plan to override getKey() and getValue() yourself.
protected	AbstractInventoryProperty(K key, V value) Use the specified key and value and set operator to the default.
protected	AbstractInventoryProperty(K key, V value, Property.Operator op)
protected	AbstractInventoryProperty(V value) Initialise key to default, and value to the supplied value.
protected	AbstractInventoryProperty(V value, Property.Operator op) Initialise the value to the specified value and use the specified operator, use the default key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static <T extends InventoryProperty<?,?>> Object	getDefaultKey(Class<T> clazz) Gets the default key for the provided InventoryProperty class.
protected K	getDefaultKey(V value) Gets the default value for key, used in case null is passed in (since we can't have a null key).
protected Property.Operator	getDefaultOperator(K key, V value) Return the default operator to use, based on the supplied key and value.
K	getKey() Gets the key for this property.
Property.Operator	getOperator() Gets the operator to use when comparing another property with this property.
V	getValue() Gets the "value" of this property.
int	hashCode()
protected int	hashCodeOf(Object value) Convenience method to avoid null-checking.
boolean	matches(Property<?,?> other) Compares this property to other using this property's operator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

operator

protected final Property.Operator operator

Operator for comparing to other properties. Operators should always be applied by consumers in a <this> <OPERATOR> <other> pattern

value

protected V value

The value.

Constructor Detail

AbstractInventoryProperty

protected AbstractInventoryProperty()

Initialise internal values to defaults, use this ctor if you plan to override getKey() and getValue() yourself.

AbstractInventoryProperty

protected AbstractInventoryProperty(@Nullable
                                    V value)

Initialise key to default, and value to the supplied value.

Parameters:

value - The value of the property

AbstractInventoryProperty

protected AbstractInventoryProperty(@Nullable
                                    V value,
                                    Property.Operator op)

Initialise the value to the specified value and use the specified operator, use the default key.

Parameters:

value - The property value

op - The operator for the property

AbstractInventoryProperty

protected AbstractInventoryProperty(@Nullable
                                    K key,
                                    @Nullable
                                    V value)

Use the specified key and value and set operator to the default.

Parameters:

key - The key identifying the property

value - The property value

AbstractInventoryProperty

protected AbstractInventoryProperty(@Nullable
                                    K key,
                                    @Nullable
                                    V value,
                                    Property.Operator op)

Method Detail

getDefaultKey

protected K getDefaultKey(@Nullable
                          V value)

Gets the default value for key, used in case null is passed in (since we can't have a null key). In general this should return the class name of the property itself but subclasses are free to alter this behaviour if they wish.

Parameters:

value - Value passed in to the ctor, supplied in case a subclass wants to return a specific default key based on the value

Returns:

default key to use. Must not be null!

getDefaultKey

public static <T extends InventoryProperty<?,?>> Object getDefaultKey(Class<T> clazz)

Gets the default key for the provided InventoryProperty class.

Type Parameters:

T - The InventoryProperty type.

Parameters:

clazz - The InventoryProperty class.

Returns:

default key to use.

getDefaultOperator

protected Property.Operator getDefaultOperator(K key,
                                               @Nullable
                                               V value)

Return the default operator to use, based on the supplied key and value.

Parameters:

key - Property key

value - Property initial value, may be null

Returns:

operator to use

getKey

public K getKey()

Description copied from interface: Property

Gets the key for this property. Key is only used if an item stack can have more than one property of a particular type. If the property has no specific key, the property class name is returned so that properties of the same type are implicitly comparable.

Specified by:

getKey in interface Property<K,V>

Returns:

the key for this property

getValue

public V getValue()

Description copied from interface: Property

Gets the "value" of this property. "Value" may have different meanings depending on the exact type of this property.

Specified by:

getValue in interface Property<K,V>

Returns:

the value of this property

getOperator

public Property.Operator getOperator()

Description copied from interface: Property

Gets the operator to use when comparing another property with this property.

Specified by:

getOperator in interface Property<K,V>

Returns:

the operator to use when comparing another property with this property

matches

public boolean matches(@Nullable
                       Property<?,?> other)

Description copied from interface: Property

Compares this property to other using this property's operator. This is equivalent to the code:

thisObject.getOperator().compare(thisObject, other);

The order of the operands is important, since Property.Operator treats its type as infix between the two operands, and thus (for example) if this property's operator is set to GREATER, then when calling this method we want to know whether this is GREATER than other and must pass in the operands in the corresponding order.

Specified by:

matches in interface Property<K,V>

Parameters:

other - Property to compare to

Returns:

true if the other property matches this one according to the rules defined by this property's Property.getOperator()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hashCodeOf

protected int hashCodeOf(Object value)

Convenience method to avoid null-checking. Returns 0 if value is null.

Parameters:

value - The value to get the hashcode of

Returns:

The hashcode value