Skip to content

Commit

Permalink
(doc) Add documentation to WindowFinder
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanMartinez committed Dec 8, 2016
1 parent b89b6ce commit 1ed11f6
Showing 1 changed file with 45 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,62 @@ public interface NodeFinder {
// METHODS.
//---------------------------------------------------------------------------------------------

/**
* Returns a {@link NodeQuery} that stores all the root nodes that meet the given query
*
* @see NodeQuery#lookup(String)
*/
NodeQuery lookup(String query);

/**
* Returns a {@link NodeQuery} that stores all the root nodes that match the given matcher.
*
* @see NodeQuery#lookup(Matcher)
*/
<T> NodeQuery lookup(Matcher<T> matcher);

/**
* Returns a {@link NodeQuery} that stores all the root nodes that pass the given predicate
*
* @see NodeQuery#lookup(Predicate)
*/
<T extends Node> NodeQuery lookup(Predicate<T> predicate);

/**
* Returns a {@link NodeQuery} that stores all the root nodes of all windows via
* {@link WindowFinder#listTargetWindows()}
*/
NodeQuery fromAll();

/**
* Returns a {@link NodeQuery} that stores the given parentNodes
*/
NodeQuery from(Node... parentNodes);

/**
* Returns a {@link NodeQuery} that stores the given parentNodes collection.
*/
NodeQuery from(Collection<Node> parentNodes);

/**
* Returns a new {@link NodeQuery} that stores all the parentNodes from the given nodeQuery (essentially,
* it creates a copy/clone).
*/
NodeQuery from(NodeQuery nodeQuery);

/**
* Returns the window's scene's root node.
*/
Node rootNode(Window window);

/**
* Returns the scene's root node
*/
Node rootNode(Scene scene);

/**
* Returns the node's scene's root node
*/
Node rootNode(Node node);

//Node rootNode(Predicate<Window> predicate);
Expand Down

0 comments on commit 1ed11f6

Please sign in to comment.