org.spongepowered.api.data

Interface Property<K,V>

Type Parameters:

K - The key of the property

V - The type of the value of the property

All Superinterfaces:

Comparable<Property<?,?>>

All Known Subinterfaces:

InventoryProperty<K,V>

All Known Implementing Classes:

AbstractInventoryProperty, AbstractProperty, AcceptsItems, ApplicableEffectProperty, ArmorSlotType, ArmorTypeProperty, BlastResistanceProperty, BooleanProperty, BurningFuelProperty, CollectiveProperty, DamageAbsorptionProperty, DisplacementProperty, DominantHandProperty, DoubleProperty, EfficiencyProperty, EquipmentProperty, EquipmentSlotType, EyeHeightProperty, EyeLocationProperty, FlammableProperty, FluidTemperatureProperty, FluidViscosityProperty, FoodRestorationProperty, FullBlockSelectionBoxProperty, GravityAffectedProperty, GroundLuminanceProperty, GuiIdProperty, HardnessProperty, HarvestingProperty, HeldItemProperty, Identifiable, IndirectlyPoweredProperty, InstrumentProperty, IntProperty, IntProperty, InventoryCapacity, InventoryDimension, InventoryTitle, LightEmissionProperty, MappedIntProperty, MatterProperty, PassableProperty, PoweredProperty, RecordProperty, ReplaceableProperty, SaturationProperty, SkyLuminanceProperty, SlotIndex, SlotPos, SlotSide, SmeltableProperty, SolidCubeProperty, StatisticsTrackedProperty, StringProperty, SurrogateBlockProperty, TemperatureProperty, ToolTypeProperty, UnbreakableProperty, UseLimitProperty

public interface Property<K,V>
extends Comparable<Property<?,?>>

Base interface for immutable properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Property.Operator Operator used to indicate to a query what operation to use when comparing this property with properties present on an item stack.

Method Summary

Modifier and Type	Method and Description
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.
boolean	matches(Property<?,?> other) Compares this property to other using this property's operator.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getKey

K getKey()

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.

Returns:

the key for this property

getValue

@Nullable
V getValue()

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

Returns:

the value of this property

getOperator

Property.Operator getOperator()

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

Returns:

the operator to use when comparing another property with this property

matches

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

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.

Parameters:

other - Property to compare to

Returns:

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