Module org.opendaylight.yangtools.yang.parser.spi

Package org.opendaylight.yangtools.yang.parser.spi.meta

Interface OnDemandSchemaTreeStorage

All Superinterfaces:

NamespaceStorage

@Beta
public interface OnDemandSchemaTreeStorage
extends NamespaceStorage

Interface implemented by NamespaceStorages which support dynamic addition of child elements as they are requested. This means that such a node can, defer creation of child namespace storage nodes, in effect lazily expanding this namespace on an if-needed basis.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStorage

NamespaceStorage.GlobalStorage, NamespaceStorage.StorageType

Method Summary

Modifier and Type	Method	Description
<D extends DeclaredStatement<QName>, E extends SchemaTreeEffectiveStatement<D>> @Nullable StmtContext<QName,D,E>	requestSchemaTreeChild(QName qname)	Request that a new member of this node's schema tree statement be added.

Methods inherited from interface org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStorage

getAllFromLocalStorage, getFromLocalStorage, getParentStorage, getStorageType, putToLocalStorage, putToLocalStorageIfAbsent

Method Details

requestSchemaTreeChild

<D extends DeclaredStatement<QName>,
E extends SchemaTreeEffectiveStatement<D>>
@Nullable StmtContext<QName,D,E> requestSchemaTreeChild(QName qname)

Request that a new member of this node's schema tree statement be added. Implementations are required to perform lookup in their internal structure and create a child if tractable. Resulting node is expected to have been registered with local storage, so that it is accessible through NamespaceStorage.getFromLocalStorage(ParserNamespace, Object).

This method must not change its mind about a child's presence -- once it returns non-present, it has to be always returning non-present.

The results produced by this method are expected to be consistent with SchemaTreeAwareEffectiveStatement.findSchemaTreeNode(QName) and NamespaceBehaviours.SCHEMA_TREE's getFrom(NamespaceStorage, QName).

Parameters:

qname - node identifier of the child being requested

Returns:

Requested child, if it is present.

Throws:

NullPointerException - in qname is null