org.opendaylight.mdsal.binding.javav2.generator.yang.types

Class TypeProviderImpl

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl

All Implemented Interfaces:

TypeProvider

@Beta
public final class TypeProviderImpl
extends Object
implements TypeProvider

Constructor Summary

Constructors

Constructor and Description
TypeProviderImpl(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext) Creates new instance of class TypeProviderImpl.

Method Summary

Modifier and Type	Method and Description
static void	addUnitsToGenTO(GeneratedTOBuilder to, String units)
Type	generatedTypeForExtendedDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode) Converts typeDefinition to concrete JAVA Type.
Map<org.opendaylight.yangtools.yang.model.api.Module,Set<Type>>	getAdditionalTypes()
String	getConstructorPropertyName(org.opendaylight.yangtools.yang.model.api.SchemaNode node)
Map<String,Map<Optional<org.opendaylight.yangtools.yang.common.Revision>,Map<String,Type>>>	getGenTypeDefsContextMap()
String	getParamNameFromType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)
String	getTypeDefaultConstruction(org.opendaylight.yangtools.yang.model.api.LeafSchemaNode node) Returns string containing code for creation of new type instance.
Type	javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, ModuleContext context) Resolve of yang Type Definition to its java counter part.
Type	javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, Restrictions restrictions, ModuleContext context) Converts schema definition type typeDefinition to JAVA Type.
GeneratedTOBuilder	provideGeneratedTOBuilderForBitsTypeDefinition(String basePackageName, org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef, String typeDefName, String moduleName, ModuleContext context) Converts typeDef which should be of the type BitsTypeDefinition to GeneratedTOBuilder.
GeneratedTOBuilder	provideGeneratedTOBuilderForUnionTypeDef(String basePackageName, org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef, String typeDefName, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, ModuleContext context) Converts output list of generated TO builders to one TO builder (first from list) which contains the remaining builders as its enclosing TO.
List<GeneratedTOBuilder>	provideGeneratedTOBuildersForUnionTypeDef(String basePackageName, org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef, String typeDefName, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, ModuleContext context) Converts typedef to generated TO with typeDefName.
Type	provideTypeForLeafref(org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition leafrefType, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, ModuleContext context) Converts leafrefType to JAVA Type.
void	putReferencedType(org.opendaylight.yangtools.yang.model.api.SchemaPath refTypePath, Type refType) Puts refType to map with key refTypePath.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeProviderImpl

public TypeProviderImpl(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Creates new instance of class TypeProviderImpl.

Parameters:

schemaContext - contains the schema data red from YANG files

Throws:

IllegalArgumentException - if schemaContext equal null.

Method Detail

javaTypeForSchemaDefinitionType

public Type javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type,
                                            org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode,
                                            ModuleContext context)

Description copied from interface: TypeProvider

Resolve of yang Type Definition to its java counter part. If the Type Definition contains one of yang primitive types the method will return java.lang. counterpart. (For example if yang type is int32 the java counterpart is java.lang.Integer). In case that Type Definition contains extended type defined via yang typedef statement the method SHOULD return Generated Type or Generated Transfer Object if that Type is correctly referenced to resolved imported yang module. The method will return null value in situations that TypeDefinition can't be resolved (either due missing yang import or incorrectly specified type).

Specified by:

javaTypeForSchemaDefinitionType in interface TypeProvider

Parameters:

type - Type Definition to resolve from

parentNode - parent node

Returns:

Resolved Type

javaTypeForSchemaDefinitionType

public Type javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type,
                                            org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode,
                                            Restrictions restrictions,
                                            ModuleContext context)

Converts schema definition type typeDefinition to JAVA Type.

Specified by:

javaTypeForSchemaDefinitionType in interface TypeProvider

Parameters:

type - type definition which is converted to JAVA type

parentNode - parent node

restrictions - restrictions applied to given type definition

Returns:

Resolved Type

Throws:

IllegalArgumentException -

• if typeDefinition equal null
• if QName of typeDefinition equal null
• if name of typeDefinition equal null

getTypeDefaultConstruction

public String getTypeDefaultConstruction(org.opendaylight.yangtools.yang.model.api.LeafSchemaNode node)

Description copied from interface: TypeProvider

Returns string containing code for creation of new type instance.

Specified by:

getTypeDefaultConstruction in interface TypeProvider

Parameters:

node - Schema node to resolve from

Returns:

String representing default construction

getConstructorPropertyName

public String getConstructorPropertyName(org.opendaylight.yangtools.yang.model.api.SchemaNode node)

Specified by:

getConstructorPropertyName in interface TypeProvider

Parameters:

node - Schema node to resolve from

Returns:

String representing constructor property name

getParamNameFromType

public String getParamNameFromType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)

Specified by:

getParamNameFromType in interface TypeProvider

Parameters:

type - Type Definition to resolve from

Returns:

String representing parameter name

getGenTypeDefsContextMap

public Map<String,Map<Optional<org.opendaylight.yangtools.yang.common.Revision>,Map<String,Type>>> getGenTypeDefsContextMap()

generatedTypeForExtendedDefinitionType

public Type generatedTypeForExtendedDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition,
                                                   org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode)

Converts typeDefinition to concrete JAVA Type.

Parameters:

typeDefinition - type definition which should be converted to JAVA Type

Returns:

JAVA Type which represents typeDefinition

Throws:

IllegalArgumentException -

• if typeDefinition equal null
• if Q name of typeDefinition
• if name of typeDefinition

putReferencedType

public void putReferencedType(org.opendaylight.yangtools.yang.model.api.SchemaPath refTypePath,
                              Type refType)

Puts refType to map with key refTypePath.

Parameters:

refTypePath - schema path used as the map key

refType - type which represents the map value

Throws:

IllegalArgumentException -

• if refTypePath equal null
• if refType equal null

provideGeneratedTOBuilderForBitsTypeDefinition

public GeneratedTOBuilder provideGeneratedTOBuilderForBitsTypeDefinition(String basePackageName,
                                                                         org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef,
                                                                         String typeDefName,
                                                                         String moduleName,
                                                                         ModuleContext context)

Converts typeDef which should be of the type BitsTypeDefinition to GeneratedTOBuilder.

All the bits of the typeDef are added to returning generated TO as properties.

Parameters:

basePackageName - string with name of package to which the module belongs

typeDef - type definition from which is the generated TO builder created

typeDefName - string with the name for generated TO builder

Returns:

generated TO builder which represents typeDef

Throws:

IllegalArgumentException -

• if typeDef equals null
• if basePackageName equals null

provideGeneratedTOBuildersForUnionTypeDef

public List<GeneratedTOBuilder> provideGeneratedTOBuildersForUnionTypeDef(String basePackageName,
                                                                          org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef,
                                                                          String typeDefName,
                                                                          org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode,
                                                                          ModuleContext context)

Converts typedef to generated TO with typeDefName. Every union type from typedef is added to generated TO builder as property.

Parameters:

basePackageName - string with name of package to which the module belongs

typedef - type definition which should be of type UnionTypeDefinition

typeDefName - string with name for generated TO

Returns:

generated TO builder which represents typedef

Throws:

NullPointerException -

• if basePackageName is null
• if typedef is null
• if QName of typedef is null

getAdditionalTypes

public Map<org.opendaylight.yangtools.yang.model.api.Module,Set<Type>> getAdditionalTypes()

addUnitsToGenTO

public static void addUnitsToGenTO(GeneratedTOBuilder to,
                                   String units)

provideTypeForLeafref

public Type provideTypeForLeafref(org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition leafrefType,
                                  org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode,
                                  ModuleContext context)

Converts leafrefType to JAVA Type.

The path of leafrefType is followed to find referenced node and its Type is returned.

Parameters:

leafrefType - leafref type definition for which is the type sought

Returns:

JAVA Type of data schema node which is referenced in leafrefType

Throws:

IllegalArgumentException -

• if leafrefType equal null
• if path statement of leafrefType equal null

provideGeneratedTOBuilderForUnionTypeDef

public GeneratedTOBuilder provideGeneratedTOBuilderForUnionTypeDef(String basePackageName,
                                                                   org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef,
                                                                   String typeDefName,
                                                                   org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode,
                                                                   ModuleContext context)

Converts output list of generated TO builders to one TO builder (first from list) which contains the remaining builders as its enclosing TO.

Parameters:

basePackageName - string with name of package to which the module belongs

typedef - type definition which should be of type UnionTypeDefinition

typeDefName - string with name for generated TO

Returns:

generated TO builder with the list of enclosed generated TO builders