net.sf.saxon.s9api

Class Axis

public class Axis extends Enum<Axis>

This is an enumeration class containaing constants representing the thirteen XPath axes

Field Summary
static Axis	ANCESTOR
static Axis	ANCESTOR_OR_SELF
static Axis	ATTRIBUTE
static Axis	CHILD
static Axis	DESCENDANT
static Axis	DESCENDANT_OR_SELF
static Axis	FOLLOWING
static Axis	FOLLOWING_SIBLING
static Axis	NAMESPACE
static Axis	PARENT
static Axis	PRECEDING
static Axis	PRECEDING_SIBLING
static Axis	SELF
static List<Axis>	VALUES An immutable list containing the values comprising this enum class in the order they're declared.

Method Summary
List<Axis>	family() Returns an immutable list containing the values comprising this enum class in the order they're declared.
byte	getAxisNumber() Get the axis number, as defined in class
static Axis	valueOf(String name) Static factory to return the enum constant pertaining to the given string name.

Field Detail

ANCESTOR_OR_SELF

public static final Axis ANCESTOR_OR_SELF

DESCENDANT_OR_SELF

public static final Axis DESCENDANT_OR_SELF

FOLLOWING_SIBLING

public static final Axis FOLLOWING_SIBLING

PRECEDING_SIBLING

public static final Axis PRECEDING_SIBLING

VALUES

public static final List<Axis> VALUES

An immutable list containing the values comprising this enum class in the order they're declared. This field may be used to iterate over the constants as follows:

for(Axis c : Axis.VALUES)
    System.out.println(c);

Returns an immutable list containing the values comprising this enum class in the order they're declared. This instance method simply returns VALUES. Few programmers should have any need to use this method. It is provided for use by sophisticated enum-based data structures to prevent the need for reflective access to VALUES.

Returns: an immutable list containing the values comprising this enum class, in the order they're declared.

getAxisNumber

public byte getAxisNumber()

Get the axis number, as defined in class Axis

Returns: the axis number

valueOf

public static final Axis valueOf(String name)

Static factory to return the enum constant pertaining to the given string name. The string must match exactly an identifier used to declare an enum constant in this type.

Throws: IllegalArgumentException if this enum class has no constant with the specified name.