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

Interface DataTreeFactory

All Known Implementing Classes:

InMemoryDataTreeFactory

public interface DataTreeFactory

Factory interface for creating data trees.

Method Summary

Modifier and Type	Method and Description
DataTree	create(DataTreeConfiguration treeConfig) Create a new data tree based on specified configuration, with a best-guess root.
DataTree	create(DataTreeConfiguration treeConfig, SchemaContext initialSchemaContext) Create a new data tree based on specified configuration, with a root node derived from the schema context lookup of the configuration.
DataTree	create(DataTreeConfiguration treeConfig, SchemaContext initialSchemaContext, NormalizedNodeContainer<?,?,?> initialRoot) Create a new data tree based on specified configuration, with the specified node.

Method Detail

create

DataTree create(DataTreeConfiguration treeConfig)

Create a new data tree based on specified configuration, with a best-guess root. Use this method only if you do not have a corresponding SchemaContext handy. Mandatory nodes whose enforcement point is the root node will not be enforced even if some are present in the SchemaContext and validation is requested in configuration.

Correctness note: this method may not accurately initialize the root node in certain non-root scenarios due to the impossibility to accurately derive root type from plain YangInstanceIdentifier. Using create(DataTreeConfiguration, SchemaContext) is recommended, as it does not suffer from this shortcoming.

Parameters:

treeConfig - Tree configuration.

Returns:

A data tree instance.

Throws:

NullPointerException - if treeConfig is null

create

DataTree create(DataTreeConfiguration treeConfig,
                SchemaContext initialSchemaContext)

Create a new data tree based on specified configuration, with a root node derived from the schema context lookup of the configuration. Mandatory nodes whose enforcement point is the root node will not be enforced even if some are present in the SchemaContext and validation is requested in configuration.

Parameters:

treeConfig - Tree configuration.

Returns:

A data tree instance.

Throws:

NullPointerException - if any of the arguments are null

IllegalArgumentException - if tree configuration does not match the SchemaContext, for example by root path referring to a node which does not exist in the SchemaContext

create

DataTree create(DataTreeConfiguration treeConfig,
                SchemaContext initialSchemaContext,
                NormalizedNodeContainer<?,?,?> initialRoot)
         throws DataValidationFailedException

Create a new data tree based on specified configuration, with the specified node.

Parameters:

treeConfig - Tree configuration.

Returns:

A data tree instance.

Throws:

DataValidationFailedException - if initial root is not valid according to the schema context

NullPointerException - if any of the arguments are null

IllegalArgumentException - if a mismatch between the arguments is detected