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

Interface Enumeration

All Superinterfaces:

DocumentedType, GeneratedType, Type

@Beta
public interface Enumeration
extends GeneratedType

Interface provide methods for reading data of enumeration class.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Enumeration.Pair Interface is used for reading enumeration item.

Method Summary

Modifier and Type	Method and Description
List<AnnotationType>	getAnnotations() Returns list of annotation definitions associated with enumeration type.
Type	getParentType() Returns the parent type if Generated Type is defined as enclosing type, otherwise returns null
List<Enumeration.Pair>	getValues() Returns list of the couples - name and value.
String	toFormattedString() Formats enumeration according to rules of the programming language.

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

getBindingNamespaceType, getComment, getConstantDefinitions, getEnclosedTypes, getEnumerations, getImplements, getMethodDefinitions, getParentTypeForBuilder, getProperties, getYangSourceDefinition, isAbstract

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

getFullyQualifiedName, getName, getPackageName

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

getDescription, getModuleName, getReference, getSchemaPath

Method Detail

getAnnotations

List<AnnotationType> getAnnotations()

Returns list of annotation definitions associated with enumeration type.

Specified by:

getAnnotations in interface GeneratedType

Returns:

list of annotation definitions associated with enumeration type.

getParentType

Type getParentType()

Description copied from interface: GeneratedType

Returns the parent type if Generated Type is defined as enclosing type, otherwise returns null

Specified by:

getParentType in interface GeneratedType

Returns:

the parent type if Generated Type is defined as enclosing type, otherwise returns null

getValues

List<Enumeration.Pair> getValues()

Returns list of the couples - name and value.

Returns:

list of the enumeration pairs.

toFormattedString

String toFormattedString()

Formats enumeration according to rules of the programming language.

Returns:

string with source code in some programming language