org.spongepowered.api.item.inventory.property

Class StringProperty

java.lang.Object

org.spongepowered.api.item.inventory.property.AbstractInventoryProperty<String,String>

org.spongepowered.api.item.inventory.property.StringProperty

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,String>, InventoryProperty<String,String>

public class StringProperty
extends AbstractInventoryProperty<String,String>

A generic String property for an inventory.

Nested Class Summary

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

Property.Operator

Field Summary

Fields inherited from class org.spongepowered.api.item.inventory.property.AbstractInventoryProperty

operator, value

Constructor Summary

Constructors

Constructor and Description
StringProperty(Object value, Property.Operator operator) Create a new StringProperty for matching the specified value with the specified operator.
StringProperty(String value) Create a new StringProperty for matching the specified value.
StringProperty(String value, Property.Operator operator) Create a new StringProperty for matching the specified value with the specified operator.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property<?,?> other)
static StringProperty	greaterThan(Object value) Create a StringProperty which matches StringProperty properties with value greater than this value.
static StringProperty	greaterThanOrEqual(Object value) Create a StringProperty which matches StringProperty properties with value greater than or equal to this value.
static StringProperty	lessThan(Object value) Create a StringProperty which matches StringProperty properties with value less than this value.
static StringProperty	lessThanOrEqual(Object value) Create a StringProperty which matches StringProperty properties with value less than or equal to this value.
static StringProperty	not(Object value) Create a StringProperty which matches StringProperty properties with unequal value.
static StringProperty	of(Object value) Create a StringProperty which matches StringProperty properties with equal value.

Methods inherited from class org.spongepowered.api.item.inventory.property.AbstractInventoryProperty

equals, getDefaultKey, getDefaultKey, getDefaultOperator, getKey, getOperator, getValue, hashCode, hashCodeOf, matches

Methods inherited from class java.lang.Object

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

Constructor Detail

StringProperty

public StringProperty(String value)

Create a new StringProperty for matching the specified value.

Parameters:

value - the value to match

StringProperty

public StringProperty(String value,
                      Property.Operator operator)

Create a new StringProperty for matching the specified value with the specified operator.

Parameters:

value - the value to match

operator - the operator to use when comparing with other properties

StringProperty

public StringProperty(Object value,
                      Property.Operator operator)

Create a new StringProperty for matching the specified value with the specified operator.

Parameters:

value - the value to match

operator - the operator to use when comparing with other properties

Method Detail

compareTo

public int compareTo(Property<?,?> other)

of

public static StringProperty of(Object value)

Create a StringProperty which matches StringProperty properties with equal value.

Parameters:

value - the value to match

Returns:

new property

not

public static StringProperty not(Object value)

Create a StringProperty which matches StringProperty properties with unequal value.

Parameters:

value - the value to match

Returns:

new property

greaterThan

public static StringProperty greaterThan(Object value)

Create a StringProperty which matches StringProperty properties with value greater than this value.

Parameters:

value - the value to match

Returns:

new property

greaterThanOrEqual

public static StringProperty greaterThanOrEqual(Object value)

Create a StringProperty which matches StringProperty properties with value greater than or equal to this value.

Parameters:

value - the value to match

Returns:

new property

lessThan

public static StringProperty lessThan(Object value)

Create a StringProperty which matches StringProperty properties with value less than this value.

Parameters:

value - the value to match

Returns:

new property

lessThanOrEqual

public static StringProperty lessThanOrEqual(Object value)

Create a StringProperty which matches StringProperty properties with value less than or equal to this value.

Parameters:

value - the value to match

Returns:

new property