ComponentStream

open class ComponentStream(dataSource: BackingDataSource<Component>) : InteractableStream<Component, ComponentStream> , ActionableOps<Component, ComponentStream> , TextOps<Component, ComponentStream> , IdentifiableOps<Component, ComponentStream>

Functions

action

open fun action(vararg actions: Pattern?): ComponentStream

open fun action(vararg actions: String?): ComponentStream

open fun action(actions: Collection<String>): ComponentStream

allMatch

open override fun allMatch(predicate: Predicate<in Component>): Boolean

{@inheritDoc}

any

fun any(): Component

Get any entity from the stream

anyMatch

open override fun anyMatch(predicate: Predicate<in Component>): Boolean

{@inheritDoc}

bounds

open fun bounds(vararg rectangles: Rectangle): ComponentStream

Filters the current query's contents to only include components whose width and height bounds match at least one (1) of the parameter rectangles

contains

fun contains(vararg t: Component): Boolean

fun contains(t: Collection<Component>): Boolean

Check if the stream contains any of the provided entities

contentType

open fun contentType(vararg types: Int): ComponentStream

Filters the current query's contents to only include components whose content type matches at least one (1) of the parameter ints

count

open override fun count(): Long

{@inheritDoc}

filter

open override fun filter(predicate: Predicate<in Component>): ComponentStream

open override fun filter(predicate: Predicate<in Component>, difficulty: FilterDifficulty): ComponentStream

{@inheritDoc}

filtered

open override fun filtered(predicate: (Component) -> Boolean): ComponentStream

open override fun filtered(predicate: (Component) -> Boolean, difficulty: FilterDifficulty): ComponentStream

{@inheritDoc}

findAny

open override fun findAny(): Optional<Component>

{@inheritDoc}

findFirst

open override fun findFirst(): Optional<Component>

{@inheritDoc}

first

fun first(): Component

Get the first entity from the stream

firstOrNull

fun firstOrNull(): Component?

Get the first entity from the stream

forEach

open override fun forEach(action: Consumer<in Component>)

{@inheritDoc}

hashCode

fun hashCode(vararg hashCodes: Int): ComponentStream

height

open fun height(vararg heights: Int): ComponentStream

Filters the current query's contents to only include components whose height matches at least one (1) of the parameter ints

id

open fun id(vararg ids: Int): ComponentStream

isEmpty

fun isEmpty(): Boolean

Check if the stream is empty or not

isNotEmpty

fun isNotEmpty(): Boolean

Check if the stream is NOT empty or not

itemId

open fun itemId(vararg ids: Int): ComponentStream

Filters the current query's contents to only include components whose item id matches at least one (1) of the parameter ints

iterator

open operator override fun iterator(): Iterator<Component>

last

fun last(): Component

Get the last entity from the stream

lastOrNull

fun lastOrNull(): Component?

Get the last entity from the stream

list

fun list(): List<Component>

max

open override fun max(comparator: Comparator<in Component>): Optional<Component>

{@inheritDoc}

min

open override fun min(comparator: Comparator<in Component>): Optional<Component>

{@inheritDoc}

modelId

open fun modelId(vararg ids: Int): ComponentStream

Filters the current query's contents to only include components whose model id matches at least one (1) of the parameter ints

nil

open override fun nil(): Component

nil value of the entity

noneMatch

open override fun noneMatch(predicate: Predicate<in Component>): Boolean

{@inheritDoc}

parents

open fun parents(): ComponentStream

Filters for components which are containers of other components (parents of children components).

reversed

fun reversed(): List<Component>

scrollHeight

open fun scrollHeight(vararg heights: Int): ComponentStream

Filters the current query's contents to only include components whose scroll height matches at least one (1) of the parameter ints

scrollWidth

open fun scrollWidth(vararg widths: Int): ComponentStream

Filters the current query's contents to only include components whose scroll width matches at least one (1) of the parameter ints

setNearestTo

open override fun setNearestTo(nearestTo: Locatable): ComponentStream

shuffled

fun shuffled(): List<Component>

sorted

open override fun sorted(comparator: Comparator<in Component>): ComponentStream

{@inheritDoc}

spliterator

open override fun spliterator(): Spliterator<Component>

text

open fun text(pattern: Pattern): ComponentStream

open fun text(vararg texts: String): ComponentStream

textContains

open fun textContains(vararg texts: String): ComponentStream

texture

fun texture(vararg textures: Int): ComponentStream

Filters the current query's contents to only include components whose texture id matches at least one (1) of the parameter ints

tooltip

fun tooltip(pattern: Pattern): ComponentStream

Filters the current query's contents to only include components whose tooltip matches the parameter Pattern

open fun tooltip(vararg texts: String): ComponentStream

Filters the current query's contents to only include components whose tooltip equals to at least one (1) of the parameter strings. Comparisons ARE case sensitive.

tooltipContains

open fun tooltipContains(vararg texts: String): ComponentStream

Filters the current query's contents to only include components whose tooltip contains at least one (1) of the parameter strings. Comparisons are NOT case sensitive.

viewable

open override fun viewable(): ComponentStream

Filters the current query's contents to only include components that are currently visible and in the viewport

widget

open fun widget(index: Int): ComponentStream

Filters the current query's contents to only include components who match the specified widget index

width

open fun width(vararg widths: Int): ComponentStream

Filters the current query's contents to only include components whose width matches at least one (1) of the parameter ints

Properties

backingDataSource

val backingDataSource: BackingDataSource<Component>

nearestTo

var nearestTo: Locatable?

pendingFilters

val pendingFilters: MutableList<PendingFilter<Component>>

sorters

var sorters: MutableList<Comparator<in Component>>