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

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

java.lang.Object

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, DocumentedNode.WithStatus, EffectiveStatement<A,D>, ModelStatement<A>

Direct Known Subclasses:

AbstractSchemaEffectiveDocumentedNode, BitEffectiveStatementImpl, EnumEffectiveStatementImpl, RefineEffectiveStatementImpl

public abstract class AbstractEffectiveDocumentedNode<A,D extends DeclaredStatement<A>>
extends DeclaredEffectiveStatementBase<A,D>
implements DocumentedNode.WithStatus

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

Method Summary

Modifier and Type	Method and 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.
Status	getStatus() Returns status of the instance of the type SchemaNode.

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, firstEffective, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, get, getAll, getNamespaceContents, initSubstatements

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)

Constructor.

Parameters:

ctx - context of statement.

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.

getStatus

public final Status getStatus()

Description copied from interface: DocumentedNode.WithStatus

Returns status of the instance of the type SchemaNode.

Specified by:

getStatus in interface DocumentedNode.WithStatus

Returns:

status of this node which represents the argument of the YANG status substatement