org.opendaylight.mdsal.binding.javav2.generator.spi

Interface TypeProvider

All Known Implementing Classes:

TypeProviderImpl

@Beta
public interface TypeProvider

Service provider interface that defines contract for generated types.

Method Summary

Modifier and Type	Method and Description
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.
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)

Method Detail

javaTypeForSchemaDefinitionType

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. 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).

Parameters:

type - Type Definition to resolve from

parentNode - parent node

Returns:

Resolved Type

javaTypeForSchemaDefinitionType

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

Parameters:

type - Type Definition to resolve from

parentNode - parent node

restrictions - restrictions applied to given type definition

Returns:

Resolved Type

getTypeDefaultConstruction

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

Returns string containing code for creation of new type instance.

Parameters:

node - Schema node to resolve from

Returns:

String representing default construction

getConstructorPropertyName

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

Parameters:

node - Schema node to resolve from

Returns:

String representing constructor property name

getParamNameFromType

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

Parameters:

type - Type Definition to resolve from

Returns:

String representing parameter name