org.testfx.service.query

Interface NodeQuery

All Known Implementing Classes:

NodeQueryImpl

public interface NodeQuery

Method Summary

Modifier and Type	Method and Description
NodeQuery	from(Collection<Node> parentNodes) Stores all given parentNodes within this NodeQuery
NodeQuery	from(Node... parentNodes) Stores all given parentNodes within this NodeQuery
NodeQuery	lookup(Function<Node,Set<Node>> function) Sifts through stored nodes and uses function to determine which nodes to keep and which to remove.
<T> NodeQuery	lookup(org.hamcrest.Matcher<T> matcher) Sifts through stored nodes and keeps only those Nodes that match the given matcher.
<T extends Node> NodeQuery	lookup(Predicate<T> predicate) Sifts through stored nodes and keeps only those Nodes that pass the given predicate.
NodeQuery	lookup(String query) Sifts through stored nodes by their id ("#id"), their class (".class"), or the text it has ("text"), depending on the query used, and keeps only those Nodes that meet the query.
<T> NodeQuery	match(org.hamcrest.Matcher<T> matcher) Sifts through stored nodes and removes all Nodes that match the given matcher.
<T extends Node> NodeQuery	match(Predicate<T> predicate) Sifts through stored nodes and removes all Nodes that pass the given predicate.
NodeQuery	nth(int index) Keeps the nth Node in stored nodes and removes all others.
<T extends Node> T	query()
<T extends Node> Set<T>	queryAll()
<T extends Node> Optional<T>	tryQuery()

Method Detail

from

NodeQuery from(Node... parentNodes)

Stores all given parentNodes within this NodeQuery

Parameters:

parentNodes - the parentNodes to store

Returns:

itself

from

NodeQuery from(Collection<Node> parentNodes)

Stores all given parentNodes within this NodeQuery

Parameters:

parentNodes - the parentNodes to store

Returns:

itself

lookup

NodeQuery lookup(String query)

Sifts through stored nodes by their id ("#id"), their class (".class"), or the text it has ("text"), depending on the query used, and keeps only those Nodes that meet the query.

Parameters:

query - the query to use

Returns:

itself

lookup

<T> NodeQuery lookup(org.hamcrest.Matcher<T> matcher)

Sifts through stored nodes and keeps only those Nodes that match the given matcher.

Type Parameters:

T - matcher type

Parameters:

matcher - the matcher used to determine which Nodes to keep and which to remove

Returns:

itself

lookup

<T extends Node> NodeQuery lookup(Predicate<T> predicate)

Sifts through stored nodes and keeps only those Nodes that pass the given predicate.

Type Parameters:

T - type that extends Node

Parameters:

predicate - the predicate used to determine which Nodes to keep and which to remove.

Returns:

itself

lookup

NodeQuery lookup(Function<Node,Set<Node>> function)

Sifts through stored nodes and uses function to determine which nodes to keep and which to remove.

Parameters:

function - that returns the Nodes to keep

Returns:

itself

match

<T> NodeQuery match(org.hamcrest.Matcher<T> matcher)

Sifts through stored nodes and removes all Nodes that match the given matcher.

Type Parameters:

T - matcher type

Parameters:

matcher - that determines which Nodes to remove

Returns:

itself

match

<T extends Node> NodeQuery match(Predicate<T> predicate)

Sifts through stored nodes and removes all Nodes that pass the given predicate.

Type Parameters:

T - predicate type

Parameters:

predicate - that indicates which Nodes to remove

Returns:

itself

nth

NodeQuery nth(int index)

Keeps the nth Node in stored nodes and removes all others.

Parameters:

index - within the collection of Nodes

Returns:

itself

query

<T extends Node> T query()

Type Parameters:

T - type that extends Node

Returns:

the first node found or null.

tryQuery

<T extends Node> Optional<T> tryQuery()

Type Parameters:

T - type that extends Node

Returns:

the first node found or null

queryAll

<T extends Node> Set<T> queryAll()

Type Parameters:

T - type that extends Node

Returns:

all nodes found