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

Class AbstractEffectiveDocumentedNode<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.AbstractEffectiveDocumentedNode<A,D>

All Implemented Interfaces:

DocumentedNode, EffectiveStatement<A,D>, ModelStatement<A>

Direct Known Subclasses:

AbstractConstraintEffectiveStatement, AbstractEffectiveDocumentedNodeWithStatus

@Beta
public abstract class AbstractEffectiveDocumentedNode<A,D extends DeclaredStatement<A>>
extends DeclaredEffectiveStatementBase<A,D>
implements DocumentedNode

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	AbstractEffectiveDocumentedNode(StmtContext<A,D,?> ctx)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDescription()	Returns the value of the argument of YANG description keyword.
Optional<String>	getReference()	Returns the value of the argument of YANG reference keyword.
protected static @NonNull Object	maskList(ImmutableList<?> list)	Utility method for squashing singleton lists into single objects.
protected static @NonNull Object	maskSet(ImmutableSet<?> set)
protected @Nullable String	nullableDescription()
protected @Nullable String	nullableReference()
protected static <T> @NonNull ImmutableList<T>	unmaskList(@NonNull Object masked, @NonNull Class<T> type)	Utility method for recovering singleton lists squashed by maskList(ImmutableList).
protected static <T> @NonNull ImmutableSet<? extends T>	unmaskSet(@NonNull Object masked, @NonNull Class<T> type)

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, getNamespaceContents, 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

getUnknownSchemaNodes

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

findAll, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, streamEffectiveSubstatements

Constructor Detail

AbstractEffectiveDocumentedNode

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

Method Detail

getDescription

public final Optional<String> getDescription()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG description keyword.

Specified by:

getDescription in interface DocumentedNode

Returns:

string with the description, or empty if description was not provided.

getReference

public final Optional<String> getReference()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG reference keyword.

Specified by:

getReference in interface DocumentedNode

Returns:

string with reference to some other document, or empty if reference was not provided.

nullableDescription

protected final @Nullable String nullableDescription()

nullableReference

protected final @Nullable String nullableReference()

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<? extends T> unmaskSet(@NonNull Object masked,
                                                                        @NonNull Class<T> type)