org.opendaylight.yangtools.openconfig.model.api

Enum OpenConfigStatements

java.lang.Object

java.lang.Enum<OpenConfigStatements>

org.opendaylight.yangtools.openconfig.model.api.OpenConfigStatements

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPENCONFIG_ENCRYPTED_VALUE
OPENCONFIG_HASHED_VALUE
OPENCONFIG_VERSION

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 OpenConfigStatements	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpenConfigStatements[]	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

OPENCONFIG_ENCRYPTED_VALUE

public static final OpenConfigStatements OPENCONFIG_ENCRYPTED_VALUE

OPENCONFIG_HASHED_VALUE

public static final OpenConfigStatements OPENCONFIG_HASHED_VALUE

OPENCONFIG_VERSION

public static final OpenConfigStatements OPENCONFIG_VERSION

Method Detail

values

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

Returns:

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

valueOf

public static OpenConfigStatements 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.