org.opendaylight.yangtools.sal.binding.model.api.type.builder

Interface EnumBuilder

All Superinterfaces:

Type

public interface EnumBuilder
extends Type

Enum Builder is interface that contains methods to build and instantiate Enumeration definition.

See Also:

Enumeration

Method Summary

Methods

Modifier and Type	Method and Description
AnnotationTypeBuilder	addAnnotation(String packageName, String name) The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
void	addValue(String name, Integer value, String description)
void	setDescription(String description)
Enumeration	toInstance(Type definingType)
void	updateEnumPairsFromEnumTypeDef(org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition enumTypeDef) Updates this builder with data from enumTypeDef.

Methods inherited from interface org.opendaylight.yangtools.sal.binding.model.api.Type

getFullyQualifiedName, getName, getPackageName

Method Detail

addAnnotation

AnnotationTypeBuilder addAnnotation(String packageName,
                                  String name)

The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
Neither the package name or annotation name can contain null references. In case that any of parameters contains null the method SHOULD thrown IllegalArgumentException

Parameters:

packageName - Package Name of Annotation Type

name - Name of Annotation Type

Returns:

new instance of Annotation Type Builder.

addValue

void addValue(String name,
            Integer value,
            String description)

Parameters:

name -

value -

toInstance

Enumeration toInstance(Type definingType)

Parameters:

definingType -

Returns:

updateEnumPairsFromEnumTypeDef

void updateEnumPairsFromEnumTypeDef(org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition enumTypeDef)

Updates this builder with data from enumTypeDef. Specifically this data represents list of value-name pairs.

Parameters:

enumTypeDef - enum type definition as source of enum data for enumBuilder

setDescription

void setDescription(String description)

Parameters:

description -