org.thymeleaf.dom
Class DOMSelector

Object
  org.thymeleaf.dom.DOMSelector

All Implemented Interfaces:

Serializable

public final class DOMSelector
extends Object
implements Serializable

DOM Selectors model selections of subtrees from Thymeleaf DOM trees.

A common use of these selectors is for including fragments of other templates without the need of these other templates having any Thymeleaf code.

DOM Selector syntax is a subset of XPath, including:

• /x means direct children of the current node with name x.
• //x means children of the current node with name x, at any depth.
• x[@z="v"] means elements with name x and an attribute called z with value "v".
• x[@z1="v1" and @z2="v2"] means elements with name x and attributes z1 and z2 with values "v1" and "v2", respectively.
• x[i] means element with name x positioned in number i among its siblings.
• x[@z="v"][i] means elements with name x, attribute z with value "v" and positioned in number i among its siblings that also match this condition.

For example: //div[@id="menu"].

Objects of this class are thread-safe.

Since:

2.0.0

Author:

Daniel Fernández

See Also:

Serialized Form

Nested Class Summary

static interface

DOMSelector.INodeReferenceChecker

Constructor Summary

DOMSelector(String selectorExpression)
Creates a new DOM selector specified by the argument selector expression.

Method Summary

String	getSelectorExpression() Returns the expression that specifies this DOM selector.
List<Node>	select(List<Node> nodes) Executes the DOM selector against the specified list of nodes, returning the result of applying the selector expression.
List<Node>	select(List<Node> nodes, DOMSelector.INodeReferenceChecker referenceChecker) Executes the DOM selector against the specified list of nodes and using the specified reference checker (if references are used in the DOM selector expression).
List<Node>	select(Node node) Executes the DOM selector against the specified node, returning the result of applying the selector expression.
List<Node>	select(Node node, DOMSelector.INodeReferenceChecker referenceChecker) Executes the DOM selector against the specified node and using the specified reference checker (if references are used in the DOM selector expression).
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DOMSelector

public DOMSelector(String selectorExpression)

Creates a new DOM selector specified by the argument selector expression.

Parameters:

selectorExpression - the expression specifying the selector to be used.

Method Detail

getSelectorExpression

public String getSelectorExpression()

Returns the expression that specifies this DOM selector.

Returns:

the selector expression.

Since:

2.0.12

select

public List<Node> select(Node node)

Executes the DOM selector against the specified node, returning the result of applying the selector expression.

Parameters:

node - the node on which the selector will be executed.

Returns:

the result of executing the selector.

select

public List<Node> select(Node node,
                         DOMSelector.INodeReferenceChecker referenceChecker)

Executes the DOM selector against the specified node and using the specified reference checker (if references are used in the DOM selector expression).

Parameters:

node - the node on which the selector will be executed.

referenceChecker - the checker that will be used to compute whether a Node matches or not a specified reference. Can be null.

Returns:

the result of executing the selector.

Since:

2.1.0

select

public List<Node> select(List<Node> nodes)

Executes the DOM selector against the specified list of nodes, returning the result of applying the selector expression.

Parameters:

nodes - the nodes on which the selector will be executed.

Returns:

the result of executing the selector.

select

public List<Node> select(List<Node> nodes,
                         DOMSelector.INodeReferenceChecker referenceChecker)

Executes the DOM selector against the specified list of nodes and using the specified reference checker (if references are used in the DOM selector expression).

Parameters:

nodes - the nodes on which the selector will be executed.

referenceChecker - the checker that will be used to compute whether a Node matches or not a specified reference. Can be null.

Returns:

the result of executing the selector.

Since:

2.1.0

toString

public String toString()

Overrides:

toString in class Object