org.onosproject.yms.ydt

Enum YdtContextOperationType

java.lang.Object

java.lang.Enum<YdtContextOperationType>

org.onosproject.yms.ydt.YdtContextOperationType

All Implemented Interfaces:

Serializable, Comparable<YdtContextOperationType>

public enum YdtContextOperationType
extends Enum<YdtContextOperationType>

Represents type of YANG data tree node operation. This is used by protocols to specify edit operation associate with the node. YMS data validation and data handling will vary based on the edit operation type, for an instance, default leafs if not present in data should be added if edit operation type is create and shouldn't be added if operation type is delete. Edit operation type is mapped to "operation type" of YANG utils generated classes by YMS. In case of SBI driver/provider creates JAVA object (of YANG utils generated classes) and specifies the edit operation type in "operation type" field. YMS map this operation type to "edit operation type" of YDT, which will be further encoded in corresponding data format. This is only applicable if YANG root level interaction type is EDIT_CONFIG. If edit operation type is not specified when root interaction type is EDIT_CONFIG then default operation type will be selected. By default "default operation type" is "merge" unless explicitly specified by protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is added to the configuration if and only if the configuration data does not already exist in the configuration datastore.
DELETE Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is deleted from the configuration if and only if the configuration data currently exists in the configuration datastore.
MERGE Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is merged with the configuration at the corresponding level in the configuration datastore.
NONE The node is used as a containment node to reach the child node, There is no change in the data store for the values of this node in the edit request.
REMOVE Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is deleted from the configuration if the configuration data currently exists in the configuration datastore.
REPLACE Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute replaces any related configuration in the configuration datastore.

Method Summary

Modifier and Type	Method and Description
static YdtContextOperationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static YdtContextOperationType[]	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

CREATE

public static final YdtContextOperationType CREATE

Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is added to the configuration if and only if the configuration data does not already exist in the configuration datastore. If the configuration data exists, an error is returned.

DELETE

public static final YdtContextOperationType DELETE

Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is deleted from the configuration if and only if the configuration data currently exists in the configuration datastore. If the configuration data does not exist, an error is returned".

MERGE

public static final YdtContextOperationType MERGE

Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is merged with the configuration at the corresponding level in the configuration datastore.

REPLACE

public static final YdtContextOperationType REPLACE

Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute replaces any related configuration in the configuration datastore. If no such configuration data exists in the configuration datastore, it is created.

REMOVE

public static final YdtContextOperationType REMOVE

Type of YANG data tree action for below action: The configuration data identified by the element containing this attribute is deleted from the configuration if the configuration data currently exists in the configuration datastore. If the configuration data does not exist, the "remove" operation is silently ignored by the server.

NONE

public static final YdtContextOperationType NONE

The node is used as a containment node to reach the child node, There is no change in the data store for the values of this node in the edit request.

Method Detail

values

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

Returns:

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

valueOf

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