Package org.opendaylight.yangtools.yang.parser.rfc7950.stmt

Class AbstractEffectiveDocumentedDataNodeContainer<A,D extends DeclaredStatement<A>>

java.lang.Object

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveStatement<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.DeclaredEffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNodeWithoutStatus<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNode<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractSchemaEffectiveDocumentedNode<A,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedDataNodeContainer<A,D>

All Implemented Interfaces:

DataNodeContainer, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<A,D>, ModelStatement<A>

Direct Known Subclasses:

AbstractEffectiveSimpleDataNodeContainer

@Deprecated(forRemoval=true)
public abstract class AbstractEffectiveDocumentedDataNodeContainer<A,D extends DeclaredStatement<A>>
extends AbstractSchemaEffectiveDocumentedNode<A,D>
implements DataNodeContainer

Deprecated, for removal: This API element is subject to removal in a future version.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEffectiveDocumentedDataNodeContainer(StmtContext<A,D,?> ctx)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
Optional<DataSchemaNode>	findDataChildByName(QName name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the child node corresponding to the specified name.
Set<DataSchemaNode>	getChildNodes()	Deprecated, for removal: This API element is subject to removal in a future version. Returns set of all child nodes defined within this DataNodeContainer.
Set<GroupingDefinition>	getGroupings()	Deprecated, for removal: This API element is subject to removal in a future version. Returns set of all groupings defined within this DataNodeContainer.
Set<TypeDefinition<?>>	getTypeDefinitions()	Deprecated, for removal: This API element is subject to removal in a future version. Returns set of all newly defined types within this DataNodeContainer.
Set<UsesNode>	getUses()	Deprecated, for removal: This API element is subject to removal in a future version. Returns grouping nodes used ny this container.
protected static @NonNull Object	maskList(ImmutableList<?> list)	Utility method for squashing singleton lists into single objects.
protected static <T> @NonNull ImmutableList<T>	unmaskList(@NonNull Object masked, @NonNull Class<T> type)	Utility method for recovering singleton lists squashed by maskList(ImmutableList).

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractSchemaEffectiveDocumentedNode

derivedSet, findDataSchemaNode, getNamespaceContents

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNode

getStatus, getUnknownSchemaNodes

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNodeWithoutStatus

getDescription, getReference, nullableDescription, nullableReference

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.DeclaredEffectiveStatementBase

argument, getDeclared, getStatementSource, statementDefinition

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementBase

allSubstatementsOfType, effectiveSubstatements, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, initSubstatements

Methods inherited from class org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveStatement

get, getAll, unmaskList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer

findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement

findAll, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, streamEffectiveSubstatements

Constructor Detail

AbstractEffectiveDocumentedDataNodeContainer

protected AbstractEffectiveDocumentedDataNodeContainer(StmtContext<A,D,?> ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

getTypeDefinitions

public final Set<TypeDefinition<?>> getTypeDefinitions()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DataNodeContainer

Returns set of all newly defined types within this DataNodeContainer.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Returns:

typedef statements in lexicographical order

getChildNodes

public final Set<DataSchemaNode> getChildNodes()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DataNodeContainer

Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.

Note that the nodes returned are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are present instead of their children. This is consistent with schema tree.

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

getGroupings

public final Set<GroupingDefinition> getGroupings()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DataNodeContainer

Returns set of all groupings defined within this DataNodeContainer.

Specified by:

getGroupings in interface DataNodeContainer

Returns:

grouping statements in lexicographical order

findDataChildByName

public final Optional<DataSchemaNode> findDataChildByName(QName name)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DataNodeContainer

Returns the child node corresponding to the specified name.

Note that the nodes searched are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are returned instead of their matching children.

Specified by:

findDataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

child node of this DataNodeContainer if child with given name is present, empty otherwise

getUses

public Set<UsesNode> getUses()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: DataNodeContainer

Returns grouping nodes used ny this container.

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer

maskList

protected static final @NonNull Object maskList(ImmutableList<?> list)

Utility method for squashing singleton lists into single objects. This is a CPU/mem trade-off, which we are usually willing to make: for the cost of an instanceof check we can save one object and re-create it when needed. The inverse operation is #unmaskSubstatements(Object)}.

Parameters:

list - list to mask

Returns:

Masked list

Throws:

NullPointerException - if list is null

unmaskList

protected static final <T> @NonNull ImmutableList<T> unmaskList(@NonNull Object masked,
                                                                @NonNull Class<T> type)

Utility method for recovering singleton lists squashed by maskList(ImmutableList).

Parameters:

masked - list to unmask

Returns:

Unmasked list

Throws:

NullPointerException - if any argument is null

ClassCastException - if masked object does not match expected class