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

Interface DataTreeTip

All Known Subinterfaces:

DataTree, DataTreeCandidateTip

All Known Implementing Classes:

InMemoryDataTree

@Beta
@NonNullByDefault
public interface DataTreeTip

Tip of a data tree instance. It acts as a point to which modifications can be applied.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)	DataTreeTip implementations must not override the default identity hashCode method, meaning their equals implementation must result in identity comparison.
int	hashCode()	DataTreeTip implementations must not override the default identity hashCode method.
DataTreeCandidateTip	prepare(DataTreeModification modification)	Prepare a modification for commit.
void	validate(DataTreeModification modification)	Validate whether a particular modification can be applied to the data tree.

Method Detail

validate

void validate(DataTreeModification modification)
       throws DataValidationFailedException

Validate whether a particular modification can be applied to the data tree.

Parameters:

modification - Data tree modification.

Throws:

DataValidationFailedException - If modification data is not valid.

NullPointerException - if modification is null

IllegalArgumentException - if modification is unrecognized

DataValidationFailedException - if modification would result in inconsistent data tree

prepare

DataTreeCandidateTip prepare(DataTreeModification modification)
                      throws DataValidationFailedException

Prepare a modification for commit.

Parameters:

modification - Data tree modification.

Returns:

candidate data tree

Throws:

NullPointerException - if modification is null

IllegalArgumentException - if modification is unrecognized

DataValidationFailedException - if modification would result in inconsistent data tree

hashCode

int hashCode()

DataTreeTip implementations must not override the default identity hashCode method.

Overrides:

hashCode in class Object

equals

boolean equals(@Nullable Object obj)

DataTreeTip implementations must not override the default identity hashCode method, meaning their equals implementation must result in identity comparison.

Overrides:

equals in class Object