org.opendaylight.mdsal.common.api

Enum LogicalDatastoreType

java.lang.Object

java.lang.Enum<LogicalDatastoreType>

org.opendaylight.mdsal.common.api.LogicalDatastoreType

All Implemented Interfaces:

Serializable, Comparable<LogicalDatastoreType>

public enum LogicalDatastoreType
extends Enum<LogicalDatastoreType>

The concept of a logical data store, similar to RFC8342.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURATION Logical Datastore representing configuration state of the system and it's components.
OPERATIONAL Logical datastore representing operational state of the system and it's components.

Method Summary

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

OPERATIONAL

public static final LogicalDatastoreType OPERATIONAL

Logical datastore representing operational state of the system and it's components. This datastore is used to describe operational state of the system and it's operation related data.

It is defined to:

• contain both config=true and config=false nodes
• be replicated across all nodes by default, individual shards may have different strategies, which need to be documented

CONFIGURATION

public static final LogicalDatastoreType CONFIGURATION

Logical Datastore representing configuration state of the system and it's components. This datastore is used to describe intended state of the system and intended operation mode.

It is defined to:

• contain only config=true nodes
• be replicated across all nodes by default, individual shards may have different strategies, which need to be documented
• be persisted on all nodes by default, individual shards may have different strategies, which need to be documented

Method Detail

values

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

Returns:

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

valueOf

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