org.basex.query.path
Enum Axis

java.lang.Object
  extended by java.lang.Enum<Axis>
      extended by org.basex.query.path.Axis
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Axis>

public enum Axis
extends java.lang.Enum<Axis>

XPath axes.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary
ANC
          Ancestor axis.
ANCORSELF
          Ancestor-or-self axis.
ATTR
          Attribute axis.
CHILD
          Child Axis.
DESC
          Descendant axis.
DESCORSELF
          Descendant-or-self axis.
FOLL
          Following axis.
FOLLSIBL
          Following-Sibling axis.
PARENT
          Parent axis.
PREC
          Preceding axis.
PRECSIBL
          Preceding-Sibling axis.
SELF
          Step axis.
 
Field Summary
 boolean down
          Descendant axis flag.
 java.lang.String name
          Axis string.
static Axis[] VALUES
          Cached enums (faster).
 
Method Summary
 java.lang.String toString()
           
static Axis valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Axis[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ANCORSELF

public static final Axis ANCORSELF
Ancestor-or-self axis.


ANC

public static final Axis ANC
Ancestor axis.


ATTR

public static final Axis ATTR
Attribute axis.


CHILD

public static final Axis CHILD
Child Axis.


DESCORSELF

public static final Axis DESCORSELF
Descendant-or-self axis.


DESC

public static final Axis DESC
Descendant axis.


FOLLSIBL

public static final Axis FOLLSIBL
Following-Sibling axis.


FOLL

public static final Axis FOLL
Following axis.


PARENT

public static final Axis PARENT
Parent axis.


PRECSIBL

public static final Axis PRECSIBL
Preceding-Sibling axis.


PREC

public static final Axis PREC
Preceding axis.


SELF

public static final Axis SELF
Step axis.

Field Detail

VALUES

public static final Axis[] VALUES
Cached enums (faster).


name

public final java.lang.String name
Axis string.


down

public final boolean down
Descendant axis flag.

Method Detail

values

public static 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 (Axis c : 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 Axis valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<Axis>