org.opendaylight.yangtools.yang.xpath.api

Enum YangXPathAxis

java.lang.Object

java.lang.Enum<YangXPathAxis>

org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis

All Implemented Interfaces:

Serializable, Comparable<YangXPathAxis>

@Beta
public enum YangXPathAxis
extends Enum<YangXPathAxis>

XPath evaluation axis, as defined in XPath 1.0.

Author:

Robert Varga

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANCESTOR The ancestor axis.
ANCESTOR_OR_SELF The ancestor-or-self axis.
ATTRIBUTE The attribute axis.
CHILD The child axis.
DESCENDANT The descendant axis.
DESCENDANT_OR_SELF The descendant-or-self axis.
FOLLOWING The following axis.
FOLLOWING_SIBLING The following-sibling axis.
NAMESPACE The namespace axis.
PARENT The parent axis.
PRECEDING The preceding axis.
PRECEDING_SIBLING The preceding-sibling axis.
SELF The self axis.

Method Summary

Modifier and Type	Method and Description
YangLocationPath.AxisStep	asStep() Return the name-independent YangLocationPath.AxisStep along this axis.
YangLocationPath.AxisStep	asStep(Collection<YangExpr> predicates)
YangLocationPath.QNameStep	asStep(QName qname, Collection<YangExpr> predicates)
YangLocationPath.ProcessingInstructionStep	asStep(String name, Collection<YangExpr> predicates)
YangLocationPath.NodeTypeStep	asStep(YangXPathNodeType type, Collection<YangExpr> predicates)
String	toString()
static YangXPathAxis	valueOf(String name) Returns the enum constant of this type with the specified name.
static YangXPathAxis[]	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

CHILD

public static final YangXPathAxis CHILD

The child axis.

DESCENDANT

public static final YangXPathAxis DESCENDANT

The descendant axis.

PARENT

public static final YangXPathAxis PARENT

The parent axis.

ANCESTOR

public static final YangXPathAxis ANCESTOR

The ancestor axis.

FOLLOWING_SIBLING

public static final YangXPathAxis FOLLOWING_SIBLING

The following-sibling axis.

PRECEDING_SIBLING

public static final YangXPathAxis PRECEDING_SIBLING

The preceding-sibling axis.

FOLLOWING

public static final YangXPathAxis FOLLOWING

The following axis.

PRECEDING

public static final YangXPathAxis PRECEDING

The preceding axis.

ATTRIBUTE

public static final YangXPathAxis ATTRIBUTE

The attribute axis.

NAMESPACE

public static final YangXPathAxis NAMESPACE

The namespace axis.

SELF

public static final YangXPathAxis SELF

The self axis.

DESCENDANT_OR_SELF

public static final YangXPathAxis DESCENDANT_OR_SELF

The descendant-or-self axis.

ANCESTOR_OR_SELF

public static final YangXPathAxis ANCESTOR_OR_SELF

The ancestor-or-self axis.

Method Detail

values

public static YangXPathAxis[] 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 (YangXPathAxis c : YangXPathAxis.values())
    System.out.println(c);

Returns:

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

valueOf

public static YangXPathAxis 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

asStep

public final YangLocationPath.AxisStep asStep()

Return the name-independent YangLocationPath.AxisStep along this axis. XPath defines following axis AxisSteps:

• SELF axis this equals to the "." step
• PARENT axis this equals to the ".." step
• DESCENDANT_OR_SELF axis this equals to the "//" separator

other axes have these defined as a courtesy.

Returns:

Name-independent AnyNameStep.

asStep

public final YangLocationPath.AxisStep asStep(Collection<YangExpr> predicates)

asStep

public final YangLocationPath.QNameStep asStep(QName qname,
                                               Collection<YangExpr> predicates)

asStep

public final YangLocationPath.NodeTypeStep asStep(YangXPathNodeType type,
                                                  Collection<YangExpr> predicates)

asStep

public final YangLocationPath.ProcessingInstructionStep asStep(String name,
                                                               Collection<YangExpr> predicates)

toString

public String toString()

Overrides:

toString in class Enum<YangXPathAxis>