Package org.opendaylight.yangtools.rfc7952.model.api

Interface AnnotationSchemaNode

All Superinterfaces:

AddedByUsesAware, CopyableNode, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatementEquivalent<UnknownEffectiveStatement<?,?>>, SchemaNode, TypeAware, UnknownSchemaNode

@Beta
public interface AnnotationSchemaNode
extends UnknownSchemaNode, TypeAware

Represents the effect of 'annotation' extension, as defined in RFC7952, being attached to a SchemaNode.

Nested Class Summary

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

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method	Description
AnnotationEffectiveStatement	asEffectiveStatement()	Return EffectiveStatement representation of this object.
static @NonNull Optional<AnnotationSchemaNode>	find(SchemaContext context, AnnotationName name)	Find specified annotation if it is supported by the specified SchemaContext.
static @NonNull Map<AnnotationName,AnnotationSchemaNode>	findAll(SchemaContext context)	Find all annotations supported by a SchemaContext.
default QName	getQName()	Returns QName of the instance of the type SchemaNode.
default @NonNull AnnotationName	name()

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

isAddedByUses

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

isAugmenting

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

getDescription, getReference, getUnknownSchemaNodes

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

getStatus

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

getType

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

getNodeParameter, getNodeType

Method Details

find

static @NonNull Optional<AnnotationSchemaNode> find(SchemaContext context,
 AnnotationName name)

Find specified annotation if it is supported by the specified SchemaContext.

Parameters:

context - SchemaContext to search

name - Annotation name

Returns:

AnnotationSchemaNode corresponding to specified name, or empty if it is not supported by the SchemaContext..

Throws:

NullPointerException - if any of the arguments is null

findAll

static @NonNull Map<AnnotationName,AnnotationSchemaNode> findAll(SchemaContext context)

Find all annotations supported by a SchemaContext.

Parameters:

context - SchemaContext to search

Returns:

AnnotationSchemaNodes supported by the SchemaContext..

Throws:

NullPointerException - if context is null

name

default @NonNull AnnotationName name()

getQName

default 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

asEffectiveStatement

AnnotationEffectiveStatement asEffectiveStatement()

Description copied from interface: EffectiveStatementEquivalent

Return EffectiveStatement representation of this object.

Specified by:

asEffectiveStatement in interface EffectiveStatementEquivalent<UnknownEffectiveStatement<?,?>>

Returns:

EffectiveStatement representation of this object.