dfh.treepath
Enum PathGrammar.Axis

java.lang.Object
  extended by java.lang.Enum<PathGrammar.Axis>
      extended by dfh.treepath.PathGrammar.Axis
All Implemented Interfaces:
Serializable, Comparable<PathGrammar.Axis>
Enclosing class:
PathGrammar

public static enum PathGrammar.Axis
extends Enum<PathGrammar.Axis>

Axes known to tree path grammar.

Author:
David F. Houghton - Apr 23, 2012

Enum Constant Summary
ancestor
          E.g., //foo/ancestor::*
ancestorOrSelf
          E.g., //foo/ancestor-or-self::*
child
          E.g., //foo/child::*
descendant
          E.g., //foo/descendant::*
descendantOrSelf
          E.g., //foo/descendant-or-self::*
following
          E.g., //foo/following::*
followingSibling
          E.g., //foo/following-sibling::*
leaf
          E.g., //foo/leaf::*
parent
          E.g., //foo/parent::*
preceding
          E.g., //foo/preceding::*
precedingSibling
          E.g., //foo/preceding-sibling::*
self
          E.g., //foo/self::*
sibling
          E.g., //foo/sibling::*
siblingOrSelf
          E.g., //foo/sibling-or-self::*
 
Method Summary
static PathGrammar.Axis valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PathGrammar.Axis[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
static PathGrammar.Axis vo(String s)
          Used in place of valueOf(String) to handle hyphens in axis names.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

preceding

public static final PathGrammar.Axis preceding
E.g., //foo/preceding::*


precedingSibling

public static final PathGrammar.Axis precedingSibling
E.g., //foo/preceding-sibling::*


following

public static final PathGrammar.Axis following
E.g., //foo/following::*


followingSibling

public static final PathGrammar.Axis followingSibling
E.g., //foo/following-sibling::*


ancestor

public static final PathGrammar.Axis ancestor
E.g., //foo/ancestor::*


ancestorOrSelf

public static final PathGrammar.Axis ancestorOrSelf
E.g., //foo/ancestor-or-self::*


descendant

public static final PathGrammar.Axis descendant
E.g., //foo/descendant::*


descendantOrSelf

public static final PathGrammar.Axis descendantOrSelf
E.g., //foo/descendant-or-self::*


sibling

public static final PathGrammar.Axis sibling
E.g., //foo/sibling::*


siblingOrSelf

public static final PathGrammar.Axis siblingOrSelf
E.g., //foo/sibling-or-self::*


leaf

public static final PathGrammar.Axis leaf
E.g., //foo/leaf::*


self

public static final PathGrammar.Axis self
E.g., //foo/self::*


parent

public static final PathGrammar.Axis parent
E.g., //foo/parent::*


child

public static final PathGrammar.Axis child
E.g., //foo/child::*

Method Detail

values

public static PathGrammar.Axis[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (PathGrammar.Axis c : PathGrammar.Axis.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static PathGrammar.Axis valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

vo

public static PathGrammar.Axis vo(String s)
Used in place of valueOf(String) to handle hyphens in axis names.

Parameters:
s - axis name
Returns:
axis constant