A C F G H I L N O P R S T X

A

attr(Object) - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the value of the specified attribute for the first/sole Node in the internal Node list for this instance, if that Node is an Element.

attributes() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns a Map of all attributes for the first/sole Node held internally by this instance.

C

children() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns a new XmlTool instance that wraps all the child Elements of all the current internally held nodes that are Elements themselves.

configure(ValueParser) - Method in class org.apache.velocity.tools.generic.XmlTool

Looks for the "file" parameter and automatically uses XmlTool.read(String) to parse the file and set the resulting Document as the root node for this instance.

F

FILE_KEY - Static variable in class org.apache.velocity.tools.generic.XmlTool

find(Object) - Method in class org.apache.velocity.tools.generic.XmlTool

Converts the specified object to a String and calls XmlTool.find(String) with that.

find(String) - Method in class org.apache.velocity.tools.generic.XmlTool

Performs an XPath selection on the current set of Nodes held by this instance and returns a new XmlTool instance that wraps those results.

G

get(Object) - Method in class org.apache.velocity.tools.generic.XmlTool

This will first attempt to find an attribute with the specified name and return its value.

get(Number) - Method in class org.apache.velocity.tools.generic.XmlTool

Returns an XmlTool that wraps the specified Node from this instance's internal Node list.

getFirst() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns an XmlTool that wraps only the first Node from this instance's internal Node list.

getLast() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns an XmlTool that wraps only the last Node from this instance's internal Node list.

getName() - Method in class org.apache.velocity.tools.generic.XmlTool

Asks XmlTool.get(Object) for a "name" result.

getNodeName() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the name of the root node.

getParent() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns a new XmlTool instance that wraps the parent Element of the first/sole Node being wrapped by this instance.

getPath() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the XPath that identifies the first/sole Node represented by this instance.

getText() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the concatenated text content of all the internally held nodes.

H

hasNext() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator

I

isEmpty() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns true if there are no Nodes internally held by this instance.

iterator() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns an XmlTool.NodeIterator that returns new XmlTool instances for each Node held internally by this instance.

L

LOG - Variable in class org.apache.velocity.tools.generic.XmlTool

N

next() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator

node() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the first/sole Node from this instance's internal Node list, if any.

O

org.apache.velocity.tools.generic - package org.apache.velocity.tools.generic

P

parents() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns a new XmlTool instance that wraps the parent Elements of each of the Nodes being wrapped by this instance.

parse(String) - Method in class org.apache.velocity.tools.generic.XmlTool

Parses the given XML string and uses the resulting Document as the root Node.

parse(Object) - Method in class org.apache.velocity.tools.generic.XmlTool

This accepts XML in form.

R

read(String) - Method in class org.apache.velocity.tools.generic.XmlTool

Creates a URL from the string and passes it to XmlTool.read(URL).

read(URL) - Method in class org.apache.velocity.tools.generic.XmlTool

Reads, parses and creates a Document from the given URL and uses it as the root Node for this instance.

read(Object) - Method in class org.apache.velocity.tools.generic.XmlTool

If safe mode is explicitly turned off for this tool, then this will accept either a URL or the string representation thereof.

remove() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator

S

setRoot(Node) - Method in class org.apache.velocity.tools.generic.XmlTool

Sets a singular root Node for this instance.

size() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the number of Nodes internally held by this instance.

T

toString() - Method in class org.apache.velocity.tools.generic.XmlTool

If this instance has no XML Nodes, then this returns the result of super.toString().

X

XmlTool - Class in org.apache.velocity.tools.generic

Tool for reading/navigating XML files.

XmlTool() - Constructor for class org.apache.velocity.tools.generic.XmlTool

XmlTool(Node) - Constructor for class org.apache.velocity.tools.generic.XmlTool

XmlTool(List<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool

XmlTool.NodeIterator - Class in org.apache.velocity.tools.generic

Iterator implementation that wraps a Node list iterator to return new XmlTool instances for each item in the wrapped iterator.s

XmlTool.NodeIterator(Iterator<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool.NodeIterator

A C F G H I L N O P R S T X