com.comphenix.xp.lookup

Class ItemQuery

java.lang.Object

com.comphenix.xp.lookup.ItemQuery

All Implemented Interfaces:

Query

public class ItemQuery
extends java.lang.Object
implements Query

Generic immutable representation of an item/block query.

Author:

Kristian

Nested Class Summary

Nested classes/interfaces inherited from interface com.comphenix.xp.lookup.Query

Query.Types

Constructor Summary

Constructors

Constructor and Description
ItemQuery(java.util.List<java.lang.Integer> itemID, java.util.List<java.lang.Integer> durability) Constructs a query with the given IDs and durabilities.
ItemQuery(java.util.List<java.lang.Integer> itemID, java.util.List<java.lang.Integer> durability, java.util.List<java.lang.Boolean> playerCreated) Constructs a query with the given IDs and durabilities.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ItemQuery	fromAny() Universal query.
static ItemQuery	fromAny(org.bukkit.block.Block block) Creates a query from a given world block.
static ItemQuery	fromAny(java.lang.Integer itemID, java.lang.Integer durability) Creates a query from the given material and data, where NULL represents any value.
static ItemQuery	fromAny(java.lang.Integer itemID, java.lang.Integer durability, java.lang.Boolean playerCreated) Creates a query from the given material and data, where NULL represents any value.
static ItemQuery	fromAny(org.bukkit.inventory.ItemStack stack) Extracts the item type and durability.
static ItemQuery	fromAny(org.bukkit.Material material) Creates a query from the given material and data.
static ItemQuery	fromAny(org.bukkit.Material material, java.lang.Integer durability) Creates a query from the given material and data.
static ItemQuery	fromExact(org.bukkit.block.Block block) Creates a query from a given world block.
static ItemQuery	fromExact(java.lang.Integer itemID, java.lang.Integer durability) Creates a query from the given ID and durability.
static ItemQuery	fromExact(java.lang.Integer itemID, java.lang.Integer durability, java.lang.Boolean playerCreated) Creates a query from the given ID and durability.
static ItemQuery	fromExact(org.bukkit.inventory.ItemStack stack) Extracts the item type and durability.
java.util.List<java.lang.Integer>	getDurability()
java.util.List<java.lang.Integer>	getItemID()
java.util.List<java.lang.Boolean>	getPlayerCreated()
Query.Types	getQueryType()
boolean	hasDurability()
int	hashCode()
boolean	hasItemID()
static boolean	hasItems(org.bukkit.inventory.ItemStack stack) Determines if the given item stack is non-empty.
boolean	hasPlayerCreated()
boolean	match(java.lang.Integer id, java.lang.Integer durability) Determines if the current query matches the given item.
boolean	match(java.lang.Integer id, java.lang.Integer durability, java.lang.Boolean playerCreated) Determines if the current query matches the given item.
boolean	match(org.bukkit.Material item) Determines if the current query matches the given item.
boolean	match(Query other) Determines if the given query matches the current query.
org.bukkit.inventory.ItemStack	toItemStack(int amount) Converts the given query to an item stack if possible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemQuery

public ItemQuery(java.util.List<java.lang.Integer> itemID,
         java.util.List<java.lang.Integer> durability)

Constructs a query with the given IDs and durabilities.

Parameters:

itemID - - list of IDs.

durability - - list of durabilities.

ItemQuery

public ItemQuery(java.util.List<java.lang.Integer> itemID,
         java.util.List<java.lang.Integer> durability,
         java.util.List<java.lang.Boolean> playerCreated)

Constructs a query with the given IDs and durabilities.

Parameters:

itemID - - list of IDs.

durability - - list of durabilities.

playerCreated - - option specifying whether or not the block was placed by a player.

Method Detail

fromAny

public static ItemQuery fromAny()

Universal query. Matches everything.

Returns:

The universal query.

fromAny

public static ItemQuery fromAny(org.bukkit.Material material)

Creates a query from the given material and data.

Parameters:

material - - material to create from.

Returns:

The created query.

fromAny

public static ItemQuery fromAny(org.bukkit.Material material,
                java.lang.Integer durability)

Creates a query from the given material and data.

Parameters:

material - - material to create from.

durability - - durability to create from.

Returns:

The created query.

fromAny

public static ItemQuery fromAny(java.lang.Integer itemID,
                java.lang.Integer durability)

Creates a query from the given material and data, where NULL represents any value.

Parameters:

itemID - - ID to create from, or NULL to indicate every ID.

durability - - durability to create from, or NULL to indicate every durability.

Returns:

The created query.

fromAny

public static ItemQuery fromAny(java.lang.Integer itemID,
                java.lang.Integer durability,
                java.lang.Boolean playerCreated)

Creates a query from the given material and data, where NULL represents any value.

Parameters:

itemID - - ID to create from, or NULL to indicate every ID.

durability - - durability to create from, or NULL to indicate every durability.

playerCreated - - whether or not the block was created/placed by a player.

Returns:

The created query.

fromAny

public static ItemQuery fromAny(org.bukkit.inventory.ItemStack stack)

Extracts the item type and durability. Note that the item count property is ignored.

Parameters:

stack - - item type.

Returns:

The created query.

Throws:

org.apache.commons.lang.NullArgumentException - if the stack is null.

fromAny

public static ItemQuery fromAny(org.bukkit.block.Block block)

Creates a query from a given world block.

Parameters:

block - - block to create from.

Returns:

The created query.

fromExact

public static ItemQuery fromExact(org.bukkit.block.Block block)

Creates a query from a given world block.

Parameters:

block - - block to create from.

Returns:

The created query.

fromExact

public static ItemQuery fromExact(org.bukkit.inventory.ItemStack stack)

Extracts the item type and durability. Note that the item count property is ignored.

Parameters:

stack - - item type.

Returns:

The created query.

Throws:

org.apache.commons.lang.NullArgumentException - if the stack is null.

fromExact

public static ItemQuery fromExact(java.lang.Integer itemID,
                  java.lang.Integer durability)

Creates a query from the given ID and durability. NULL is used to ONLY match universal queries.

Parameters:

itemID - - ID to match, or NULL to match queries without IDs.

durability - - durability to match, or NULL to match queries without durabilities.

Returns:

The created query.

fromExact

public static ItemQuery fromExact(java.lang.Integer itemID,
                  java.lang.Integer durability,
                  java.lang.Boolean playerCreated)

Creates a query from the given ID and durability. NULL is used to ONLY match universal queries.

Parameters:

itemID - - ID to match, or NULL to match queries without IDs.

durability - - durability to match, or NULL to match queries without durabilities.

Returns:

The created query.

getItemID

public java.util.List<java.lang.Integer> getItemID()

getDurability

public java.util.List<java.lang.Integer> getDurability()

getPlayerCreated

public java.util.List<java.lang.Boolean> getPlayerCreated()

hasItemID

public boolean hasItemID()

hasDurability

public boolean hasDurability()

hasPlayerCreated

public boolean hasPlayerCreated()

match

public boolean match(Query other)

Description copied from interface: Query

Determines if the given query matches the current query.

If a query can be considered to be a subset of the universe of items, then this operation determines if the current set (A) has a non-empty intersection with the other set (B).

Specified by:

match in interface Query

Parameters:

other - - the other query to match.

Returns:

TRUE if the current query contains every element of the other query.

match

public boolean match(java.lang.Integer id,
            java.lang.Integer durability,
            java.lang.Boolean playerCreated)

Determines if the current query matches the given item.

Parameters:

id - - id of item, or NULL for every ID.

durability - - durability of item, or NULL for every durability.

Returns:

TRUE if the current query matches the given item.

match

public boolean match(java.lang.Integer id,
            java.lang.Integer durability)

Determines if the current query matches the given item.

Parameters:

id - - id of item, or NULL for every ID.

durability - - durability of item, or NULL for every durability.

Returns:

TRUE if the current query matches the given item.

match

public boolean match(org.bukkit.Material item)

Determines if the current query matches the given item.

Parameters:

item - - item to test, or NULL for every possible item.

Returns:

TRUE if the current query matches the given item.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toItemStack

public org.bukkit.inventory.ItemStack toItemStack(int amount)

Converts the given query to an item stack if possible.

Returns:

The converted item stack, or NULL if not possible.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getQueryType

public Query.Types getQueryType()

Specified by:

getQueryType in interface Query

hasItems

public static boolean hasItems(org.bukkit.inventory.ItemStack stack)

Determines if the given item stack is non-empty.

Parameters:

stack - - item stack to test.

Returns:

TRUE if it is non-null and non-empty, FALSE otherwise.