Package org.opendaylight.yangtools.yang.data.tree.api

Class DataTreeConfiguration

java.lang.Object

org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration

All Implemented Interfaces:

Immutable

@Beta
public class DataTreeConfiguration
extends Object
implements Immutable

DataTree configuration class.

TreeConfig supports currently the following options:

• treeType
• enable/disable unique indexes and unique constraint validation
• enable/disable mandatory nodes validation

TreeConfig can be easily extended in order to support further data tree configuration options, like following:

• enable/disable case exclusion validation
• enable/disable other indexes
• other schema aware validation options

This can be useful when strict validation is not required or useful for some reasons.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataTreeConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final DataTreeConfiguration	DEFAULT_CONFIGURATION
static final DataTreeConfiguration	DEFAULT_OPERATIONAL

Method Summary

Modifier and Type	Method	Description
static @NonNull DataTreeConfiguration.Builder	builder(TreeType treeType)
@NonNull DataTreeConfiguration.Builder	copyBuilder()
static DataTreeConfiguration	getDefault(TreeType treeType)
@NonNull YangInstanceIdentifier	getRootPath()
@NonNull TreeType	getTreeType()
boolean	isMandatoryNodesValidationEnabled()
boolean	isUniqueIndexEnabled()
boolean	isVersionInfoTrackingEnabled()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_CONFIGURATION

public static final DataTreeConfiguration DEFAULT_CONFIGURATION

DEFAULT_OPERATIONAL

public static final DataTreeConfiguration DEFAULT_OPERATIONAL

Method Details

getRootPath

public @NonNull YangInstanceIdentifier getRootPath()

getTreeType

public @NonNull TreeType getTreeType()

isUniqueIndexEnabled

public boolean isUniqueIndexEnabled()

isMandatoryNodesValidationEnabled

public boolean isMandatoryNodesValidationEnabled()

isVersionInfoTrackingEnabled

public boolean isVersionInfoTrackingEnabled()

toString

public String toString()

Overrides:

toString in class Object

getDefault

public static DataTreeConfiguration getDefault(TreeType treeType)

builder

public static @NonNull DataTreeConfiguration.Builder builder(TreeType treeType)

copyBuilder

public @NonNull DataTreeConfiguration.Builder copyBuilder()