org.opendaylight.yangtools.yang.model.api

Enum YangStmtMapping

java.lang.Object

java.lang.Enum<YangStmtMapping>

org.opendaylight.yangtools.yang.model.api.YangStmtMapping

All Implemented Interfaces:

Serializable, Comparable<YangStmtMapping>, Immutable, MutationBehaviour<Immutable>, StatementDefinition

@Beta
 @NonNullByDefault
public enum YangStmtMapping
extends Enum<YangStmtMapping>
implements StatementDefinition

Mapping for both RFC6020 and RFC7950 statements.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION
ANYDATA
ANYXML
ARGUMENT
AUGMENT
BASE
BELONGS_TO
BIT
CASE
CHOICE
CONFIG
CONTACT
CONTAINER
DEFAULT
DESCRIPTION
DEVIATE
DEVIATION
ENUM
ERROR_APP_TAG
ERROR_MESSAGE
EXTENSION
FEATURE
FRACTION_DIGITS
GROUPING
IDENTITY
IF_FEATURE
IMPORT
INCLUDE
INPUT
KEY
LEAF
LEAF_LIST
LENGTH
LIST
MANDATORY
MAX_ELEMENTS
MIN_ELEMENTS
MODIFIER
MODULE
MUST
NAMESPACE
NOTIFICATION
ORDERED_BY
ORGANIZATION
OUTPUT
PATH
PATTERN
POSITION
PREFIX
PRESENCE
RANGE
REFERENCE
REFINE
REQUIRE_INSTANCE
REVISION
REVISION_DATE
RPC
STATUS
SUBMODULE
TYPE
TYPEDEF
UNIQUE
UNITS
USES
VALUE
WHEN
YANG_VERSION
YIN_ELEMENT

Method Summary

Modifier and Type	Method and Description
@Nullable QName	getArgumentName() Returns name of statement argument or null, if statement does not have argument.
Class<? extends DeclaredStatement<?>>	getDeclaredRepresentationClass() Returns class which represents declared version of statement associated with this definition.
Class<? extends EffectiveStatement<?,?>>	getEffectiveRepresentationClass() Returns class which represents derived behaviour from supplied statement.
QName	getStatementName() Returns name of the statement.
boolean	isArgumentYinElement() Returns true, if argument of statement is represented as value of yin element.
static YangStmtMapping	valueOf(String name) Returns the enum constant of this type with the specified name.
static YangStmtMapping[]	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

ACTION

public static final YangStmtMapping ACTION

ANYDATA

public static final YangStmtMapping ANYDATA

ANYXML

public static final YangStmtMapping ANYXML

ARGUMENT

public static final YangStmtMapping ARGUMENT

AUGMENT

public static final YangStmtMapping AUGMENT

BASE

public static final YangStmtMapping BASE

BELONGS_TO

public static final YangStmtMapping BELONGS_TO

BIT

public static final YangStmtMapping BIT

CASE

public static final YangStmtMapping CASE

CHOICE

public static final YangStmtMapping CHOICE

CONFIG

public static final YangStmtMapping CONFIG

CONTACT

public static final YangStmtMapping CONTACT

CONTAINER

public static final YangStmtMapping CONTAINER

DEFAULT

public static final YangStmtMapping DEFAULT

DESCRIPTION

public static final YangStmtMapping DESCRIPTION

DEVIATE

public static final YangStmtMapping DEVIATE

DEVIATION

public static final YangStmtMapping DEVIATION

ENUM

public static final YangStmtMapping ENUM

ERROR_APP_TAG

public static final YangStmtMapping ERROR_APP_TAG

ERROR_MESSAGE

public static final YangStmtMapping ERROR_MESSAGE

EXTENSION

public static final YangStmtMapping EXTENSION

FEATURE

public static final YangStmtMapping FEATURE

FRACTION_DIGITS

public static final YangStmtMapping FRACTION_DIGITS

GROUPING

public static final YangStmtMapping GROUPING

IDENTITY

public static final YangStmtMapping IDENTITY

IF_FEATURE

public static final YangStmtMapping IF_FEATURE

IMPORT

public static final YangStmtMapping IMPORT

INCLUDE

public static final YangStmtMapping INCLUDE

INPUT

public static final YangStmtMapping INPUT

KEY

public static final YangStmtMapping KEY

LEAF

public static final YangStmtMapping LEAF

LEAF_LIST

public static final YangStmtMapping LEAF_LIST

LENGTH

public static final YangStmtMapping LENGTH

LIST

public static final YangStmtMapping LIST

MANDATORY

public static final YangStmtMapping MANDATORY

MAX_ELEMENTS

public static final YangStmtMapping MAX_ELEMENTS

MIN_ELEMENTS

public static final YangStmtMapping MIN_ELEMENTS

MODIFIER

public static final YangStmtMapping MODIFIER

MODULE

public static final YangStmtMapping MODULE

MUST

public static final YangStmtMapping MUST

NAMESPACE

public static final YangStmtMapping NAMESPACE

NOTIFICATION

public static final YangStmtMapping NOTIFICATION

ORDERED_BY

public static final YangStmtMapping ORDERED_BY

ORGANIZATION

public static final YangStmtMapping ORGANIZATION

OUTPUT

public static final YangStmtMapping OUTPUT

PATH

public static final YangStmtMapping PATH

PATTERN

public static final YangStmtMapping PATTERN

POSITION

public static final YangStmtMapping POSITION

PREFIX

public static final YangStmtMapping PREFIX

PRESENCE

public static final YangStmtMapping PRESENCE

RANGE

public static final YangStmtMapping RANGE

REFERENCE

public static final YangStmtMapping REFERENCE

REFINE

public static final YangStmtMapping REFINE

REQUIRE_INSTANCE

public static final YangStmtMapping REQUIRE_INSTANCE

REVISION

public static final YangStmtMapping REVISION

REVISION_DATE

public static final YangStmtMapping REVISION_DATE

RPC

public static final YangStmtMapping RPC

STATUS

public static final YangStmtMapping STATUS

SUBMODULE

public static final YangStmtMapping SUBMODULE

TYPE

public static final YangStmtMapping TYPE

TYPEDEF

public static final YangStmtMapping TYPEDEF

UNIQUE

public static final YangStmtMapping UNIQUE

UNITS

public static final YangStmtMapping UNITS

USES

public static final YangStmtMapping USES

VALUE

public static final YangStmtMapping VALUE

WHEN

public static final YangStmtMapping WHEN

YANG_VERSION

public static final YangStmtMapping YANG_VERSION

YIN_ELEMENT

public static final YangStmtMapping YIN_ELEMENT

Method Detail

values

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

Returns:

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

valueOf

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

getStatementName

public QName getStatementName()

Description copied from interface: StatementDefinition

Returns name of the statement.

Specified by:

getStatementName in interface StatementDefinition

Returns:

Name of the statement

getArgumentName

public @Nullable QName getArgumentName()

Description copied from interface: StatementDefinition

Returns name of statement argument or null, if statement does not have argument.

Specified by:

getArgumentName in interface StatementDefinition

Returns:

argument name or null, if statement does not take argument.

getDeclaredRepresentationClass

public Class<? extends DeclaredStatement<?>> getDeclaredRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents declared version of statement associated with this definition. This class should be an interface which provides convenience access to declared substatements.

Specified by:

getDeclaredRepresentationClass in interface StatementDefinition

Returns:

class which represents declared version of statement associated with this definition.

getEffectiveRepresentationClass

public Class<? extends EffectiveStatement<?,?>> getEffectiveRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents derived behaviour from supplied statement. This class should be an interface which defines convenience access to statement properties, namespace items and substatements.

Specified by:

getEffectiveRepresentationClass in interface StatementDefinition

Returns:

class which represents effective version of statement associated with this definition

isArgumentYinElement

public boolean isArgumentYinElement()

Description copied from interface: StatementDefinition

Returns true, if argument of statement is represented as value of yin element. If argument of statement is represented as argument of yin element, returns false. If this statement does not have an argument, this method returns false.

Specified by:

isArgumentYinElement in interface StatementDefinition

Returns:

returns true, if statement argument is represented as value of yin element, otherwise returns false.