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

Class AbstractDeclaredEffectiveStatement<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>

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>

Direct Known Subclasses:

AbstractDeclaredEffectiveStatement.Default, AbstractDeclaredEffectiveStatement.WithSchemaTree, AbstractEffectiveUnknownSchmemaNode

@Beta
public abstract non-sealed class AbstractDeclaredEffectiveStatement<A,D extends DeclaredStatement<A>>
extends AbstractEffectiveStatement<A,D>

Base stateless superclass for statements which (logically) always have an associated DeclaredStatement. This is notably not true for all case statements, some of which may actually be implied.

Note implementations are not strictly required to make the declared statement available, they are free to throw UnsupportedOperationException from getDeclared(), rendering any services relying on declared statement to be not available.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDeclaredEffectiveStatement.Default<A,D extends DeclaredStatement<A>>	A stateful version of AbstractDeclaredEffectiveStatement, which holds (and requires) a declared statement.
static class	AbstractDeclaredEffectiveStatement.DefaultArgument<A,D extends DeclaredStatement<A>>	An extra building block on top of AbstractDeclaredEffectiveStatement.Default, which is wiring AbstractDeclaredEffectiveStatement.DefaultArgument.argument() to the declared statement.
static class	AbstractDeclaredEffectiveStatement.DefaultWithArgument<A,D extends DeclaredStatement<A>>	A building block on top of AbstractDeclaredEffectiveStatement.Default, which adds an explicit argument value, which is not related to the context.
static class	AbstractDeclaredEffectiveStatement.DefaultWithDataTree<A,D extends DeclaredStatement<A>>	Stateful version of AbstractDeclaredEffectiveStatement.WithDataTree.
static class	AbstractDeclaredEffectiveStatement.DefaultWithSchemaTree<A,D extends DeclaredStatement<A>>	Stateful version of AbstractDeclaredEffectiveStatement.WithSchemaTree.
static class	AbstractDeclaredEffectiveStatement.WithDataTree<A,D extends DeclaredStatement<A>>	Base stateless superclass for DataTreeAwareEffectiveStatements.
static class	AbstractDeclaredEffectiveStatement.WithSchemaTree<A,D extends DeclaredStatement<A>>	Base stateless superclass form SchemaTreeAwareEffectiveStatements.

Constructor Summary

Constructors

Constructor	Description
AbstractDeclaredEffectiveStatement()

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)
ImmutableList<? extends EffectiveStatement<?,?>>	effectiveSubstatements()	Returns a collection of all effective substatements.
final boolean	equals(Object obj)
abstract @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 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.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.meta.EffectiveStatement

collectEffectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, statementOrigin, streamEffectiveSubstatements

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

argument, statementDefinition

Constructor Details

AbstractDeclaredEffectiveStatement

public AbstractDeclaredEffectiveStatement()

Method Details

getDeclared

public abstract @NonNull D getDeclared()

Description copied from interface: EffectiveStatement

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

Returns:

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

effectiveSubstatements

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

Description copied from interface: EffectiveStatement

Returns a collection of all effective substatements.

Returns:

collection of all effective substatements.

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)