org.opendaylight.mdsal.dom.spi.shard

Class AbstractDataModificationCursor<M>

java.lang.Object

org.opendaylight.mdsal.dom.spi.shard.AbstractDataModificationCursor<M>

Type Parameters:

M - Modification type

All Implemented Interfaces:

AutoCloseable, DOMDataTreeCursor, DOMDataTreeWriteCursor

@Beta
public abstract class AbstractDataModificationCursor<M>
extends Object
implements DOMDataTreeWriteCursor

Abstract base class for DOMDataTreeWriteCursor implementations.

Constructor Summary

Constructors

Constructor and Description
AbstractDataModificationCursor(M root)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close this cursor.
void	delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child) Delete the specified child.
void	enter(Iterable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> path) Move the cursor to the specified child of the current position.
void	enter(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument... path) Move the cursor to the specified child of the current position.
void	enter(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument 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.
protected abstract WriteCursorStrategy	getRootOperation(M root)
void	merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Merge the specified data with the currently-present data at specified path.
void	write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Replace the data at specified path with supplied data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataModificationCursor

public AbstractDataModificationCursor(M root)

Method Detail

getRootOperation

protected abstract WriteCursorStrategy getRootOperation(M root)

enter

public void enter(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child)

Description copied from interface: DOMDataTreeCursor

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

Specified by:

enter in interface DOMDataTreeCursor

Parameters:

child - Child identifier

enter

public void enter(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument... path)

Description copied from interface: DOMDataTreeCursor

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

Specified by:

enter in interface DOMDataTreeCursor

Parameters:

path - Nested child identifier

enter

public void enter(Iterable<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> path)

Description copied from interface: DOMDataTreeCursor

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

Specified by:

enter in interface DOMDataTreeCursor

Parameters:

path - Nested child identifier

exit

public void exit()

Description copied from interface: DOMDataTreeCursor

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

Specified by:

exit in interface DOMDataTreeCursor

exit

public void exit(int depth)

Description copied from interface: DOMDataTreeCursor

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

Specified by:

exit in interface DOMDataTreeCursor

Parameters:

depth - number of steps to exit

close

public abstract void close()

Description copied from interface: DOMDataTreeCursor

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DOMDataTreeCursor

delete

public void delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child)

Description copied from interface: DOMDataTreeWriteCursor

Delete the specified child.

Specified by:

delete in interface DOMDataTreeWriteCursor

Parameters:

child - Child identifier

merge

public void merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child,
                  org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Description copied from interface: DOMDataTreeWriteCursor

Merge the specified data with the currently-present data at specified path.

Specified by:

merge in interface DOMDataTreeWriteCursor

Parameters:

child - Child identifier

data - Data to be merged

write

public void write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument child,
                  org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Description copied from interface: DOMDataTreeWriteCursor

Replace the data at specified path with supplied data.

Specified by:

write in interface DOMDataTreeWriteCursor

Parameters:

child - Child identifier

data - New node data