org.opendaylight.mdsal.binding.dom.adapter

Class BindingDOMDataTreeWriteCursorAdapter<T extends DOMDataTreeWriteCursor>

java.lang.Object

org.opendaylight.mdsal.binding.dom.adapter.BindingDOMDataTreeWriteCursorAdapter<T>

All Implemented Interfaces:

AutoCloseable, DataTreeCursor, DataTreeWriteCursor

public class BindingDOMDataTreeWriteCursorAdapter<T extends DOMDataTreeWriteCursor>
extends Object
implements DataTreeWriteCursor

Constructor Summary

Constructors

Constructor and Description
BindingDOMDataTreeWriteCursorAdapter(DataTreeIdentifier<?> path, T delegate, BindingToNormalizedNodeCodec codec)

Method Summary

Modifier and Type	Method and Description
void	close() Close this cursor.
void	delete(InstanceIdentifier.PathArgument child) Delete the specified child.
void	enter(InstanceIdentifier.PathArgument... path) Move the cursor to the specified child of the current position.
void	enter(InstanceIdentifier.PathArgument child) Move the cursor to the specified child of the current position.
void	enter(Iterable<InstanceIdentifier.PathArgument> path) 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.
<P extends DataObject> void	merge(InstanceIdentifier.PathArgument child, P data) Merge the specified data with the currently-present data at specified path.
<P extends DataObject> void	write(InstanceIdentifier.PathArgument child, P 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

BindingDOMDataTreeWriteCursorAdapter

public BindingDOMDataTreeWriteCursorAdapter(DataTreeIdentifier<?> path,
                                            T delegate,
                                            BindingToNormalizedNodeCodec codec)

Method Detail

delete

public void delete(InstanceIdentifier.PathArgument child)

Description copied from interface: DataTreeWriteCursor

Delete the specified child.

Specified by:

delete in interface DataTreeWriteCursor

Parameters:

child - Child identifier

merge

public <P extends DataObject> void merge(InstanceIdentifier.PathArgument child,
                                         P data)

Description copied from interface: DataTreeWriteCursor

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

Specified by:

merge in interface DataTreeWriteCursor

Parameters:

child - Child identifier

data - Data to be merged

write

public <P extends DataObject> void write(InstanceIdentifier.PathArgument child,
                                         P data)

Description copied from interface: DataTreeWriteCursor

Replace the data at specified path with supplied data.

Specified by:

write in interface DataTreeWriteCursor

Parameters:

child - Child identifier

data - New node data

enter

public void enter(InstanceIdentifier.PathArgument child)

Description copied from interface: DataTreeCursor

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

Specified by:

enter in interface DataTreeCursor

Parameters:

child - Child identifier

enter

public void enter(InstanceIdentifier.PathArgument... path)

Description copied from interface: DataTreeCursor

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 DataTreeCursor

Parameters:

path - Nested child identifier

enter

public void enter(Iterable<InstanceIdentifier.PathArgument> path)

Description copied from interface: DataTreeCursor

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 DataTreeCursor

Parameters:

path - Nested child identifier

exit

public void exit()

Description copied from interface: DataTreeCursor

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

Specified by:

exit in interface DataTreeCursor

exit

public void exit(int depth)

Description copied from interface: DataTreeCursor

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

Specified by:

exit in interface DataTreeCursor

Parameters:

depth - number of steps to exit

close

public void close()

Description copied from interface: DataTreeCursor

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 DataTreeCursor