org.opendaylight.mdsal.binding.javav2.model.api

Interface AnnotationType

All Superinterfaces:

Comparable<AnnotationType>, Type

@Beta
public interface AnnotationType
extends Type, Comparable<AnnotationType>

The Annotation Type interface is designed to hold information about annotation for any type that could be annotated in Java.
For sake of simplicity the Annotation Type is not designed to model exact behaviour of annotation mechanism, but just to hold information needed to model annotation over java Type definition. By using in collections, implementations are expected to implement hashCode() and equals(Object) methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AnnotationType.Parameter Annotation Type parameter interface.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AnnotationType o)
default boolean	containsParameters() Returns true if annotation contains parameters.
boolean	equals(Object o)
List<AnnotationType>	getAnnotations() Returns the List of Annotations.
AnnotationType.Parameter	getParameter(String paramName) Returns Parameter Definition assigned for given parameter name.
List<String>	getParameterNames() Returns List of parameter names.
List<AnnotationType.Parameter>	getParameters() Returns List of all parameters assigned to Annotation Type.
int	hashCode()

Methods inherited from interface org.opendaylight.mdsal.binding.javav2.model.api.Type

getFullyQualifiedName, getName, getPackageName

Method Detail

getAnnotations

List<AnnotationType> getAnnotations()

Returns the List of Annotations.
Each Annotation Type MAY have defined multiple Annotations.

Returns:

the List of Annotations.

getParameter

AnnotationType.Parameter getParameter(String paramName)

Returns Parameter Definition assigned for given parameter name.
If Annotation does not contain parameter with specified param name, the method MAY return null value.

Parameters:

paramName - Parameter Name

Returns:

Parameter Definition assigned for given parameter name.

getParameters

List<AnnotationType.Parameter> getParameters()

Returns List of all parameters assigned to Annotation Type.

Returns:

List of all parameters assigned to Annotation Type.

getParameterNames

List<String> getParameterNames()

Returns List of parameter names.

Returns:

List of parameter names.

containsParameters

default boolean containsParameters()

Returns true if annotation contains parameters.

Returns:

true if annotation contains parameters.

equals

boolean equals(Object o)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

compareTo

int compareTo(AnnotationType o)

Specified by:

compareTo in interface Comparable<AnnotationType>