org.opendaylight.mdsal.binding.yang.types

Class AbstractTypeProvider

java.lang.Object

org.opendaylight.mdsal.binding.yang.types.AbstractTypeProvider

All Implemented Interfaces:

TypeProvider

Direct Known Subclasses:

CodegenTypeProvider, RuntimeTypeProvider

@Beta
public abstract class AbstractTypeProvider
extends Object
implements TypeProvider

Method Summary

Modifier and Type	Method and Description
abstract void	addEnumDescription(EnumBuilder enumBuilder, org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition enumTypeDef)
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)
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.
String	getTypeDefaultConstruction(org.opendaylight.yangtools.yang.model.api.LeafSchemaNode node, String defaultValue)
Type	javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode) Resolve of yang Type Definition to it's java counter part.
Type	javaTypeForSchemaDefinitionType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode, Restrictions restrictions) Converts schema definition type typeDefinition to JAVA Type.
abstract AbstractEnumerationBuilder	newEnumerationBuilder(JavaTypeName identifier)
abstract GeneratedTOBuilder	newGeneratedTOBuilder(JavaTypeName identifier)
abstract GeneratedTypeBuilder	newGeneratedTypeBuilder(JavaTypeName identifier)
GeneratedTOBuilder	provideGeneratedTOBuilderForBitsTypeDefinition(JavaTypeName typeName, org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition typeDef, String moduleName) Converts typeDef which should be of the type BitsTypeDefinition to GeneratedTOBuilder.
GeneratedTOBuilder	provideGeneratedTOBuilderForUnionTypeDef(JavaTypeName typeName, org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef, org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> parentNode) 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(JavaTypeName typeName, org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef, org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode) 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) Converts leafrefType to JAVA Type.
void	putReferencedType(org.opendaylight.yangtools.yang.model.api.SchemaPath refTypePath, Type refType) Puts refType to map with key refTypePath.
abstract Map<String,String>	resolveRegExpressions(List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint> patternConstraints) Converts the pattern constraints to the list of the strings which represents these constraints.

Methods inherited from class java.lang.Object

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

Method Detail

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

getAdditionalTypes

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

javaTypeForSchemaDefinitionType

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

Description copied from interface: TypeProvider

Resolve of yang Type Definition to it's 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:

typeDefinition - Type Definition to resolve from

Returns:

Resolved Type

javaTypeForSchemaDefinitionType

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

Converts schema definition type typeDefinition to JAVA Type.

Specified by:

javaTypeForSchemaDefinitionType in interface TypeProvider

Parameters:

typeDefinition - type definition which is converted to JAVA type

Throws:

IllegalArgumentException -

• if typeDefinition equal null
• if Qname of typeDefinition equal null
• if name of typeDefinition equal null

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

provideTypeForLeafref

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

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

addEnumDescription

public abstract void addEnumDescription(EnumBuilder enumBuilder,
                                        org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition enumTypeDef)

newEnumerationBuilder

public abstract AbstractEnumerationBuilder newEnumerationBuilder(JavaTypeName identifier)

newGeneratedTOBuilder

public abstract GeneratedTOBuilder newGeneratedTOBuilder(JavaTypeName identifier)

newGeneratedTypeBuilder

public abstract GeneratedTypeBuilder newGeneratedTypeBuilder(JavaTypeName identifier)

resolveRegExpressions

public abstract Map<String,String> resolveRegExpressions(List<org.opendaylight.yangtools.yang.model.api.type.PatternConstraint> patternConstraints)

Converts the pattern constraints to the list of the strings which represents these constraints.

Parameters:

patternConstraints - list of pattern constraints

Returns:

list of strings which represents the constraint patterns

provideGeneratedTOBuilderForUnionTypeDef

public GeneratedTOBuilder provideGeneratedTOBuilderForUnionTypeDef(JavaTypeName typeName,
                                                                   org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef,
                                                                   org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> parentNode)

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

Parameters:

typeName - new type identifier

typedef - type definition which should be of type UnionTypeDefinition

Returns:

generated TO builder with the list of enclosed generated TO builders

provideGeneratedTOBuildersForUnionTypeDef

public List<GeneratedTOBuilder> provideGeneratedTOBuildersForUnionTypeDef(JavaTypeName typeName,
                                                                          org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition typedef,
                                                                          org.opendaylight.yangtools.yang.model.api.SchemaNode parentNode)

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

Parameters:

typeName - new type identifier

typedef - type definition which should be of type UnionTypeDefinition

Returns:

generated TO builder which represents typedef

Throws:

NullPointerException -

• if basePackageName is null
• if typedef is null
• if Qname of typedef is null

provideGeneratedTOBuilderForBitsTypeDefinition

public GeneratedTOBuilder provideGeneratedTOBuilderForBitsTypeDefinition(JavaTypeName typeName,
                                                                         org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition typeDef,
                                                                         String moduleName)

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:

typeName - new type identifier

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

Returns:

generated TO builder which represents typeDef

Throws:

IllegalArgumentException -

• if typeDef equals null
• if basePackageName equals null

addUnitsToGenTO

public static void addUnitsToGenTO(GeneratedTOBuilder to,
                                   String units)

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

getTypeDefaultConstruction

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

getConstructorPropertyName

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

Specified by:

getConstructorPropertyName in interface TypeProvider

getParamNameFromType

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

Specified by:

getParamNameFromType in interface TypeProvider