org.opendaylight.mdsal.binding.javav2.api

Interface DataTreeCursor

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

DataTreeWriteCursor

All Known Implementing Classes:

BindingDOMDataTreeWriteCursorAdapter

@Beta
 @NotThreadSafe
public interface DataTreeCursor
extends AutoCloseable

A cursor holding a logical position within a conceptual data tree. It allows operations relative to that position, as well as moving the position up or down the tree.

Method Summary

Modifier and Type	Method and Description
void	close() Close this cursor.
void	enter(Iterable<TreeArgument<?>> path) Move the cursor to the specified child of the current position.
void	enter(TreeArgument<?>... path) Move the cursor to the specified child of the current position.
void	enter(TreeArgument<?> child) Move the cursor to the specified child of the current position.
void	exit() Move the cursor up to the parent of current position.
void	exit(int depth) Move the cursor up by specified amounts of steps from the current position.

Method Detail

enter

void enter(@Nonnull
           TreeArgument<?> child)

Move the cursor to the specified child of the current position.

Parameters:

child - Child identifier

Throws:

IllegalArgumentException - when specified identifier does not identify a valid child, or if that child is not an instance of TreeNode.

enter

void enter(@Nonnull
           TreeArgument<?>... path)

Move the cursor to the specified child of the current position. This is the equivalent of multiple invocations of enter(TreeArgument), except the operation is performed all at once.

Parameters:

path - Nested child identifier

Throws:

IllegalArgumentException - when specified path does not identify a valid child, or if that child is not an instance of TreeNode.

enter

void enter(@Nonnull
           Iterable<TreeArgument<?>> path)

Move the cursor to the specified child of the current position. This is equivalent to enter(TreeArgument...), except it takes an Iterable argument.

Parameters:

path - Nested child identifier

Throws:

IllegalArgumentException - when specified path does not identify a valid child, or if that child is not an instance of TreeNode.

exit

void exit()

Move the cursor up to the parent of current position. This is equivalent of invoking exit(1).

Throws:

IllegalStateException - when exiting would violate containment, typically by attempting to exit more levels than previously entered.

exit

void exit(int depth)

Move the cursor up by specified amounts of steps from the current position. This is equivalent of invoking exit() multiple times, except the operation is performed atomically.

Parameters:

depth - number of steps to exit

Throws:

IllegalArgumentException - when depth is negative.

IllegalStateException - when exiting would violate containment, typically by attempting to exit more levels than previously entered.

close

void close()
    throws Exception

Close this cursor. Attempting any further operations on the cursor will lead to undefined behavior.

Specified by:

close in interface AutoCloseable

Throws:

Exception