Index
All Classes and Interfaces|All Packages|Serialized Form
A
- APPEARED - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
This node has appeared because it is implied by one of its children.
- applyToCursor(DataTreeModificationCursor) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
-
Apply the contents of this modification to a cursor.
B
- BackendFailedException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when the backend of a
DataTreeSnapshotCursordetects an errors which prevents it from completing the requested operation. - BackendFailedException(String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.BackendFailedException
- BackendFailedException(String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.BackendFailedException
- build() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration.Builder
-
Return
DataTreeConfigurationas defined by this builder's current state. - builder(TreeType) - Static method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- Builder(TreeType) - Constructor for class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration.Builder
C
- childNodes() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Get an unmodifiable collection of modified child nodes.
- close() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Close this cursor.
- commit(DataTreeCandidate) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTree
-
Commit a data tree candidate.
- CONFIGURATION - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.TreeType
-
Only
config truenodes are allowed. - ConflictingModificationAppliedException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when a proposed change fails validation before being applied into the Data Tree because the Data Tree has been modified in way that a conflicting node is present.
- ConflictingModificationAppliedException(YangInstanceIdentifier, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException
- ConflictingModificationAppliedException(YangInstanceIdentifier, String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException
- copyBuilder() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- create(DataTreeConfiguration) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeFactory
-
Create a new data tree based on specified configuration, with a best-guess root.
- create(DataTreeConfiguration, EffectiveModelContext) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeFactory
-
Create a new data tree based on specified configuration, with a root node derived from the schema context lookup of the configuration.
- create(DataTreeConfiguration, EffectiveModelContext, DistinctNodeContainer<?, ?>) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeFactory
-
Create a new data tree based on specified configuration, with the specified node.
- CursorAwareDataTreeModification - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A
DataTreeModificationwhich allows creation of aDataTreeModificationCursor. - CursorAwareDataTreeSnapshot - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A
DataTreeSnapshotwhich allows creation of aDataTreeSnapshotCursor.
D
- dataAfter() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the after-image of data corresponding to the node.
- dataBefore() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the before-image of data corresponding to the node.
- DataTree - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Interface representing a data tree which can be modified in an MVCC fashion.
- DataTreeCandidate - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
An encapsulation of a validated data tree modification.
- DataTreeCandidateNode - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A single node within a
DataTreeCandidate. - DataTreeCandidateTip - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A
DataTreeCandidatewhich is also aDataTreeTip. - DataTreeConfiguration - Class in org.opendaylight.yangtools.yang.data.tree.api
-
DataTree configuration class.
- DataTreeConfiguration.Builder - Class in org.opendaylight.yangtools.yang.data.tree.api
- DataTreeFactory - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Factory interface for creating data trees.
- DataTreeModification - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Class encapsulation of set of modifications to a base tree.
- DataTreeModificationCursor - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Extension to the
DataTreeSnapshotCursorwhich allows modifying the data tree. - DataTreeSnapshot - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Read-only snapshot of a
DataTree. - DataTreeSnapshotCursor - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A cursor holding a logical position within a
DataTreeSnapshot. - DataTreeTip - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
Tip of a data tree instance.
- DataValidationFailedException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when a proposed change fails validation before being applied into the datastore.
- DataValidationFailedException(YangInstanceIdentifier, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException
-
Create a new instance.
- DataValidationFailedException(YangInstanceIdentifier, String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException
-
Create a new instance, initializing the cause.
- DEFAULT_CONFIGURATION - Static variable in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- DEFAULT_OPERATIONAL - Static variable in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- delete(YangInstanceIdentifier) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
-
Delete the node at specified path.
- delete(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor
-
Delete the specified child.
- DELETE - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
This node has been deleted along with any of its child nodes.
- DISAPPEARED - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
This node has disappeared because it is no longer implied by any children.
E
- enter(Iterable<YangInstanceIdentifier.PathArgument>) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Move the cursor to the specified child of the current position.
- enter(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Move the cursor to the specified child of the current position.
- enter(YangInstanceIdentifier.PathArgument...) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Move the cursor to the specified child of the current position.
- equals(Object) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
-
DataTreeCandidateimplementations must not override the default identity hashCode method, meaning their equals implementation must result in identity comparison. - equals(Object) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeTip
-
DataTreeTipimplementations must not override the default identity hashCode method, meaning their equals implementation must result in identity comparison. - exit() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Move the cursor up to the parent of current position.
- exit(int) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Move the cursor up by specified amounts of steps from the current position.
F
- findDataAfter() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the after-image of data corresponding to the node.
- findDataBefore() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the before-image of data corresponding to the node.
- findModifiedChild(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Returns modified child or empty.
G
- getActualCount() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
- getDataAfter() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the after-image of data corresponding to the node.
- getDataBefore() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the before-image of data corresponding to the node.
- getDefault(TreeType) - Static method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- getMaximumCount() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
- getMinimumCount() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
- getModifiedChild(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Returns modified child or empty.
- getNetconfErrors() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
- getNetconfErrors() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.UniqueConstraintException
- getPath() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException
-
Returns the offending object path.
- getRootNode() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
-
Get the candidate tree root node.
- getRootPath() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
-
Get the candidate tree root path.
- getRootPath() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- getRootPath() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.ReadOnlyDataTree
-
Get the root path of this data tree.
- getTreeType() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
H
- hashCode() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate
-
DataTreeCandidateimplementations must not override the default identity hashCode method. - hashCode() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeTip
-
DataTreeTipimplementations must not override the default identity hashCode method.
I
- IncorrectDataStructureException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when a proposed change fails validation before being applied into the datastore because of incorrect structure of user supplied data.
- IncorrectDataStructureException(YangInstanceIdentifier, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.IncorrectDataStructureException
- IncorrectDataStructureException(YangInstanceIdentifier, String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.IncorrectDataStructureException
- isMandatoryNodesValidationEnabled() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- isUniqueIndexEnabled() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
M
- merge(YangInstanceIdentifier.PathArgument, NormalizedNode) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor
-
Merge the specified data with the currently-present data at specified path.
- merge(YangInstanceIdentifier, NormalizedNode) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
-
Merge the specified data with the currently-present data at specified path.
- modelContext() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot
-
Return the
EffectiveModelContexteffective at the time this snapshot was taken. - modificationType() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Return the type of modification this node is undergoing.
- ModificationType - Enum Class in org.opendaylight.yangtools.yang.data.tree.api
-
Enumeration of all possible node modification states.
- modifiedChild(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Returns modified child or empty.
- ModifiedNodeDoesNotExistException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when a proposed change fails validation before being applied into the Data Tree because tree node which child nodes are modified or written did not exist when transaction started and still does not exists when transaction is processed.
- ModifiedNodeDoesNotExistException(YangInstanceIdentifier, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.ModifiedNodeDoesNotExistException
- ModifiedNodeDoesNotExistException(YangInstanceIdentifier, String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.ModifiedNodeDoesNotExistException
N
- name() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode
-
Get the node underlying
NormalizedNode.name(). - newModification() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeSnapshot
- newModification() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot
-
Create a new data tree modification based on this snapshot, using the specified data application strategy.
O
- openCursor() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeModification
-
Create a new
DataTreeModificationCursorat the root of the modification. - openCursor() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeSnapshot
-
Create a new
DataTreeSnapshotCursorat the root of the modification. - openCursor(YangInstanceIdentifier) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeSnapshot
-
Create a new
DataTreeSnapshotCursorat specified path. - openCursor(YangInstanceIdentifier) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeModification
-
Create a new
DataTreeModificationCursorat specified path. - OPERATIONAL - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.TreeType
-
Only
config trueandconfig falsenodes are allowed. - org.opendaylight.yangtools.yang.data.tree.api - module org.opendaylight.yangtools.yang.data.tree.api
- org.opendaylight.yangtools.yang.data.tree.api - package org.opendaylight.yangtools.yang.data.tree.api
P
- prepare(DataTreeModification) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeTip
-
Prepare a modification for commit.
R
- readNode(YangInstanceIdentifier.PathArgument) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshotCursor
-
Read a particular node from the snapshot.
- readNode(YangInstanceIdentifier) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot
-
Read a particular node from the snapshot.
- ReadOnlyDataTree - Interface in org.opendaylight.yangtools.yang.data.tree.api
-
A read-only view of a
DataTree. - ready() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
-
Finish creation of a modification, making it ready for application to the data tree.
- RequiredElementCountException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when
min-elementsormax-elementstatement restrictions are violated. - RequiredElementCountException(YangInstanceIdentifier, int, int, int, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
- RequiredElementCountException(YangInstanceIdentifier, int, int, int, String, Object...) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.RequiredElementCountException
S
- SchemaValidationFailedException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
SchemaValidationFailedException is thrown when an attempt is made to modify the data tree and the modification does not match the schema context.
- SchemaValidationFailedException(String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.SchemaValidationFailedException
- SchemaValidationFailedException(String, Throwable) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.SchemaValidationFailedException
- setEffectiveModelContext(EffectiveModelContext) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTree
-
Make the data tree use a new schema context.
- setMandatoryNodesValidation(boolean) - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration.Builder
- setRootPath(YangInstanceIdentifier) - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration.Builder
- setUniqueIndexes(boolean) - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration.Builder
- SUBTREE_MODIFIED - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
A child node, either direct or indirect, has been modified.
T
- takeSnapshot() - Method in interface org.opendaylight.yangtools.yang.data.tree.api.ReadOnlyDataTree
-
Take a read-only point-in-time snapshot of the tree.
- toString() - Method in class org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration
- TreeType - Enum Class in org.opendaylight.yangtools.yang.data.tree.api
-
DataTreetype, specifying which YANG modeled content is valid with a data tree.
U
- UniqueConstraintException - Exception in org.opendaylight.yangtools.yang.data.tree.api
-
Exception thrown when a
uniquestatement restrictions are violated. - UniqueConstraintException(YangInstanceIdentifier, Map<SchemaNodeIdentifier.Descendant, Object>, String) - Constructor for exception org.opendaylight.yangtools.yang.data.tree.api.UniqueConstraintException
- UNMODIFIED - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
Node is currently unmodified.
V
- validate(DataTreeModification) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeTip
-
Validate whether a particular modification can be applied to the data tree.
- valueOf(String) - Static method in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.opendaylight.yangtools.yang.data.tree.api.TreeType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.opendaylight.yangtools.yang.data.tree.api.TreeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in exception org.opendaylight.yangtools.yang.data.tree.api.UniqueConstraintException
W
- write(YangInstanceIdentifier.PathArgument, NormalizedNode) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor
-
Replace the data at specified path with supplied data.
- write(YangInstanceIdentifier, NormalizedNode) - Method in interface org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification
-
Replace the data at specified path with supplied data.
- WRITE - Enum constant in enum class org.opendaylight.yangtools.yang.data.tree.api.ModificationType
-
This node has been placed into the tree, potentially completely replacing pre-existing contents.
All Classes and Interfaces|All Packages|Serialized Form