simple.api.queries

Class SimpleQuery<T extends SimpleQuery<T,K,C>,K,C extends ClientContext>

java.lang.Object

simple.api.ClientAccessor<C>

simple.api.queries.SimpleQuery<T,K,C>

All Implemented Interfaces:

java.lang.Iterable<K>

Direct Known Subclasses:

SimpleEntityQuery, SimpleItemQuery, SimpleLocatableQuery, SimplePlayerQuery, SimpleTextQuery, SimpleWidgetQuery

public abstract class SimpleQuery<T extends SimpleQuery<T,K,C>,K,C extends ClientContext>
extends ClientAccessor<C>
implements java.lang.Iterable<K>

Created by Seth on Nov 18, 2019 at 9:47:12 PM.

Author:

Seth Davis

Field Summary

Fields inherited from class simple.api.ClientAccessor

ctx

Method Summary

Modifier and Type	Method and Description
boolean	contains(K item) Checks if the query contains the specified item
T	filter(java.util.function.Predicate<K> condition) Will filter out all items that do not pass the specified predicate condition
boolean	isEmpty() Will return if the query is empty
java.util.Iterator<K>	iterator()
K	next() Returns the next item in the query whilst removing it from the query
K	peekNext() Returns the next item in the query without popping it from the query
T	populate() Will clear the current query and populate it with newly grabbed items
int	population() Will return the amount of items inside of the query
T	reverse() Will reverse the order of the items in the query making the first item the last and so on
T	shuffle() Will shuffle the order of the items in the query randomly
int	size() Will return the amount of items inside of the query
T	sort(java.util.Comparator<? super K> comparator) Will sort the query by the specified comparator
java.util.stream.Stream<K>	toStream() Will return a stream of the current query

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

toStream

public final java.util.stream.Stream<K> toStream()

Will return a stream of the current query

Returns:

returns a Stream representing the current query

populate

public T populate()

Will clear the current query and populate it with newly grabbed items

Returns:

returns a new query of fresh items

population

public int population()

Will return the amount of items inside of the query

Returns:

returns the current size of the query

isEmpty

public boolean isEmpty()

Will return if the query is empty

Returns:

returns {true} if the query is empty, {false} otherwise

next

public K next()

Returns the next item in the query whilst removing it from the query

Returns:

the next item in the query, if the query is empty will return: null

peekNext

public K peekNext()

Returns the next item in the query without popping it from the query

Returns:

the next item in the query, if the query is empty will return: null

filter

public T filter(java.util.function.Predicate<K> condition)

Will filter out all items that do not pass the specified predicate condition

Parameters:

condition - the condition to filter the query by

Returns:

returns items in the query that have passed the predicate

sort

public T sort(java.util.Comparator<? super K> comparator)

Will sort the query by the specified comparator

Parameters:

comparator - the comparator to sort the query by

Returns:

returns the query sorted by said comparator

shuffle

public T shuffle()

Will shuffle the order of the items in the query randomly

Returns:

returns the randomly shuffled query

reverse

public T reverse()

Will reverse the order of the items in the query making the first item the last and so on

Returns:

returns the query in reverse order

iterator

public java.util.Iterator<K> iterator()

Specified by:

iterator in interface java.lang.Iterable<K>

contains

public boolean contains(K item)

Checks if the query contains the specified item

Parameters:

item - object to check if the query contains

Returns:

returns if the query contains the item {true}, otherwise {false}

size

public int size()

Will return the amount of items inside of the query

Returns:

returns the current size of the query