org.spongepowered.api.item.inventory.property

Class AcceptsItems

java.lang.Object

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

org.spongepowered.api.item.inventory.property.AcceptsItems

All Implemented Interfaces:

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

public class AcceptsItems
extends AbstractInventoryProperty<String,Collection<ItemType>>

A property type intended for use with InputSlots in order to query for slots which can accept items of the specified type. It is intended that the semantics of the equals(java.lang.Object) will be such that the method will return true if the other property contains any item present in this property's collection.

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
AcceptsItems(Collection<ItemType> value) Create a new AcceptsItems property with the supplied value.
AcceptsItems(Collection<ItemType> value, Property.Operator operator) Create a new AcceptsItems property with the supplied value and operator.
AcceptsItems(Object value, Property.Operator operator) Create a new AcceptsItems property with the supplied value and operator.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property<?,?> other)
boolean	equals(Object obj) Returns true if other is also an AcceptsItems property and any item appearing in the other property's collection appears in this property's collection.
static AcceptsItems	of(Object... value) Create an AcceptsItems property which matches AcceptsItems properties with containing one or more of the supplied values.

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

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

AcceptsItems

public AcceptsItems(Collection<ItemType> value)

Create a new AcceptsItems property with the supplied value.

Parameters:

value - Item types to accept

AcceptsItems

public AcceptsItems(Collection<ItemType> value,
                    Property.Operator operator)

Create a new AcceptsItems property with the supplied value and operator.

Parameters:

value - Item types to accept

operator - Logical operator to apply when comparing with other properties

AcceptsItems

public AcceptsItems(Object value,
                    Property.Operator operator)

Create a new AcceptsItems property with the supplied value and operator.

Parameters:

value - Item types to accept

operator - Logical operator to apply when comparing with other properties

Method Detail

compareTo

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

equals

public boolean equals(Object obj)

Returns true if other is also an AcceptsItems property and any item appearing in the other property's collection appears in this property's collection. In formal terms, the method returns true if the size of the intersection between the two item type collections is greater than zero.

Overrides:

equals in class AbstractInventoryProperty<String,Collection<ItemType>>

of

public static AcceptsItems of(Object... value)

Create an AcceptsItems property which matches AcceptsItems properties with containing one or more of the supplied values.

Parameters:

value - ItemTypes to accept

Returns:

new property