org.jopendocument.util
Class Step<T>

java.lang.Object
  org.jopendocument.util.Step<T>

Type Parameters:

T - type of items after the step.

public final class Step<T>
extends java.lang.Object

A step in SimpleXMLPath. There's only 2 types of step, those which go to Element and those which go to Attribute. Thread-safe if its predicate is.

Author:

Sylvain CUAZ

Nested Class Summary

static class

Step.Axis

Method Summary

static Step<org.jdom.Attribute>	createAttributeStep(java.lang.String name, java.lang.String ns)
static Step<org.jdom.Attribute>	createAttributeStep(java.lang.String name, java.lang.String ns, IPredicate<org.jdom.Attribute> pred)
static Step<org.jdom.Element>	createElementStep(Step.Axis axis, java.lang.String name)
static Step<org.jdom.Element>	createElementStep(Step.Axis axis, java.lang.String name, java.lang.String ns)
static Step<org.jdom.Element>	createElementStep(Step.Axis axis, java.lang.String name, java.lang.String ns, IPredicate<org.jdom.Element> pred)
static Step<org.jdom.Element>	createElementStep(java.lang.String name, java.lang.String ns)
static Step<org.jdom.Element>	createElementStep(java.lang.String name, java.lang.String ns, IPredicate<org.jdom.Element> pred)
static Step<org.jdom.Attribute>	getAnyAttributeStep() Return a step that match any attribute.
static Step<org.jdom.Element>	getAnyChildElementStep() Return a step that match any child element.
Step.Axis	getAxis()
java.lang.String	getName()
IPredicate<T>	getPredicate()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAnyAttributeStep

public static Step<org.jdom.Attribute> getAnyAttributeStep()

Return a step that match any attribute.

Returns:

the equivalent of @*.

createAttributeStep

public static Step<org.jdom.Attribute> createAttributeStep(java.lang.String name,
                                                           java.lang.String ns)

createAttributeStep

public static Step<org.jdom.Attribute> createAttributeStep(java.lang.String name,
                                                           java.lang.String ns,
                                                           IPredicate<org.jdom.Attribute> pred)

getAnyChildElementStep

public static Step<org.jdom.Element> getAnyChildElementStep()

Return a step that match any child element.

Returns:

the equivalent of *.

createElementStep

public static Step<org.jdom.Element> createElementStep(java.lang.String name,
                                                       java.lang.String ns)

createElementStep

public static Step<org.jdom.Element> createElementStep(java.lang.String name,
                                                       java.lang.String ns,
                                                       IPredicate<org.jdom.Element> pred)

createElementStep

public static Step<org.jdom.Element> createElementStep(Step.Axis axis,
                                                       java.lang.String name)

createElementStep

public static Step<org.jdom.Element> createElementStep(Step.Axis axis,
                                                       java.lang.String name,
                                                       java.lang.String ns)

createElementStep

public static Step<org.jdom.Element> createElementStep(Step.Axis axis,
                                                       java.lang.String name,
                                                       java.lang.String ns,
                                                       IPredicate<org.jdom.Element> pred)

getAxis

public final Step.Axis getAxis()

getName

public final java.lang.String getName()

getPredicate

public final IPredicate<T> getPredicate()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object