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

Class AbstractEffectiveSimpleDataNodeContainer<D extends DeclaredStatement<QName>>

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<QName,D>

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveSimpleDataNodeContainer<D>

All Implemented Interfaces:

AddedByUsesAware, AugmentationTarget, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<QName,D>, ModelStatement<QName>, SchemaNode, WhenConditionAware

Direct Known Subclasses:

AbstractEffectiveMustConstraintAwareSimpleDataNodeContainer

public abstract class AbstractEffectiveSimpleDataNodeContainer<D extends DeclaredStatement<QName>>
extends AbstractEffectiveDocumentedDataNodeContainer<QName,D>
implements AugmentationTarget, DataSchemaNode

Nested Class Summary

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

DocumentedNode.WithStatus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEffectiveSimpleDataNodeContainer(StmtContext<QName,D,?> ctx)

Method Summary

Modifier and Type	Method and Description
Set<AugmentationSchemaNode>	getAvailableAugmentations() Returns augmentations targeting this element.
SchemaPath	getPath() Returns the schema path of the instance of the type SchemaNode.
QName	getQName() Returns QName of the instance of the type SchemaNode.
Optional<RevisionAwareXPath>	getWhenCondition() Returns when statement.
boolean	isAddedByUses() Deprecated.
boolean	isAugmenting() Deprecated.
boolean	isConfiguration() Returns true if the data represents configuration data, otherwise returns false.
protected static @NonNull Object	maskList(ImmutableList<?> list) Utility method for squashing singleton lists into single objects.
void	resetAugmenting() Deprecated. This method is a violation of immutable contract and is a side-effect of bad/incomplete lifecycle, which needs to be fixed. Do not introduce new callers. This deficiency is tracked in YANGTOOLS-724.
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.AbstractEffectiveDocumentedDataNodeContainer

findDataChildByName, getChildNodes, getGroupings, getTypeDefinitions, getUses

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

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, 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.DocumentedNode.WithStatus

getStatus

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

getDescription, getReference, getUnknownSchemaNodes

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.meta.EffectiveStatement

findAll, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, streamEffectiveSubstatements

Constructor Detail

AbstractEffectiveSimpleDataNodeContainer

protected AbstractEffectiveSimpleDataNodeContainer(StmtContext<QName,D,?> ctx)

Method Detail

getQName

public QName getQName()

Description copied from interface: SchemaNode

Returns QName of the instance of the type SchemaNode.

Specified by:

getQName in interface SchemaNode

Returns:

QName with the name of the schema node

getPath

public SchemaPath getPath()

Description copied from interface: SchemaNode

Returns the schema path of the instance of the type SchemaNode.

Specified by:

getPath in interface SchemaNode

Returns:

schema path of the schema node

isAugmenting

@Deprecated
public boolean isAugmenting()

Deprecated.

Description copied from interface: CopyableNode

Returns true if this node was added by augmentation, otherwise returns false.

Specified by:

isAugmenting in interface CopyableNode

Returns:

true if this node was added by augmentation, otherwise returns false

isAddedByUses

@Deprecated
public boolean isAddedByUses()

Deprecated.

Description copied from interface: AddedByUsesAware

Returns true if this node was added by uses statement, otherwise returns false.

Specified by:

isAddedByUses in interface AddedByUsesAware

Returns:

true if this node was added by uses statement, otherwise returns false

isConfiguration

public boolean isConfiguration()

Description copied from interface: DataSchemaNode

Returns true if the data represents configuration data, otherwise returns false.

Specified by:

isConfiguration in interface DataSchemaNode

Returns:

true if the data represents configuration data, otherwise returns false

getAvailableAugmentations

public Set<AugmentationSchemaNode> getAvailableAugmentations()

Description copied from interface: AugmentationTarget

Returns augmentations targeting this element.

Specified by:

getAvailableAugmentations in interface AugmentationTarget

Returns:

set of augmentations targeting this element.

getWhenCondition

public final Optional<RevisionAwareXPath> getWhenCondition()

Description copied from interface: WhenConditionAware

Returns when statement.

If when condition is present node defined by the parent data definition statement is only valid when the returned XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.

Specified by:

getWhenCondition in interface WhenConditionAware

Returns:

XPath condition

resetAugmenting

@Deprecated
public final void resetAugmenting()

Deprecated. This method is a violation of immutable contract and is a side-effect of bad/incomplete lifecycle, which needs to be fixed. Do not introduce new callers. This deficiency is tracked in YANGTOOLS-724.

Reset isAugmenting() to false.

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