simple.api.queries

Class SimpleItemQuery<K extends SimpleItem>

java.lang.Object

simple.api.ClientAccessor<C>

simple.api.queries.SimpleQuery<SimpleItemQuery<K>,K,ClientContext>

simple.api.queries.SimpleItemQuery<K>

All Implemented Interfaces:

java.lang.Iterable<K>

Direct Known Subclasses:

SimpleBank, SimpleEquipment, SimpleInventory, SimpleShop

public abstract class SimpleItemQuery<K extends SimpleItem>
extends SimpleQuery<SimpleItemQuery<K>,K,ClientContext>

Field Summary

Fields inherited from class simple.api.ClientAccessor

ctx

Method Summary

Modifier and Type	Method and Description
SimpleItemQuery<K>	filter(int... ids) Will filter out all items whose id isn't one of the elements inside of the {ids} array
SimpleItemQuery<K>	filter(java.util.regex.Pattern... patterns) Will filter out all items whose name doesn't' match any of the patterns
SimpleItemQuery<K>	filter(java.lang.String... names) Will filter out all items whose name isn't one of the elements inside of the {names} array
SimpleItemQuery<K>	filterContains(java.lang.String... partialNames) Will filter out all items whose name isn't a substring of one or more of the elements inside of the {names} array
SimpleItemQuery<K>	filterHasAction(java.util.regex.Pattern... patterns) Will filter out all items who don't have any actions that match any of the patterns
SimpleItemQuery<K>	filterHasAction(java.lang.String... actions) Will filter out all items who don't have any actions that are inside of the {actions} array
int	population(boolean stacks) Will return the amount of items inside of the query by their stack sizes

Methods inherited from class simple.api.queries.SimpleQuery

contains, filter, isEmpty, iterator, next, peekNext, populate, population, reverse, shuffle, size, sort, toStream

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

population

public int population(boolean stacks)

Will return the amount of items inside of the query by their stack sizes

Returns:

returns the current size of the query by total item stack sizes

filter

public SimpleItemQuery<K> filter(int... ids)

Will filter out all items whose id isn't one of the elements inside of the {ids} array

Parameters:

ids - array of ids for our filter

Returns:

returns the query of only items whose id's match one of those inside of {ids}

filter

public SimpleItemQuery<K> filter(java.lang.String... names)

Will filter out all items whose name isn't one of the elements inside of the {names} array

Parameters:

names - array of names for our filter

Returns:

returns the query of only items whose name matches one of those inside of {name}

filterContains

public SimpleItemQuery<K> filterContains(java.lang.String... partialNames)

Will filter out all items whose name isn't a substring of one or more of the elements inside of the {names} array

Parameters:

partialNames - array of partial names for our filter

Returns:

returns the query of only items whose name matches one of those inside of {name}

filter

public SimpleItemQuery<K> filter(java.util.regex.Pattern... patterns)

Will filter out all items whose name doesn't' match any of the patterns

Parameters:

patterns - regex patterns for our filter to check

Returns:

returns query of only items whose name matches one of the patterns inside of {patterns}

filterHasAction

public SimpleItemQuery<K> filterHasAction(java.lang.String... actions)

Will filter out all items who don't have any actions that are inside of the {actions} array

Parameters:

actions - array of actions for our filter

Returns:

returns the query of only items whose actions matches one of those inside of {actions}

filterHasAction

public SimpleItemQuery<K> filterHasAction(java.util.regex.Pattern... patterns)

Will filter out all items who don't have any actions that match any of the patterns

Parameters:

patterns - regex patterns for our filter to check

Returns:

returns query of only items whose action(s) matches one of the patterns inside of {patterns}