org.osbot.rs07.api.filter

Class FilterAPI<E>

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.CollectionAPI<E>

org.osbot.rs07.api.filter.FilterAPI<E>

Direct Known Subclasses:

EntityAPI, GraphicObjects, Projectiles, Widgets

public abstract class FilterAPI<E>
extends CollectionAPI<E>

Represents an API with objects that can be filtered.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
FilterAPI()

Method Summary

Modifier and Type	Method and Description
java.util.List<E>	filter(java.util.Collection<E> entities, Filter<E>... filters) Filters a collection of entities using the specified filters.
java.util.List<E>	filter(Filter<E>... filters) Filters local entities using the specified filters.
E	singleFilter(java.util.Collection<E> entities, Filter<E>... filters) Filters entities using the specified filters.

Methods inherited from class org.osbot.rs07.api.CollectionAPI

getAll

Methods inherited from class org.osbot.rs07.script.API

initializeModule

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterAPI

public FilterAPI()

Method Detail

filter

public java.util.List<E> filter(Filter<E>... filters)

Filters local entities using the specified filters.

Parameters:

filters - The filters to use.

Returns:

The filtered collection.

filter

@SafeVarargs
public final java.util.List<E> filter(java.util.Collection<E> entities,
                                                    Filter<E>... filters)

Filters a collection of entities using the specified filters.

Parameters:

entities - The collection of entities to filter.

filters - The filters to use.

Returns:

The filtered collection.

singleFilter

@SafeVarargs
public final E singleFilter(java.util.Collection<E> entities,
                                          Filter<E>... filters)

Filters entities using the specified filters.

Parameters:

entities - The collection of entities to filter.

filters - The filters to use.

Returns:

The first entity match in the collection.