org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective

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

java.lang.Object

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AbstractEffectiveDocumentedNode<A,D>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEffectiveSchemaNode, AugmentEffectiveStatementImpl, BitEffectiveStatementImpl, CaseEffectiveStatementImpl, ContainerEffectiveStatementImpl, EnumEffectiveStatementImpl, ExtensionEffectiveStatementImpl, GroupingEffectiveStatementImpl, InputEffectiveStatementImpl, ListEffectiveStatementImpl, ModuleEffectiveStatementImpl, NotificationEffectiveStatementImpl, OutputEffectiveStatementImpl, RefineEffectiveStatementImpl, SubmoduleEffectiveStatementImpl, UnknownEffectiveStatementBase, UsesEffectiveStatementImpl

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
String	getDescription() All implementations should override this method.
String	getReference() All implementations should override this method.
Status	getStatus() Returns status of the instance of the type SchemaNode

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase

argument, getDeclared, getStatementSource, statementDefinition

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase

allSubstatementsOfType, effectiveSubstatements, firstEffective, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, get, getAll

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

Constructor Detail

AbstractEffectiveDocumentedNode

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

Constructor.

Parameters:

ctx - context of statement.

Method Detail

getDescription

public final String getDescription()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a description statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a description statement.

Specified by:

getDescription in interface DocumentedNode

Returns:

string that represents the argument of description statement

getReference

public final String getReference()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a reference statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a reference statement.

Specified by:

getReference in interface DocumentedNode

Returns:

string that represents the argument of reference statement

getStatus

@Nonnull
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