AnnotationSchemaNode (yangtools-docs 7.0.13 API)

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

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AnnotationEffectiveStatement`	`asEffectiveStatement()`	Return `EffectiveStatement` representation of this object.
`static @NonNull Optional<AnnotationSchemaNode>`	`find(SchemaContext context, QName qname)`	Find specified annotation if it is supported by the specified SchemaContext.
`static @NonNull Map<QName,AnnotationSchemaNode>`	`findAll(SchemaContext context)`	Find all annotations supported by a SchemaContext.

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.SchemaNode
getPath, getQName

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

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode
getExtensionDefinition, getNodeParameter, getNodeType

- Method Detail
  - find
```
static @NonNull Optional<AnnotationSchemaNode> find(SchemaContext context,
                                                    QName qname)
```
    Find specified annotation if it is supported by the specified SchemaContext.
    
    Parameters:
    
    context - SchemaContext to search
    
    qname - 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<QName,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
  - 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.