Package rs.kreme.ksbot.api.queries

Class WidgetQuery

java.lang.Object

rs.kreme.ksbot.api.queries.Query<KSWidget,WidgetQuery>

rs.kreme.ksbot.api.queries.WidgetQuery

public class WidgetQuery
extends Query<KSWidget,WidgetQuery>

A query class for filtering and retrieving Widget objects based on various criteria.

Field Summary

Fields inherited from class rs.kreme.ksbot.api.queries.Query

ctx

Constructor Summary

Constructors

Constructor	Description
WidgetQuery(java.util.Collection<KSWidget> widgets)	Constructs a WidgetQuery with the specified collection of widgets.

Method Summary

Modifier and Type	Method	Description
WidgetQuery	filterUnique()	Filters widgets to include only unique ones based on their item ID.
KSWidget	first()	Retrieves the first matching widget, or null if none.
WidgetQuery	hidden()
WidgetQuery	inGroup(int group)
WidgetQuery	qtyAbove(int value)
WidgetQuery	qtyBelow(int value)
WidgetQuery	visible()
KSWidget	withHighestQuantity()	Retrieves the widget with the highest item quantity.
WidgetQuery	withIndex(int index)
WidgetQuery	withoutIndex(int index)
WidgetQuery	withoutPackedId(int id)
WidgetQuery	withoutSprite(int sprite)
WidgetQuery	withoutText(java.lang.String text)	Filters out widgets by their text content using wildcard matching, with null-safety.
WidgetQuery	withPackedId(int id)
WidgetQuery	withParentId(int parent)
WidgetQuery	withSprite(int sprite)
WidgetQuery	withText(java.lang.String text)	Filters widgets by their text content using wildcard matching, with null-safety.

Methods inherited from class rs.kreme.ksbot.api.queries.Query

count, empty, exists, filter, first, last, list, list, max, min, omit, omit, omit, random, shuffledList, shuffledList, sorted, stream, unique, withId, withName, withNameOrId, withOption, withoutId, withoutName, withoutNameOrId, withoutOption

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetQuery

public WidgetQuery(java.util.Collection<KSWidget> widgets)

Constructs a WidgetQuery with the specified collection of widgets.

Parameters:

widgets - the collection of widgets to query.

Method Detail

withIndex

public WidgetQuery withIndex(int index)

withoutIndex

public WidgetQuery withoutIndex(int index)

withParentId

public WidgetQuery withParentId(int parent)

withPackedId

public WidgetQuery withPackedId(int id)

withoutPackedId

public WidgetQuery withoutPackedId(int id)

withText

public WidgetQuery withText(java.lang.String text)

Filters widgets by their text content using wildcard matching, with null-safety.

withoutText

public WidgetQuery withoutText(java.lang.String text)

Filters out widgets by their text content using wildcard matching, with null-safety.

hidden

public WidgetQuery hidden()

visible

public WidgetQuery visible()

withSprite

public WidgetQuery withSprite(int sprite)

withoutSprite

public WidgetQuery withoutSprite(int sprite)

inGroup

public WidgetQuery inGroup(int group)

filterUnique

public WidgetQuery filterUnique()

Filters widgets to include only unique ones based on their item ID.

qtyAbove

public WidgetQuery qtyAbove(int value)

qtyBelow

public WidgetQuery qtyBelow(int value)

first

public KSWidget first()

Retrieves the first matching widget, or null if none.

Overrides:

first in class Query<KSWidget,WidgetQuery>

Returns:

the first matching object, or null if none exist.

withHighestQuantity

public KSWidget withHighestQuantity()

Retrieves the widget with the highest item quantity.