Package org.opendaylight.yangtools.yang.xpath.api

Enum YangFunction

java.lang.Object

java.lang.Enum<YangFunction>

org.opendaylight.yangtools.yang.xpath.api.YangFunction

All Implemented Interfaces:

Serializable, Comparable<YangFunction>, Identifiable<QName>

@Beta
public enum YangFunction
extends Enum<YangFunction>
implements Identifiable<QName>

Functions known to a YANG XPath.

Author:

Robert Varga

Enum Constant Summary

Enum Constants

Enum Constant	Description
BIT_IS_SET
BOOLEAN
CEILING
CONCAT
CONTAINS
COUNT
CURRENT
DEREF
DERIVED_FROM
DERIVED_FROM_OR_SELF
ENUM_VALUE
FALSE
FLOOR
ID
LANG
LAST
LOCAL_NAME
NAME
NAMESPACE_URI
NORMALIZE_SPACE
NOT
NUMBER
POSITION
RE_MATCH
ROUND
STARTS_WITH
STRING
STRING_LENGTH
SUBSTRING
SUBSTRING_AFTER
SUBSTRING_BEFORE
SUM
TRANSLATE
TRUE

Method Summary

Modifier and Type	Method	Description
QName	getIdentifier()	Return this objects Identifier.
YangVersion	getYangVersion()	Return the minimum YANG version where this function is supported.
static YangFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static YangFunction[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOLEAN

public static final YangFunction BOOLEAN

CEILING

public static final YangFunction CEILING

CONCAT

public static final YangFunction CONCAT

CONTAINS

public static final YangFunction CONTAINS

COUNT

public static final YangFunction COUNT

FALSE

public static final YangFunction FALSE

FLOOR

public static final YangFunction FLOOR

ID

public static final YangFunction ID

LANG

public static final YangFunction LANG

LAST

public static final YangFunction LAST

LOCAL_NAME

public static final YangFunction LOCAL_NAME

NAME

public static final YangFunction NAME

NUMBER

public static final YangFunction NUMBER

NAMESPACE_URI

public static final YangFunction NAMESPACE_URI

NORMALIZE_SPACE

public static final YangFunction NORMALIZE_SPACE

NOT

public static final YangFunction NOT

POSITION

public static final YangFunction POSITION

ROUND

public static final YangFunction ROUND

STARTS_WITH

public static final YangFunction STARTS_WITH

STRING

public static final YangFunction STRING

STRING_LENGTH

public static final YangFunction STRING_LENGTH

SUM

public static final YangFunction SUM

SUBSTRING

public static final YangFunction SUBSTRING

SUBSTRING_AFTER

public static final YangFunction SUBSTRING_AFTER

SUBSTRING_BEFORE

public static final YangFunction SUBSTRING_BEFORE

TRANSLATE

public static final YangFunction TRANSLATE

TRUE

public static final YangFunction TRUE

CURRENT

public static final YangFunction CURRENT

BIT_IS_SET

public static final YangFunction BIT_IS_SET

DEREF

public static final YangFunction DEREF

DERIVED_FROM

public static final YangFunction DERIVED_FROM

DERIVED_FROM_OR_SELF

public static final YangFunction DERIVED_FROM_OR_SELF

ENUM_VALUE

public static final YangFunction ENUM_VALUE

RE_MATCH

public static final YangFunction RE_MATCH

Method Detail

values

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

Returns:

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

valueOf

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

getIdentifier

public QName getIdentifier()

Description copied from interface: Identifiable

Return this objects Identifier.

Specified by:

getIdentifier in interface Identifiable<QName>

Returns:

Object's identifier, must not be null.

getYangVersion

public YangVersion getYangVersion()

Return the minimum YANG version where this function is supported.

Returns:

First YANG version where this function appeared.