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

Class AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D extends DeclaredStatement<A>>

java.lang.Object

org.opendaylight.yangtools.yang.model.api.meta.AbstractEffectiveStatement<A,D>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement<A,D>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithSchemaTree<A,D>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithDataTree<A,D>

org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D>

Type Parameters:

A - Argument type (Empty if statement does not have argument.)

D - Class representing declared version of this statement.

All Implemented Interfaces:

EffectiveStatement<A,D>, ModelStatement<A>, DataTreeAwareEffectiveStatement<A,D>, SchemaTreeAwareEffectiveStatement<A,D>

Direct Known Subclasses:

AbstractChoiceEffectiveStatement, AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithTypedefNamespace, DeclaredCaseEffectiveStatement

Enclosing class:

AbstractDeclaredEffectiveStatement<A,D extends DeclaredStatement<A>>

public abstract static class AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D extends DeclaredStatement<A>>
extends AbstractDeclaredEffectiveStatement.WithDataTree<A,D>

Stateful version of AbstractDeclaredEffectiveStatement.WithDataTree. Schema tree and data tree namespaces are eagerly instantiated (and checked).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithTypedefNamespace<A,D extends DeclaredStatement<A>>

Nested classes/interfaces inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement

AbstractDeclaredEffectiveStatement.Default<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultArgument<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultWithArgument<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.DefaultWithSchemaTree<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.WithDataTree<A,D extends DeclaredStatement<A>>, AbstractDeclaredEffectiveStatement.WithSchemaTree<A,D extends DeclaredStatement<A>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultWithDataTree(D declared, ImmutableList<? extends EffectiveStatement<?,?>> substatements)
protected	DefaultWithDataTree(AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D> original)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper helper)
protected static @NonNull Map<QName,DataTreeEffectiveStatement<?>>	createDataTreeNamespace(Collection<SchemaTreeEffectiveStatement<?>> schemaTreeStatements, Map<QName,SchemaTreeEffectiveStatement<?>> schemaTreeNamespace)
protected static @NonNull Map<QName,SchemaTreeEffectiveStatement<?>>	createSchemaTreeNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)	Create a Map containing the contents of the schema tree.
protected static @NonNull HashMap<QName,TypedefEffectiveStatement>	createTypedefNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)
final Collection<DataTreeEffectiveStatement<?>>	dataTreeNodes()	Return the mapping of data tree children of this statement.
final ImmutableList<? extends EffectiveStatement<?,?>>	effectiveSubstatements()	Returns a collection of all effective substatements.
final boolean	equals(Object obj)
final Optional<DataTreeEffectiveStatement<?>>	findDataTreeNode(QName qname)	Find a data tree child DataTreeEffectiveStatement, as identified by its QName argument.
final Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(QName qname)	Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.
final @NonNull D	getDeclared()	Returns statement, which was explicit declaration of this effective statement.
final int	hashCode()
protected static <T extends SchemaTreeEffectiveStatement<?>> @NonNull Map<QName,T>	immutableNamespaceOf(Map<QName,T> map)
protected static final @NonNull Object	maskList(ImmutableList<?> list)	Utility method for squashing singleton lists into single objects.
protected static final @NonNull Object	maskSet(ImmutableSet<?> set)
final Collection<SchemaTreeEffectiveStatement<?>>	schemaTreeNodes()	Enumerate all schema nodes defined within this node.
final String	toString()
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).
protected static final <T> @NonNull ImmutableSet<T>	unmaskSet(@NonNull Object masked, @NonNull Class<T> type)

Methods inherited from class org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.WithSchemaTree

dataSchemaNode

Methods inherited from class org.opendaylight.yangtools.yang.model.api.meta.AbstractEffectiveStatement

filterOptional, findValue, unmaskList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement

findDataTreeNode

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

collectEffectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, statementOrigin, streamEffectiveSubstatements

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

argument, statementDefinition

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement

findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode

Constructor Details

DefaultWithDataTree

protected DefaultWithDataTree(D declared,
 ImmutableList<? extends EffectiveStatement<?,?>> substatements)

DefaultWithDataTree

protected DefaultWithDataTree(AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D> original)

Method Details

getDeclared

public final @NonNull D getDeclared()

Description copied from interface: EffectiveStatement

Returns statement, which was explicit declaration of this effective statement.

Specified by:

getDeclared in interface EffectiveStatement<A,D extends DeclaredStatement<A>>

Specified by:

getDeclared in class AbstractDeclaredEffectiveStatement<A,D extends DeclaredStatement<A>>

Returns:

statement, which was explicit declaration of this effective statement or null if statement was inferred from context.

effectiveSubstatements

public final ImmutableList<? extends EffectiveStatement<?,?>> effectiveSubstatements()

Description copied from interface: EffectiveStatement

Returns a collection of all effective substatements.

Specified by:

effectiveSubstatements in interface EffectiveStatement<A,D extends DeclaredStatement<A>>

Returns:

collection of all effective substatements.

schemaTreeNodes

public final Collection<SchemaTreeEffectiveStatement<?>> schemaTreeNodes()

Description copied from interface: SchemaTreeAwareEffectiveStatement

Enumerate all schema nodes defined within this node.

Returns:

All substatements participating on the schema tree

findSchemaTreeNode

public final Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(QName qname)

Description copied from interface: SchemaTreeAwareEffectiveStatement

Find a schema tree child SchemaTreeEffectiveStatement, as identified by its QName argument.

Parameters:

qname - Child identifier

Returns:

Schema tree child, or empty

dataTreeNodes

public final Collection<DataTreeEffectiveStatement<?>> dataTreeNodes()

Description copied from interface: DataTreeAwareEffectiveStatement

Return the mapping of data tree children of this statement. This is a subtree of SchemaTreeAwareEffectiveStatement.schemaTreeNodes() in that all data nodes are also schema nodes. The structure of the tree is different, though, as choice and case statements are glossed over and they do not contribute to the tree hierarchy -- only their children do.

Note that returned statements are not necessarily direct substatements of this statement.

Returns:

All substatements participating on the data tree

findDataTreeNode

public final Optional<DataTreeEffectiveStatement<?>> findDataTreeNode(QName qname)

Description copied from interface: DataTreeAwareEffectiveStatement

Find a data tree child DataTreeEffectiveStatement, as identified by its QName argument.

Parameters:

qname - Child identifier

Returns:

Data tree child, or empty

createSchemaTreeNamespace

protected static @NonNull Map<QName,SchemaTreeEffectiveStatement<?>> createSchemaTreeNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)

Create a Map containing the contents of the schema tree. Retur

Parameters:

substatements - Substatements to index

Returns:

Index of the schema tree as a mutable Map

Throws:

NullPointerException - if substatements is null

createDataTreeNamespace

protected static @NonNull Map<QName,DataTreeEffectiveStatement<?>> createDataTreeNamespace(Collection<SchemaTreeEffectiveStatement<?>> schemaTreeStatements,
 Map<QName,SchemaTreeEffectiveStatement<?>> schemaTreeNamespace)

immutableNamespaceOf

protected static <T extends SchemaTreeEffectiveStatement<?>>
@NonNull Map<QName,T> immutableNamespaceOf(Map<QName,T> map)

createTypedefNamespace

protected static @NonNull HashMap<QName,TypedefEffectiveStatement> createTypedefNamespace(Collection<? extends EffectiveStatement<?,?>> substatements)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper helper)

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

maskSet

protected static final @NonNull Object maskSet(ImmutableSet<?> set)

unmaskSet

protected static final <T> @NonNull ImmutableSet<T> unmaskSet(@NonNull Object masked,
 @NonNull Class<T> type)