-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.sal.binding.generator.impl;\r
-\r
-import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;\r
-import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;\r
-import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;\r
-\r
-import java.util.ArrayList;\r
-import java.util.Collections;\r
-import java.util.HashMap;\r
-import java.util.List;\r
-import java.util.Map;\r
-import java.util.Set;\r
-\r
-import org.opendaylight.yangtools.binding.generator.util.BindingTypes;\r
-import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;\r
-import org.opendaylight.yangtools.binding.generator.util.Types;\r
-import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;\r
-import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;\r
-import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;\r
-import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;\r
-import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;\r
-import org.opendaylight.yangtools.sal.binding.model.api.Type;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;\r
-import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;\r
-import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;\r
-import org.opendaylight.yangtools.yang.binding.RpcService;\r
-import org.opendaylight.yangtools.yang.common.RpcResult;\r
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;\r
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;\r
-import org.opendaylight.yangtools.yang.model.api.ChoiceNode;\r
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;\r
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.Module;\r
-import org.opendaylight.yangtools.yang.model.api.RpcDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;\r
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;\r
-import org.opendaylight.yangtools.yang.model.api.TypeDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;\r
-import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;\r
-import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;\r
-import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;\r
-import org.opendaylight.yangtools.yang.model.util.ExtendedType;\r
-import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;\r
-import org.opendaylight.yangtools.yang.model.util.UnionType;\r
-import static com.google.common.base.Preconditions.*;\r
-import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;\r
-\r
-public class BindingGeneratorImpl implements BindingGenerator {\r
-\r
- /**\r
- * Outter key represents the package name. Outter value represents map of\r
- * all builders in the same package. Inner key represents the schema node\r
- * name (in JAVA class/interface name format). Inner value represents\r
- * instance of builder for schema node specified in key part.\r
- */\r
- private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;\r
-\r
- /**\r
- * Provide methods for converting YANG types to JAVA types.\r
- */\r
- private var TypeProvider typeProvider;\r
-\r
- /**\r
- * Holds reference to schema context to resolve data of augmented elemnt\r
- * when creating augmentation builder\r
- */\r
- private var SchemaContext schemaContext;\r
-\r
- /**\r
- * Each grouping which is converted from schema node to generated type is\r
- * added to this map with its Schema path as key to make it easier to get\r
- * reference to it. In schema nodes in <code>uses</code> attribute there is\r
- * only Schema Path but when building list of implemented interfaces for\r
- * Schema node the object of type <code>Type</code> is required. So in this\r
- * case is used this map.\r
- */\r
- private val allGroupings = new HashMap<SchemaPath, GeneratedType>();\r
- \r
- \r
- private val yangToJavaMapping = new HashMap<SchemaPath, Type>();\r
-\r
- /**\r
- * Constant with the concrete name of namespace.\r
- */\r
- private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";\r
-\r
- /**\r
- * Constant with the concrete name of identifier.\r
- */\r
- private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";\r
-\r
- \r
- /**\r
- * Resolves generated types from <code>context</code> schema nodes of all\r
- * modules.\r
- *\r
- * Generated types are created for modules, groupings, types, containers,\r
- * lists, choices, augments, rpcs, notification, identities.\r
- *\r
- * @param context\r
- * schema context which contains data about all schema nodes\r
- * saved in modules\r
- * @return list of types (usually <code>GeneratedType</code>\r
- * <code>GeneratedTransferObject</code>which are generated from\r
- * <code>context</code> data.\r
- * @throws IllegalArgumentException\r
- * if param <code>context</code> is null\r
- * @throws IllegalStateException\r
- * if <code>context</code> contain no modules\r
- */\r
- override generateTypes(SchemaContext context) {\r
- checkArgument(context !== null,"Schema Context reference cannot be NULL.");\r
- checkState(context.modules !== null,"Schema Context does not contain defined modules.");\r
- val List<Type> generatedTypes = new ArrayList();\r
- schemaContext = context;\r
- typeProvider = new TypeProviderImpl(context);\r
- val Set<Module> modules = context.modules;\r
- genTypeBuilders = new HashMap();\r
- for (module : modules) {\r
-\r
- generatedTypes.addAll(allGroupingsToGenTypes(module));\r
-\r
- if (false == module.childNodes.isEmpty()) {\r
- generatedTypes.add(moduleToDataType(module));\r
- }\r
- generatedTypes.addAll(allTypeDefinitionsToGenTypes(module));\r
- generatedTypes.addAll(allContainersToGenTypes(module));\r
- generatedTypes.addAll(allListsToGenTypes(module));\r
- generatedTypes.addAll(allChoicesToGenTypes(module));\r
- generatedTypes.addAll(allRPCMethodsToGenType(module));\r
- generatedTypes.addAll(allNotificationsToGenType(module));\r
- generatedTypes.addAll(allIdentitiesToGenTypes(module, context));\r
- }\r
- for (module : modules) {\r
- generatedTypes.addAll(allAugmentsToGenTypes(module));\r
- \r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Resolves generated types from <code>context</code> schema nodes only for\r
- * modules specified in <code>modules</code>\r
- *\r
- * Generated types are created for modules, groupings, types, containers,\r
- * lists, choices, augments, rpcs, notification, identities.\r
- *\r
- * @param context\r
- * schema context which contains data about all schema nodes\r
- * saved in modules\r
- * @param modules\r
- * set of modules for which schema nodes should be generated\r
- * types\r
- * @return list of types (usually <code>GeneratedType</code> or\r
- * <code>GeneratedTransferObject</code>) which:\r
- * <ul>\r
- * <li>are generated from <code>context</code> schema nodes and</li>\r
- * <li>are also part of some of the module in <code>modules</code>\r
- * set</li>.\r
- * </ul>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if param <code>context</code> is null or</li>\r
- * <li>if param <code>modules</code> is null</li>\r
- * </ul>\r
- * @throws IllegalStateException\r
- * if <code>context</code> contain no modules\r
- */\r
- override generateTypes(SchemaContext context, Set<Module> modules) {\r
- checkArgument(context !== null,"Schema Context reference cannot be NULL.");\r
- checkState(context.modules !== null,"Schema Context does not contain defined modules.");\r
- checkArgument(modules !== null,"Set of Modules cannot be NULL.");\r
-\r
- val List<Type> filteredGenTypes = new ArrayList();\r
- schemaContext = context;\r
- typeProvider = new TypeProviderImpl(context);\r
- val Set<Module> contextModules = context.modules;\r
- genTypeBuilders = new HashMap();\r
- \r
- for (contextModule : contextModules) {\r
- val List<Type> generatedTypes = new ArrayList();\r
-\r
- generatedTypes.addAll(allGroupingsToGenTypes(contextModule));\r
- if (false == contextModule.childNodes.isEmpty()) {\r
- generatedTypes.add(moduleToDataType(contextModule));\r
- }\r
- generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));\r
- generatedTypes.addAll(allContainersToGenTypes(contextModule));\r
- generatedTypes.addAll(allListsToGenTypes(contextModule));\r
- generatedTypes.addAll(allChoicesToGenTypes(contextModule));\r
- generatedTypes.addAll(allRPCMethodsToGenType(contextModule));\r
- generatedTypes.addAll(allNotificationsToGenType(contextModule));\r
- generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));\r
- \r
- if (modules.contains(contextModule)) {\r
- filteredGenTypes.addAll(generatedTypes);\r
- }\r
- }\r
- for (contextModule : contextModules) {\r
- val generatedTypes = (allAugmentsToGenTypes(contextModule));\r
- if (modules.contains(contextModule)) {\r
- filteredGenTypes.addAll(generatedTypes);\r
- }\r
- \r
- }\r
- return filteredGenTypes;\r
- }\r
-\r
- /**\r
- * Converts all extended type definitions of module to the list of\r
- * <code>Type</code> objects.\r
- *\r
- * @param module\r
- * module from which is obtained set of type definitions\r
- * @return list of <code>Type</code> which are generated from extended\r
- * definition types (object of type <code>ExtendedType</code>)\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if module equals null</li>\r
- * <li>if name of module equals null</li>\r
- * <li>if type definitions of module equal null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allTypeDefinitionsToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
- val Set<TypeDefinition<?>> typeDefinitions = module.typeDefinitions;\r
- checkState(typeDefinitions !== null,'''Type Definitions for module «module.name» cannot be NULL.''');\r
-\r
- \r
- val List<Type> generatedTypes = new ArrayList();\r
- for ( TypeDefinition<?> typedef : typeDefinitions) {\r
- if (typedef !== null) {\r
- val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);\r
- if ((type !== null) && !generatedTypes.contains(type)) {\r
- generatedTypes.add(type);\r
- }\r
- }\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>containers</b> of the module to the list of\r
- * <code>Type</code> objects.\r
- *\r
- * @param module\r
- * module from which is obtained DataNodeIterator to iterate over\r
- * all containers\r
- * @return list of <code>Type</code> which are generated from containers\r
- * (objects of type <code>ContainerSchemaNode</code>)\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li>\r
- * <li>if the set of child nodes equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allContainersToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
-\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
-\r
- if (module.childNodes === null) {\r
- throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.name\r
- + " cannot be NULL.");\r
- }\r
-\r
- val List<Type> generatedTypes = new ArrayList();\r
- val it = new DataNodeIterator(module);\r
- val List<ContainerSchemaNode> schemaContainers = it.allContainers();\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- for (container : schemaContainers) {\r
- if (!container.isAddedByUses()) {\r
- generatedTypes.add(containerToGenType(basePackageName, container));\r
- }\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>lists</b> of the module to the list of <code>Type</code>\r
- * objects.\r
- *\r
- * @param module\r
- * module from which is obtained DataNodeIterator to iterate over\r
- * all lists\r
- * @return list of <code>Type</code> which are generated from lists (objects\r
- * of type <code>ListSchemaNode</code>)\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li>\r
- * <li>if the set of child nodes equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allListsToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
-\r
- if (module.childNodes === null) {\r
- throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.name\r
- + " cannot be NULL.");\r
- }\r
-\r
- val List<Type> generatedTypes = new ArrayList();\r
- val it = new DataNodeIterator(module);\r
- val List<ListSchemaNode> schemaLists = it.allLists();\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- if (schemaLists !== null) {\r
- for (list : schemaLists) {\r
- if (!list.isAddedByUses()) {\r
- generatedTypes.addAll(listToGenType(basePackageName, list));\r
- }\r
- }\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>choices</b> of the module to the list of\r
- * <code>Type</code> objects.\r
- *\r
- * @param module\r
- * module from which is obtained DataNodeIterator to iterate over\r
- * all choices\r
- * @return list of <code>Type</code> which are generated from choices\r
- * (objects of type <code>ChoiceNode</code>)\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li> *\r
- * </ul>\r
- *\r
- */\r
- private def List<GeneratedType> allChoicesToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
-\r
- val it = new DataNodeIterator(module);\r
- val choiceNodes = it.allChoices();\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
-\r
- val List<GeneratedType> generatedTypes = new ArrayList();\r
- for (choice : choiceNodes) {\r
- if ((choice !== null) && !choice.isAddedByUses()) {\r
- generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice));\r
- }\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>augmentation</b> of the module to the list\r
- * <code>Type</code> objects.\r
- *\r
- * @param module\r
- * module from which is obtained list of all augmentation objects\r
- * to iterate over them\r
- * @return list of <code>Type</code> which are generated from augments\r
- * (objects of type <code>AugmentationSchema</code>)\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li>\r
- * <li>if the set of child nodes equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allAugmentsToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
- if (module.childNodes === null) {\r
- throw new IllegalArgumentException("Reference to Set of Augmentation Definitions in module "\r
- + module.name + " cannot be NULL.");\r
- }\r
-\r
- val List<Type> generatedTypes = new ArrayList();\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- val List<AugmentationSchema> augmentations = resolveAugmentations(module);\r
- for (augment : augmentations) {\r
- generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment));\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Returns list of <code>AugmentationSchema</code> objects. The objects are\r
- * sorted according to the length of their target path from the shortest to\r
- * the longest.\r
- *\r
- * @param module\r
- * module from which is obtained list of all augmentation objects\r
- * @return list of sorted <code>AugmentationSchema</code> objects obtained\r
- * from <code>module</code>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the set of augmentation equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<AugmentationSchema> resolveAugmentations( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- checkState(module.augmentations !== null,"Augmentations Set cannot be NULL.");\r
-\r
- val Set<AugmentationSchema> augmentations = module.augmentations;\r
- val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);\r
- Collections.sort(sortedAugmentations, [augSchema1, augSchema2 |\r
-\r
- if (augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {\r
- return 1;\r
- } else if (augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {\r
- return -1;\r
- }\r
- return 0;\r
- ]);\r
- return sortedAugmentations;\r
- }\r
-\r
- /**\r
- * Converts whole <b>module</b> to <code>GeneratedType</code> object.\r
- * Firstly is created the module builder object from which is vally\r
- * obtained reference to <code>GeneratedType</code> object.\r
- *\r
- * @param module\r
- * module from which are obtained the module name, child nodes,\r
- * uses and is derived package name\r
- * @return <code>GeneratedType</code> which is internal representation of\r
- * the module\r
- * @throws IllegalArgumentException\r
- * if the module equals null\r
- *\r
- */\r
- private def GeneratedType moduleToDataType( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
-\r
- val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");\r
- addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);\r
- moduleDataTypeBuilder.addImplementsType(DATA_ROOT);\r
-\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- if (moduleDataTypeBuilder !== null) {\r
- val Set<DataSchemaNode> dataNodes = module.childNodes;\r
- resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);\r
- }\r
- return moduleDataTypeBuilder.toInstance();\r
- }\r
-\r
- /**\r
- * Converts all <b>rpcs</b> inputs and outputs substatements of the module\r
- * to the list of <code>Type</code> objects. In addition are to containers\r
- * and lists which belong to input or output also part of returning list.\r
- *\r
- * @param module\r
- * module from which is obtained set of all rpc objects to\r
- * iterate over them\r
- * @return list of <code>Type</code> which are generated from rpcs inputs,\r
- * outputs + container and lists which are part of inputs or outputs\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li>\r
- * <li>if the set of child nodes equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allRPCMethodsToGenType( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
-\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
-\r
- if (module.childNodes === null) {\r
- throw new IllegalArgumentException("Reference to Set of RPC Method Definitions in module "\r
- + module.name + " cannot be NULL.");\r
- }\r
-\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- val Set<RpcDefinition> rpcDefinitions = module.rpcs;\r
-\r
- if (rpcDefinitions.isEmpty()) {\r
- return Collections.emptyList();\r
- }\r
-\r
- val List<Type> genRPCTypes = new ArrayList();\r
- val interfaceBuilder = moduleTypeBuilder(module, "Service");\r
- interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));\r
- for (rpc : rpcDefinitions) {\r
- if (rpc !== null) {\r
-\r
- val rpcName = parseToClassName(rpc.QName.localName);\r
- val rpcMethodName = parseToValidParamName(rpcName);\r
- val method = interfaceBuilder.addMethod(rpcMethodName);\r
-\r
- val rpcInOut = new ArrayList();\r
-\r
- val input = rpc.input;\r
- val output = rpc.output;\r
-\r
- if (input !== null) {\r
- rpcInOut.add(new DataNodeIterator(input));\r
- val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);\r
- addImplementedInterfaceFromUses(input, inType);\r
- inType.addImplementsType(DATA_OBJECT);\r
- inType.addImplementsType(augmentable(inType));\r
- resolveDataSchemaNodes(basePackageName, inType, input.childNodes);\r
- val inTypeInstance = inType.toInstance();\r
- genRPCTypes.add(inTypeInstance);\r
- method.addParameter(inTypeInstance, "input");\r
- }\r
-\r
- var Type outTypeInstance = VOID;\r
- if (output !== null) {\r
- rpcInOut.add(new DataNodeIterator(output));\r
- val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);\r
- addImplementedInterfaceFromUses(output, outType);\r
- outType.addImplementsType(DATA_OBJECT);\r
- outType.addImplementsType(augmentable(outType));\r
-\r
- resolveDataSchemaNodes(basePackageName, outType, output.childNodes);\r
- outTypeInstance = outType.toInstance();\r
- genRPCTypes.add(outTypeInstance);\r
-\r
- }\r
-\r
- val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);\r
- method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));\r
- for (iter : rpcInOut) {\r
- val List<ContainerSchemaNode> nContainers = iter.allContainers();\r
- if ((nContainers !== null) && !nContainers.isEmpty()) {\r
- for (container : nContainers) {\r
- if (!container.isAddedByUses()) {\r
- genRPCTypes.add(containerToGenType(basePackageName, container));\r
- }\r
- }\r
- }\r
- val List<ListSchemaNode> nLists = iter.allLists();\r
- if ((nLists !== null) && !nLists.isEmpty()) {\r
- for (list : nLists) {\r
- if (!list.isAddedByUses()) {\r
- genRPCTypes.addAll(listToGenType(basePackageName, list));\r
- }\r
- }\r
- }\r
- }\r
- }\r
- }\r
- genRPCTypes.add(interfaceBuilder.toInstance());\r
- return genRPCTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>notifications</b> of the module to the list of\r
- * <code>Type</code> objects. In addition are to this list added containers\r
- * and lists which are part of this notification.\r
- *\r
- * @param module\r
- * module from which is obtained set of all notification objects\r
- * to iterate over them\r
- * @return list of <code>Type</code> which are generated from notification\r
- * (object of type <code>NotificationDefinition</code>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the module equals null</li>\r
- * <li>if the name of module equals null</li>\r
- * <li>if the set of child nodes equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<Type> allNotificationsToGenType( Module module) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
-\r
- checkArgument(module.name !== null,"Module name cannot be NULL.");\r
-\r
- if (module.childNodes === null) {\r
- throw new IllegalArgumentException("Reference to Set of Notification Definitions in module "\r
- + module.name + " cannot be NULL.");\r
- }\r
- val notifications = module.notifications;\r
- if(notifications.isEmpty()) return Collections.emptyList();\r
- \r
- val listenerInterface = moduleTypeBuilder(module, "Listener");\r
- listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);\r
- \r
- \r
- \r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- val List<Type> generatedTypes = new ArrayList();\r
- \r
- \r
- for ( notification : notifications) {\r
- if (notification !== null) {\r
- val iter = new DataNodeIterator(notification);\r
-\r
- // Containers\r
- for (node : iter.allContainers()) {\r
- if (!node.isAddedByUses()) {\r
- generatedTypes.add(containerToGenType(basePackageName, node));\r
- }\r
- }\r
- // Lists\r
- for (node : iter.allLists()) {\r
- if (!node.isAddedByUses()) {\r
- generatedTypes.addAll(listToGenType(basePackageName, node));\r
- }\r
- }\r
- val notificationInterface = addDefaultInterfaceDefinition(basePackageName,\r
- notification);\r
- notificationInterface.addImplementsType(NOTIFICATION);\r
- // Notification object\r
- resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);\r
- \r
- listenerInterface.addMethod("on"+notificationInterface.name) //\r
- .setAccessModifier(AccessModifier.PUBLIC)\r
- .addParameter(notificationInterface, "notification")\r
- .setReturnType(Types.VOID);\r
- \r
- generatedTypes.add(notificationInterface.toInstance());\r
- }\r
- }\r
- generatedTypes.add(listenerInterface.toInstance());\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts all <b>identities</b> of the module to the list of\r
- * <code>Type</code> objects.\r
- *\r
- * @param module\r
- * module from which is obtained set of all identity objects to\r
- * iterate over them\r
- * @param context\r
- * schema context only used as input parameter for method\r
- * {@link identityToGenType}\r
- * @return list of <code>Type</code> which are generated from identities\r
- * (object of type <code>IdentitySchemaNode</code>\r
- *\r
- */\r
- private def List<Type> allIdentitiesToGenTypes( Module module, SchemaContext context) {\r
- val List<Type> genTypes = new ArrayList();\r
-\r
- val Set<IdentitySchemaNode> schemaIdentities = module.identities;\r
-\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
-\r
- if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {\r
- for (identity : schemaIdentities) {\r
- genTypes.add(identityToGenType(basePackageName, identity, context));\r
- }\r
- }\r
- return genTypes;\r
- }\r
-\r
- /**\r
- * Converts the <b>identity</b> object to GeneratedType. Firstly it is\r
- * created transport object builder. If identity contains base identity then\r
- * reference to base identity is added to superior identity as its extend.\r
- * If identity doesn't contain base identity then only reference to abstract\r
- * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity\r
- * BaseIdentity} is added\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param identity\r
- * IdentitySchemaNode which contains data about identity\r
- * @param context\r
- * SchemaContext which is used to get package and name\r
- * information about base of identity\r
- *\r
- * @return GeneratedType which is generated from identity (object of type\r
- * <code>IdentitySchemaNode</code>\r
- *\r
- */\r
- private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,\r
- SchemaContext context) {\r
- if (identity === null) {\r
- return null;\r
- }\r
-\r
- val packageName = packageNameForGeneratedType(basePackageName, identity.path);\r
- val genTypeName = parseToClassName(identity.QName.localName);\r
- val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);\r
-\r
- val baseIdentity = identity.baseIdentity;\r
- if (baseIdentity !== null) {\r
- val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);\r
-\r
- val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);\r
- val returnTypeName = parseToClassName(baseIdentity.QName.localName);\r
-\r
- val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();\r
- newType.setExtendsType(gto);\r
- } else {\r
- newType.setExtendsType(Types.baseIdentityTO);\r
- }\r
- newType.setAbstract(true);\r
- return newType.toInstance();\r
- }\r
-\r
- /**\r
- * Converts all <b>groupings</b> of the module to the list of\r
- * <code>Type</code> objects. Firstly are groupings sorted according mutual\r
- * dependencies. At least dependend (indepedent) groupings are in the list\r
- * saved at first positions. For every grouping the record is added to map\r
- * {@link BindingGeneratorImpl#allGroupings allGroupings}\r
- *\r
- * @param module\r
- * module from which is obtained set of all grouping objects to\r
- * iterate over them\r
- * @return list of <code>Type</code> which are generated from groupings\r
- * (object of type <code>GroupingDefinition</code>)\r
- *\r
- */\r
- private def List<Type> allGroupingsToGenTypes( Module module) {\r
- checkArgument(module !== null,"Module parameter can not be null");\r
- val List<Type> genTypes = new ArrayList();\r
- val basePackageName = moduleNamespaceToPackageName(module);\r
- val Set<GroupingDefinition> groupings = module.groupings;\r
- val List<GroupingDefinition> groupingsSortedByDependencies = GroupingDefinitionDependencySort.sort(groupings);\r
-\r
- for (grouping : groupingsSortedByDependencies) {\r
- val genType = groupingToGenType(basePackageName, grouping);\r
- genTypes.add(genType);\r
- val schemaPath = grouping.path;\r
- allGroupings.put(schemaPath, genType);\r
- }\r
- return genTypes;\r
- }\r
-\r
- /**\r
- * Converts individual grouping to GeneratedType. Firstly generated type\r
- * builder is created and every child node of grouping is resolved to the\r
- * method.\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param grouping\r
- * GroupingDefinition which contains data about grouping\r
- * @return GeneratedType which is generated from grouping (object of type\r
- * <code>GroupingDefinition</code>)\r
- */\r
- private def GeneratedType groupingToGenType( String basePackageName, GroupingDefinition grouping) {\r
- if (grouping === null) {\r
- return null;\r
- }\r
-\r
- val packageName = packageNameForGeneratedType(basePackageName, grouping.path);\r
- val Set<DataSchemaNode> schemaNodes = grouping.childNodes;\r
- val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);\r
-\r
- resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
- return typeBuilder.toInstance();\r
- }\r
-\r
- /**\r
- * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base\r
- * type of <code>typeDefinition</code> is of the type ExtendedType then this\r
- * method is recursivelly called with this base type.\r
- *\r
- * @param typeDefinition\r
- * TypeDefinition in which should be EnumTypeDefinition found as\r
- * base type\r
- * @return EnumTypeDefinition if it is found inside\r
- * <code>typeDefinition</code> or <code>null</code> in other case\r
- */\r
- private def EnumTypeDefinition enumTypeDefFromExtendedType( TypeDefinition<?> typeDefinition) {\r
- if (typeDefinition !== null) {\r
- if (typeDefinition.baseType instanceof EnumTypeDefinition) {\r
- return typeDefinition.baseType as EnumTypeDefinition;\r
- } else if (typeDefinition.baseType instanceof ExtendedType) {\r
- return enumTypeDefFromExtendedType(typeDefinition.baseType);\r
- }\r
- }\r
- return null;\r
- }\r
-\r
- /**\r
- * Adds enumeration builder created from <code>enumTypeDef</code> to\r
- * <code>typeBuilder</code>.\r
- *\r
- * Each <code>enumTypeDef</code> item is added to builder with its name and\r
- * value.\r
- *\r
- * @param enumTypeDef\r
- * EnumTypeDefinition contains enum data\r
- * @param enumName\r
- * string contains name which will be assigned to enumeration\r
- * builder\r
- * @param typeBuilder\r
- * GeneratedTypeBuilder to which will be enum builder assigned\r
- * @return enumeration builder which contais data from\r
- * <code>enumTypeDef</code>\r
- */\r
- private def EnumBuilder resolveInnerEnumFromTypeDefinition( EnumTypeDefinition enumTypeDef, String enumName,\r
- GeneratedTypeBuilder typeBuilder) {\r
- if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null)\r
- && (enumTypeDef.QName.localName !== null)) {\r
-\r
- val enumerationName = parseToClassName(enumName);\r
- val enumBuilder = typeBuilder.addEnumeration(enumerationName);\r
- enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);\r
-\r
- return enumBuilder;\r
- }\r
- return null;\r
- }\r
-\r
- /**\r
- * Generates type builder for <code>module</code>.\r
- *\r
- * @param module\r
- * Module which is source of package name for generated type\r
- * builder\r
- * @param postfix\r
- * string which is added to the module class name representation\r
- * as suffix\r
- * @return instance of GeneratedTypeBuilder which represents\r
- * <code>module</code>.\r
- * @throws IllegalArgumentException\r
- * if <code>module</code> equals null\r
- */\r
- private def GeneratedTypeBuilder moduleTypeBuilder( Module module, String postfix) {\r
- checkArgument(module !== null,"Module reference cannot be NULL.");\r
- val packageName = moduleNamespaceToPackageName(module);\r
- val moduleName = parseToClassName(module.name) + postfix;\r
-\r
- return new GeneratedTypeBuilderImpl(packageName, moduleName);\r
-\r
- }\r
-\r
- /**\r
- * Converts <code>augSchema</code> to list of <code>Type</code> which\r
- * contains generated type for augmentation. In addition there are also\r
- * generated types for all containers, list and choices which are child of\r
- * <code>augSchema</code> node or a generated types for cases are added if\r
- * augmented node is choice.\r
- *\r
- * @param augmentPackageName\r
- * string with the name of the package to which the augmentation\r
- * belongs\r
- * @param augSchema\r
- * AugmentationSchema which is contains data about agumentation\r
- * (target path, childs...)\r
- * @return list of <code>Type</code> objects which contains generated type\r
- * for augmentation and for container, list and choice child nodes\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>augmentPackageName</code> equals null</li>\r
- * <li>if <code>augSchema</code> equals null</li>\r
- * <li>if target path of <code>augSchema</code> equals null</li>\r
- * </ul>\r
- */\r
- private def List<Type> augmentationToGenTypes( String augmentPackageName, AugmentationSchema augSchema) {\r
- checkArgument(augmentPackageName !== null,"Package Name cannot be NULL.");\r
- checkArgument(augSchema !== null,"Augmentation Schema cannot be NULL.");\r
- checkState(augSchema.targetPath !== null,"Augmentation Schema does not contain Target Path (Target Path is NULL).");\r
-\r
- val List<Type> genTypes = new ArrayList();\r
-\r
- // EVERY augmented interface will extends Augmentation<T> interface\r
- // and DataObject interface!!!\r
- val targetPath = augSchema.targetPath;\r
- val targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);\r
- val targetType = yangToJavaMapping.get(targetSchemaNode.path);\r
- if ((targetSchemaNode !== null) && (targetSchemaNode.QName !== null)\r
- && (targetSchemaNode.QName.localName !== null)) {\r
- \r
- val targetPackageName = targetType.packageName;\r
- val targetSchemaNodeName = targetType.name;\r
- \r
- \r
- val augChildNodes = augSchema.childNodes;\r
-\r
- if (!(targetSchemaNode instanceof ChoiceNode)) {\r
- val augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName,\r
- targetType, augSchema);\r
- val augType = augTypeBuilder.toInstance();\r
- genTypes.add(augType);\r
- } else {\r
- val refChoiceType = new ReferencedTypeImpl(targetPackageName,\r
- parseToClassName(targetSchemaNodeName));\r
- val choiceTarget = targetSchemaNode as ChoiceNode;\r
- val choiceCaseNodes = choiceTarget.cases;\r
- genTypes.addAll(generateTypesFromAugmentedChoiceCases(augmentPackageName, refChoiceType,\r
- choiceCaseNodes));\r
- }\r
- genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes));\r
- }\r
- return genTypes;\r
- }\r
-\r
- /**\r
- * Returns a generated type builder for an augmentation.\r
- *\r
- * The name of the type builder is equal to the name of augmented node with\r
- * serial number as suffix.\r
- *\r
- * @param augmentPackageName\r
- * string with contains the package name to which the augment\r
- * belongs\r
- * @param targetPackageName\r
- * string with the package name to which the augmented node\r
- * belongs\r
- * @param targetSchemaNodeName\r
- * string with the name of the augmented node\r
- * @param augSchema\r
- * augmentation schema which contains data about the child nodes\r
- * and uses of augment\r
- * @return generated type builder for augment\r
- */\r
- private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition( String augmentPackageName,\r
- Type targetTypeRef, AugmentationSchema augSchema) {\r
- var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);\r
- if (augmentBuilders === null) {\r
- augmentBuilders = new HashMap();\r
- genTypeBuilders.put(augmentPackageName, augmentBuilders);\r
- }\r
- val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);\r
-\r
- val augTypeName = if (augIdentifier !== null ) { \r
- parseToClassName(augIdentifier)\r
- } else {\r
- augGenTypeName(augmentBuilders, targetTypeRef.name);\r
- }\r
- val Set<DataSchemaNode> augChildNodes = augSchema.childNodes;\r
-\r
- val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);\r
-\r
- augTypeBuilder.addImplementsType(DATA_OBJECT);\r
- augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));\r
- addImplementedInterfaceFromUses(augSchema, augTypeBuilder);\r
-\r
- augSchemaNodeToMethods(augmentPackageName, augTypeBuilder, augChildNodes);\r
- augmentBuilders.put(augTypeName, augTypeBuilder);\r
- return augTypeBuilder;\r
- }\r
-\r
- /**\r
- *\r
- * @param unknownSchemaNodes\r
- * @return\r
- */\r
- private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {\r
- for (unknownSchemaNode : unknownSchemaNodes) {\r
- val nodeType = unknownSchemaNode.nodeType;\r
- if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName)\r
- && YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {\r
- return unknownSchemaNode.nodeParameter;\r
- }\r
- }\r
- return null;\r
- }\r
-\r
- /**\r
- * Convert a container, list and choice subnodes (and recursivelly their\r
- * subnodes) of augment to generated types\r
- *\r
- * @param augBasePackageName\r
- * string with the augment package name\r
- * @param augChildNodes\r
- * set of data schema nodes which represents child nodes of the\r
- * augment\r
- *\r
- * @return list of <code>Type</code> which represents container, list and\r
- * choice subnodes of augment\r
- */\r
- private def List<Type> augmentationBodyToGenTypes( String augBasePackageName,\r
- Set<DataSchemaNode> augChildNodes) {\r
- val List<Type> genTypes = new ArrayList();\r
- val List<DataNodeIterator> augSchemaIts = new ArrayList();\r
- for (childNode : augChildNodes) {\r
- if (childNode instanceof DataNodeContainer) {\r
- augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));\r
-\r
- if (childNode instanceof ContainerSchemaNode) {\r
- genTypes.add(containerToGenType(augBasePackageName, childNode as ContainerSchemaNode));\r
- } else if (childNode instanceof ListSchemaNode) {\r
- genTypes.addAll(listToGenType(augBasePackageName, childNode as ListSchemaNode));\r
- }\r
- } else if (childNode instanceof ChoiceNode) {\r
- val choice = childNode as ChoiceNode;\r
- for (caseNode : choice.cases) {\r
- augSchemaIts.add(new DataNodeIterator(caseNode));\r
- }\r
- genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode));\r
- }\r
- }\r
-\r
- for (it : augSchemaIts) {\r
- val List<ContainerSchemaNode> augContainers = it.allContainers();\r
- val List<ListSchemaNode> augLists = it.allLists();\r
- val List<ChoiceNode> augChoices = it.allChoices();\r
-\r
- if (augContainers !== null) {\r
- for (container : augContainers) {\r
- genTypes.add(containerToGenType(augBasePackageName, container));\r
- }\r
- }\r
- if (augLists !== null) {\r
- for (list : augLists) {\r
- genTypes.addAll(listToGenType(augBasePackageName, list));\r
- }\r
- }\r
- if (augChoices !== null) {\r
- for (choice : augChoices) {\r
- genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice));\r
- }\r
- }\r
- }\r
- return genTypes;\r
- }\r
-\r
- /**\r
- * Returns first unique name for the augment generated type builder. The\r
- * generated type builder name for augment consists from name of augmented\r
- * node and serial number of its augmentation.\r
- *\r
- * @param builders\r
- * map of builders which were created in the package to which the\r
- * augmentation belongs\r
- * @param genTypeName\r
- * string with name of augmented node\r
- * @return string with unique name for augmentation builder\r
- */\r
- private def String augGenTypeName( Map<String, GeneratedTypeBuilder> builders, String genTypeName) {\r
- var index = 1;\r
- while ((builders !== null) && builders.containsKey(genTypeName + index)) {\r
- index = index + 1;\r
- }\r
- return genTypeName + index;\r
- }\r
-\r
- /**\r
- * Converts <code>containerNode</code> to generated type. Firstly the\r
- * generated type builder is created. The subnodes of\r
- * <code>containerNode</code> are added as methods and the instance of\r
- * <code>GeneratedType</code> is returned.\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param containerNode\r
- * container schema node with the data about childs nodes and\r
- * schema paths\r
- * @return generated type for <code>containerNode</code>\r
- */\r
- private def GeneratedType containerToGenType( String basePackageName, ContainerSchemaNode containerNode) {\r
- if (containerNode === null) {\r
- return null;\r
- }\r
-\r
- val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
- val schemaNodes = containerNode.childNodes;\r
- val typeBuilder = addDefaultInterfaceDefinition(packageName, containerNode);\r
-\r
- resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
- return typeBuilder.toInstance();\r
- }\r
-\r
- /**\r
- * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
- * node for which <code>typeBuilder</code> was created.\r
- *\r
- * The subnodes aren't mapped to the methods if they are part of grouping or\r
- * augment (in this case are already part of them).\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param typeBuilder\r
- * generated type builder which represents any node. The subnodes\r
- * of this node are added to the <code>typeBuilder</code> as\r
- * methods. The subnode can be of type leaf, leaf-list, list,\r
- * container, choice.\r
- * @param schemaNodes\r
- * set of data schema nodes which are the children of the node\r
- * for which <code>typeBuilder</code> was created\r
- * @return generated type builder which is the same builder as input\r
- * parameter. The getter methods (representing child nodes) could be\r
- * added to it.\r
- */\r
- private def GeneratedTypeBuilder resolveDataSchemaNodes( String basePackageName,\r
- GeneratedTypeBuilder typeBuilder, Set<DataSchemaNode> schemaNodes) {\r
- if ((schemaNodes !== null) && (typeBuilder !== null)) {\r
- for (schemaNode : schemaNodes) {\r
- if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {\r
- addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
- }\r
- \r
- }\r
- }\r
- return typeBuilder;\r
- }\r
-\r
- /**\r
- * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
- * node for which <code>typeBuilder</code> was created.\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param typeBuilder\r
- * generated type builder which represents any node. The subnodes\r
- * of this node are added to the <code>typeBuilder</code> as\r
- * methods. The subnode can be of type leaf, leaf-list, list,\r
- * container, choice.\r
- * @param schemaNodes\r
- * set of data schema nodes which are the children of the node\r
- * for which <code>typeBuilder</code> was created\r
- * @return generated type builder which is the same object as the input\r
- * parameter <code>typeBuilder</code>. The getter method could be\r
- * added to it.\r
- */\r
- private def GeneratedTypeBuilder augSchemaNodeToMethods( String basePackageName,\r
- GeneratedTypeBuilder typeBuilder, Set<DataSchemaNode> schemaNodes) {\r
- if ((schemaNodes !== null) && (typeBuilder !== null)) {\r
- for (schemaNode : schemaNodes) {\r
- if (schemaNode.isAugmenting()) {\r
- addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
- }\r
- }\r
- }\r
- return typeBuilder;\r
- }\r
-\r
- /**\r
- * Adds to <code>typeBuilder</code> a method which is derived from\r
- * <code>schemaNode</code>.\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param schemaNode\r
- * data schema node which is added to <code>typeBuilder</code> as\r
- * a method\r
- * @param typeBuilder\r
- * generated type builder to which is <code>schemaNode</code>\r
- * added as a method.\r
- */\r
- private def void addSchemaNodeToBuilderAsMethod( String basePackageName, DataSchemaNode node,\r
- GeneratedTypeBuilder typeBuilder) {\r
- if (node !== null && typeBuilder !== null) {\r
- switch(node) {\r
- case node instanceof LeafSchemaNode: resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)\r
- case node instanceof LeafListSchemaNode: resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)\r
- case node instanceof ContainerSchemaNode: resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)\r
- case node instanceof ListSchemaNode: resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)\r
- case node instanceof ChoiceNode: resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Creates a getter method for a choice node.\r
- *\r
- * Firstly generated type builder for choice is created or found in\r
- * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
- * in the builder is created as concatenation of module package name and\r
- * names of all parent nodes. In the end the getter method for choice is\r
- * added to <code>typeBuilder</code> and return type is set to choice\r
- * builder.\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param typeBuilder\r
- * generated type builder to which is <code>choiceNode</code>\r
- * added as getter method\r
- * @param choiceNode\r
- * choice node which is mapped as a getter method\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>basePackageName</code> equals null</li>\r
- * <li>if <code>typeBuilder</code> equals null</li>\r
- * <li>if <code>choiceNode</code> equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def void resolveChoiceSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,\r
- ChoiceNode choiceNode) {\r
- checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");\r
- checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");\r
- checkArgument(choiceNode !== null,"Choice Schema Node cannot be NULL.");\r
-\r
- val choiceName = choiceNode.QName.localName;\r
- if (choiceName !== null && !choiceNode.isAddedByUses()) {\r
- val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
- val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);\r
- constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);\r
- }\r
- }\r
-\r
- /**\r
- * Converts <code>choiceNode</code> to the list of generated types for\r
- * choice and its cases.\r
- *\r
- * The package names for choice and for its cases are created as\r
- * concatenation of the module package (<code>basePackageName</code>) and\r
- * names of all parents node.\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param choiceNode\r
- * choice node which is mapped to generated type. Also child\r
- * nodes - cases are mapped to generated types.\r
- * @return list of generated types which contains generated type for choice\r
- * and generated types for all cases which aren't added do choice\r
- * through <i>uses</i>.\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>basePackageName</code> equals null</li>\r
- * <li>if <code>choiceNode</code> equals null</li>\r
- * </ul>\r
- *\r
- */\r
- private def List<GeneratedType> choiceToGeneratedType( String basePackageName, ChoiceNode choiceNode) {\r
- checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");\r
- checkArgument(choiceNode !== null,"Choice Schema Node cannot be NULL.");\r
-\r
- val List<GeneratedType> generatedTypes = new ArrayList();\r
- val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
- val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);\r
- //choiceTypeBuilder.addImplementsType(DATA_OBJECT);\r
- val choiceType = choiceTypeBuilder.toInstance();\r
-\r
- generatedTypes.add(choiceType);\r
- val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;\r
- if ((caseNodes !== null) && !caseNodes.isEmpty()) {\r
- generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes));\r
- }\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts <code>caseNodes</code> set to list of corresponding generated\r
- * types.\r
- *\r
- * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
- * created generated type builder. The package names for the builder is\r
- * created as concatenation of the module package (\r
- * <code>basePackageName</code>) and names of all parents nodes of the\r
- * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
- * between every case builder and <i>choice</i> type\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param refChoiceType\r
- * type which represents superior <i>case</i>\r
- * @param caseNodes\r
- * set of choice case nodes which are mapped to generated types\r
- * @return list of generated types for <code>caseNodes</code>.\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>basePackageName</code> equals null</li>\r
- * <li>if <code>refChoiceType</code> equals null</li>\r
- * <li>if <code>caseNodes</code> equals null</li>\r
- * </ul>\r
- * *\r
- */\r
- private def List<GeneratedType> generateTypesFromChoiceCases( String basePackageName, Type refChoiceType,\r
- Set<ChoiceCaseNode> caseNodes) {\r
- checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");\r
- checkArgument(refChoiceType !== null,"Referenced Choice Type cannot be NULL.");\r
- checkArgument(caseNodes !== null,"Set of Choice Case Nodes cannot be NULL.");\r
-\r
- val List<GeneratedType> generatedTypes = new ArrayList();\r
- for (caseNode : caseNodes) {\r
- if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {\r
- val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
- val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
- caseTypeBuilder.addImplementsType(refChoiceType);\r
-\r
- val Set<DataSchemaNode> childNodes = caseNode.childNodes;\r
- if (childNodes !== null) {\r
- resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);\r
- }\r
- generatedTypes.add(caseTypeBuilder.toInstance());\r
- }\r
- }\r
-\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Generates list of generated types for all the cases of a choice which are\r
- * added to the choice through the augment.\r
- *\r
- *\r
- * @param basePackageName\r
- * string contains name of package to which augment belongs. If\r
- * an augmented choice is from an other package (pcg1) than an\r
- * augmenting choice (pcg2) then case's of the augmenting choice\r
- * will belong to pcg2.\r
- * @param refChoiceType\r
- * Type which represents the choice to which case belongs. Every\r
- * case has to contain its choice in extend part.\r
- * @param caseNodes\r
- * set of choice case nodes for which is checked if are/aren't\r
- * added to choice through augmentation\r
- * @return list of generated types which represents augmented cases of\r
- * choice <code>refChoiceType</code>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>basePackageName</code> equals null</li>\r
- * <li>if <code>refChoiceType</code> equals null</li>\r
- * <li>if <code>caseNodes</code> equals null</li>\r
- * </ul>\r
- */\r
- private def List<GeneratedType> generateTypesFromAugmentedChoiceCases( String basePackageName,\r
- Type refChoiceType, Set<ChoiceCaseNode> caseNodes) {\r
- checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");\r
- checkArgument(refChoiceType !== null,"Referenced Choice Type cannot be NULL.");\r
- checkArgument(caseNodes !== null,"Set of Choice Case Nodes cannot be NULL.");\r
-\r
- val List<GeneratedType> generatedTypes = new ArrayList();\r
- for (caseNode : caseNodes) {\r
- if (caseNode !== null && caseNode.isAugmenting()) {\r
- val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
- val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
- caseTypeBuilder.addImplementsType(refChoiceType);\r
-\r
- val Set<DataSchemaNode> childNodes = caseNode.childNodes;\r
- if (childNodes !== null) {\r
- resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);\r
- }\r
- generatedTypes.add(caseTypeBuilder.toInstance());\r
- }\r
- }\r
-\r
- return generatedTypes;\r
- }\r
-\r
- /**\r
- * Converts <code>leaf</code> to the getter method which is added to\r
- * <code>typeBuilder</code>.\r
- *\r
- * @param typeBuilder\r
- * generated type builder to which is added getter method as\r
- * <code>leaf</code> mapping\r
- * @param leaf\r
- * leaf schema node which is mapped as getter method which is\r
- * added to <code>typeBuilder</code>\r
- * @return boolean value\r
- * <ul>\r
- * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
- * null</li>\r
- * <li>true - in other cases</li>\r
- * </ul>\r
- */\r
- private def boolean resolveLeafSchemaNodeAsMethod( GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {\r
- if ((leaf !== null) && (typeBuilder !== null)) {\r
- val leafName = leaf.QName.localName;\r
- var String leafDesc = leaf.description;\r
- if (leafDesc === null) {\r
- leafDesc = "";\r
- }\r
-\r
- val parentModule = findParentModule(schemaContext, leaf);\r
- if (leafName !== null && !leaf.isAddedByUses()) {\r
- val TypeDefinition<?> typeDef = leaf.type;\r
-\r
- var Type returnType = null;\r
- if (typeDef instanceof EnumTypeDefinition) {\r
- returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
- val enumTypeDef = enumTypeDefFromExtendedType(typeDef);\r
- val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName,\r
- typeBuilder);\r
-\r
- if (enumBuilder !== null) {\r
- returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
- }\r
- (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);\r
- } else if (typeDef instanceof UnionType) {\r
- val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
- if (genTOBuilder !== null) {\r
- returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
- }\r
- } else if (typeDef instanceof BitsTypeDefinition) {\r
- val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
- if (genTOBuilder !== null) {\r
- returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
- }\r
- } else {\r
- returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
- }\r
- if (returnType !== null) {\r
- constructGetter(typeBuilder, leafName, leafDesc, returnType);\r
- return true;\r
- }\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Converts <code>leaf</code> schema node to property of generated TO\r
- * builder.\r
- *\r
- * @param toBuilder\r
- * generated TO builder to which is <code>leaf</code> added as\r
- * property\r
- * @param leaf\r
- * leaf schema node which is added to <code>toBuilder</code> as\r
- * property\r
- * @param isReadOnly\r
- * boolean value which says if leaf property is|isn't read only\r
- * @return boolean value\r
- * <ul>\r
- * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
- * name equals null or if leaf is added by <i>uses</i>.</li>\r
- * <li>true - other cases</li>\r
- * </ul>\r
- */\r
- private def boolean resolveLeafSchemaNodeAsProperty( GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,\r
- boolean isReadOnly) {\r
- if ((leaf !== null) && (toBuilder !== null)) {\r
- val leafName = leaf.QName.localName;\r
- var String leafDesc = leaf.description;\r
- if (leafDesc === null) {\r
- leafDesc = "";\r
- }\r
-\r
- if (leafName !== null && !leaf.isAddedByUses()) {\r
- val TypeDefinition<?> typeDef = leaf.type;\r
-\r
- // TODO: properly resolve enum types\r
- val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
-\r
- if (returnType !== null) {\r
- val propBuilder = toBuilder.addProperty(parseToClassName(leafName));\r
-\r
- propBuilder.setReadOnly(isReadOnly);\r
- propBuilder.setReturnType(returnType);\r
- propBuilder.setComment(leafDesc);\r
-\r
- toBuilder.addEqualsIdentity(propBuilder);\r
- toBuilder.addHashIdentity(propBuilder);\r
- toBuilder.addToStringProperty(propBuilder);\r
-\r
- return true;\r
- }\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Converts <code>node</code> leaf list schema node to getter method of\r
- * <code>typeBuilder</code>.\r
- *\r
- * @param typeBuilder\r
- * generated type builder to which is <code>node</code> added as\r
- * getter method\r
- * @param node\r
- * leaf list schema node which is added to\r
- * <code>typeBuilder</code> as getter method\r
- * @return boolean value\r
- * <ul>\r
- * <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
- * nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
- * <li>false - other cases</li>\r
- * </ul>\r
- */\r
- private def boolean resolveLeafListSchemaNode( GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {\r
- if ((node !== null) && (typeBuilder !== null)) {\r
- val nodeName = node.QName.localName;\r
- var String nodeDesc = node.description;\r
- if (nodeDesc === null) {\r
- nodeDesc = "";\r
- }\r
-\r
- if (nodeName !== null && !node.isAddedByUses()) {\r
- val TypeDefinition<?> type = node.type;\r
- val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));\r
-\r
- constructGetter(typeBuilder, nodeName, nodeDesc, listType);\r
- return true;\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Creates a getter method for a container node.\r
- *\r
- * Firstly generated type builder for container is created or found in\r
- * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
- * in the builder is created as concatenation of module package name and\r
- * names of all parent nodes. In the end the getter method for container is\r
- * added to <code>typeBuilder</code> and return type is set to container\r
- * type builder.\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param typeBuilder\r
- * generated type builder to which is <code>containerNode</code>\r
- * added as getter method\r
- * @param containerNode\r
- * container schema node which is mapped as getter method to\r
- * <code>typeBuilder</code>\r
- * @return boolean value\r
- * <ul>\r
- * <li>false - if <code>containerNode</code>,\r
- * <code>typeBuilder</code>, container node name equal null or\r
- * <code>containerNode</code> is added by uses</li>\r
- * <li>true - other cases</li>\r
- * </ul>\r
- */\r
- private def boolean resolveContainerSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,\r
- ContainerSchemaNode containerNode) {\r
- if ((containerNode !== null) && (typeBuilder !== null)) {\r
- val nodeName = containerNode.QName.localName;\r
-\r
- if (nodeName !== null && !containerNode.isAddedByUses()) {\r
- val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
-\r
- val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);\r
- constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);\r
-\r
- return true;\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Creates a getter method for a list node.\r
- *\r
- * Firstly generated type builder for list is created or found in\r
- * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
- * in the builder is created as concatenation of module package name and\r
- * names of all parent nodes. In the end the getter method for list is added\r
- * to <code>typeBuilder</code> and return type is set to list type builder.\r
- *\r
- * @param basePackageName\r
- * string with the module package name\r
- * @param typeBuilder\r
- * generated type builder to which is <code></code> added as\r
- * getter method\r
- * @param listNode\r
- * list schema node which is mapped as getter method to\r
- * <code>typeBuilder</code>\r
- * @return boolean value\r
- * <ul>\r
- * <li>false - if <code>listNode</code>, <code>typeBuilder</code>,\r
- * list node name equal null or <code>listNode</code> is added by\r
- * uses</li>\r
- * <li>true - other cases</li>\r
- * </ul>\r
- */\r
- private def boolean resolveListSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,\r
- ListSchemaNode listNode) {\r
- if ((listNode !== null) && (typeBuilder !== null)) {\r
- val listName = listNode.QName.localName;\r
-\r
- if (listName !== null && !listNode.isAddedByUses()) {\r
- val packageName = packageNameForGeneratedType(basePackageName, listNode.path);\r
- val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);\r
- constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));\r
- return true;\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Instantiates generated type builder with <code>packageName</code> and\r
- * <code>schemaNode</code>.\r
- *\r
- * The new builder always implements\r
- * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
- * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
- * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
- * Augmentable}.<br />\r
- * If <code>schemaNode</code> is instance of\r
- * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
- * DataNodeContainer} it can also implement nodes which are specified in\r
- * <i>uses</i>.\r
- *\r
- * @param packageName\r
- * string with the name of the package to which\r
- * <code>schemaNode</code> belongs.\r
- * @param schemaNode\r
- * schema node for which is created generated type builder\r
- * @return generated type builder <code>schemaNode</code>\r
- */\r
- private def GeneratedTypeBuilder addDefaultInterfaceDefinition( String packageName, SchemaNode schemaNode) {\r
- val builder = addRawInterfaceDefinition(packageName, schemaNode, "");\r
- builder.addImplementsType(DATA_OBJECT);\r
- if (!(schemaNode instanceof GroupingDefinition)) {\r
- builder.addImplementsType(augmentable(builder));\r
- }\r
-\r
- if (schemaNode instanceof DataNodeContainer) {\r
- addImplementedInterfaceFromUses( schemaNode as DataNodeContainer, builder);\r
- }\r
-\r
- return builder;\r
- }\r
-\r
- /**\r
- * Wraps the calling of the same overloaded method.\r
- *\r
- * @param packageName\r
- * string with the package name to which returning generated type\r
- * builder belongs\r
- * @param schemaNode\r
- * schema node which provide data about the schema node name\r
- * @return generated type builder for <code>schemaNode</code>\r
- */\r
- private def GeneratedTypeBuilder addRawInterfaceDefinition( String packageName, SchemaNode schemaNode) {\r
- return addRawInterfaceDefinition(packageName, schemaNode, "");\r
- }\r
-\r
- /**\r
- * Returns reference to generated type builder for specified\r
- * <code>schemaNode</code> with <code>packageName</code>.\r
- *\r
- * Firstly the generated type builder is searched in\r
- * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
- * found it is created and added to <code>genTypeBuilders</code>.\r
- *\r
- * @param packageName\r
- * string with the package name to which returning generated type\r
- * builder belongs\r
- * @param schemaNode\r
- * schema node which provide data about the schema node name\r
- * @return generated type builder for <code>schemaNode</code>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>schemaNode</code> equals null</li>\r
- * <li>if <code>packageName</code> equals null</li>\r
- * <li>if Q name of schema node is null</li>\r
- * <li>if schema node name is nul</li>\r
- * </ul>\r
- *\r
- */\r
- private def GeneratedTypeBuilder addRawInterfaceDefinition( String packageName, SchemaNode schemaNode,\r
- String prefix) {\r
- checkArgument(schemaNode !== null,"Data Schema Node cannot be NULL.");\r
- checkArgument(packageName !== null,"Package Name for Generated Type cannot be NULL.");\r
- checkArgument(schemaNode.QName !== null,"QName for Data Schema Node cannot be NULL.");\r
- val schemaNodeName = schemaNode.QName.localName;\r
- checkArgument(schemaNodeName !== null,"Local Name of QName for Data Schema Node cannot be NULL.");\r
-\r
- var String genTypeName;\r
- if (prefix === null) {\r
- genTypeName = parseToClassName(schemaNodeName);\r
- } else {\r
- genTypeName = prefix + parseToClassName(schemaNodeName);\r
- }\r
- //FIXME: Validation of name conflict\r
- val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);\r
- yangToJavaMapping.put(schemaNode.path,newType);\r
- if (!genTypeBuilders.containsKey(packageName)) {\r
- val Map<String, GeneratedTypeBuilder> builders = new HashMap();\r
- builders.put(genTypeName, newType);\r
- genTypeBuilders.put(packageName, builders);\r
- } else {\r
- val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);\r
- if (!builders.containsKey(genTypeName)) {\r
- builders.put(genTypeName, newType);\r
- }\r
- }\r
- return newType;\r
- }\r
-\r
- /**\r
- * Creates the name of the getter method from <code>methodName</code>.\r
- *\r
- * @param methodName\r
- * string with the name of the getter method\r
- * @return string with the name of the getter method for\r
- * <code>methodName</code> in JAVA method format\r
- */\r
- private def String getterMethodName( String methodName,Type returnType) {\r
- val method = new StringBuilder();\r
- if(BOOLEAN.equals(returnType)) {\r
- method.append("is");\r
- } else {\r
- method.append("get");\r
- }\r
- method.append(parseToClassName(methodName));\r
- return method.toString();\r
- }\r
-\r
- /**\r
- * Created a method signature builder as part of\r
- * <code>interfaceBuilder</code>.\r
- *\r
- * The method signature builder is created for the getter method of\r
- * <code>schemaNodeName</code>. Also <code>comment</code> and\r
- * <code>returnType</code> information are added to the builder.\r
- *\r
- * @param interfaceBuilder\r
- * generated type builder for which the getter method should be\r
- * created\r
- * @param schemaNodeName\r
- * string with schema node name. The name will be the part of the\r
- * getter method name.\r
- * @param comment\r
- * string with comment for the getter method\r
- * @param returnType\r
- * type which represents the return type of the getter method\r
- * @return method signature builder which represents the getter method of\r
- * <code>interfaceBuilder</code>\r
- */\r
- private def MethodSignatureBuilder constructGetter( GeneratedTypeBuilder interfaceBuilder,\r
- String schemaNodeName, String comment, Type returnType) {\r
-\r
- val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName,returnType));\r
-\r
- getMethod.setComment(comment);\r
- getMethod.setReturnType(returnType);\r
-\r
- return getMethod;\r
- }\r
-\r
- private def listToGenType( String basePackageName, ListSchemaNode list) {\r
- checkArgument(basePackageName !== null,"Package Name for Generated Type cannot be NULL.");\r
- checkArgument(list !== null,"List Schema Node cannot be NULL.");\r
-\r
- val packageName = packageNameForGeneratedType(basePackageName, list.path);\r
- // val typeBuilder =\r
- // resolveListTypeBuilder(packageName, list);\r
- val typeBuilder = addDefaultInterfaceDefinition(packageName, list);\r
-\r
- val List<String> listKeys = listKeys(list);\r
- val genTOBuilder = resolveListKeyTOBuilder(packageName, list);\r
-\r
- if (genTOBuilder !== null) {\r
- val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);\r
- val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);\r
- genTOBuilder.addImplementsType(identifierMarker);\r
- typeBuilder.addImplementsType(identifiableMarker);\r
- }\r
- val schemaNodes = list.childNodes;\r
-\r
- for (schemaNode : schemaNodes) {\r
- if (!schemaNode.isAugmenting()) {\r
- addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);\r
- }\r
- }\r
- return typeBuildersToGenTypes(typeBuilder, genTOBuilder);\r
- }\r
-\r
- /**\r
- * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
- * or to <code>genTOBuilder</code> as property.\r
- *\r
- * @param basePackageName\r
- * string contains the module package name\r
- * @param schemaNode\r
- * data schema node which should be added as getter method to\r
- * <code>typeBuilder</code> or as a property to\r
- * <code>genTOBuilder</code> if is part of the list key\r
- * @param typeBuilder\r
- * generated type builder for the list schema node\r
- * @param genTOBuilder\r
- * generated TO builder for the list keys\r
- * @param listKeys\r
- * list of string which contains names of the list keys\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>schemaNode</code> equals null</li>\r
- * <li>if <code>typeBuilder</code> equals null</li>\r
- * </ul>\r
- */\r
- private def void addSchemaNodeToListBuilders( String basePackageName, DataSchemaNode schemaNode,\r
- GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {\r
- checkArgument(schemaNode !== null,"Data Schema Node cannot be NULL.");\r
-\r
- checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");\r
-\r
- if (schemaNode instanceof LeafSchemaNode) {\r
- val leaf = schemaNode as LeafSchemaNode;\r
- val leafName = leaf.QName.localName;\r
- if (!listKeys.contains(leafName)) {\r
- resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);\r
- } else {\r
- resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);\r
- }\r
- } else if (schemaNode instanceof LeafListSchemaNode) {\r
- resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);\r
- } else if (schemaNode instanceof ContainerSchemaNode) {\r
- resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);\r
- } else if (schemaNode instanceof ListSchemaNode) {\r
- resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);\r
- }\r
- }\r
-\r
- private def typeBuildersToGenTypes( GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {\r
- val List<Type> genTypes = new ArrayList();\r
- checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");\r
-\r
- if (genTOBuilder !== null) {\r
- val genTO = genTOBuilder.toInstance();\r
- constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);\r
- genTypes.add(genTO);\r
- }\r
- genTypes.add(typeBuilder.toInstance());\r
- return genTypes;\r
- }\r
-\r
- /**\r
- * Selects the names of the list keys from <code>list</code> and returns\r
- * them as the list of the strings\r
- *\r
- * @param list\r
- * of string with names of the list keys\r
- * @return list of string which represents names of the list keys. If the\r
- * <code>list</code> contains no keys then the empty list is\r
- * returned.\r
- */\r
- private def listKeys( ListSchemaNode list) {\r
- val List<String> listKeys = new ArrayList();\r
-\r
- if (list.keyDefinition !== null) {\r
- val keyDefinitions = list.keyDefinition;\r
- for (keyDefinition : keyDefinitions) {\r
- listKeys.add(keyDefinition.localName);\r
- }\r
- }\r
- return listKeys;\r
- }\r
-\r
- /**\r
- * Generates for the <code>list</code> which contains any list keys special\r
- * generated TO builder.\r
- *\r
- * @param packageName\r
- * string with package name to which the list belongs\r
- * @param list\r
- * list schema node which is source of data about the list name\r
- * @return generated TO builder which represents the keys of the\r
- * <code>list</code> or null if <code>list</code> is null or list of\r
- * key definitions is null or empty.\r
- */\r
- private def GeneratedTOBuilder resolveListKeyTOBuilder( String packageName, ListSchemaNode list) {\r
- var GeneratedTOBuilder genTOBuilder = null;\r
- if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {\r
- if (list !== null) {\r
- val listName = list.QName.localName + "Key";\r
- genTOBuilder = schemaNodeToTransferObjectBuilder(packageName, listName);\r
- }\r
- }\r
- return genTOBuilder;\r
-\r
- }\r
-\r
- /**\r
- * Builds generated TO builders for <code>typeDef</code> of type\r
- * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
- * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
- * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
- * enclosing transfer object.\r
- *\r
- * If more then one generated TO builder is created for enclosing then all\r
- * of the generated TO builders are added to <code>typeBuilder</code> as\r
- * enclosing transfer objects.\r
- *\r
- * @param typeDef\r
- * type definition which can be of type <code>UnionType</code> or\r
- * <code>BitsTypeDefinition</code>\r
- * @param typeBuilder\r
- * generated type builder to which is added generated TO created\r
- * from <code>typeDef</code>\r
- * @param leafName\r
- * string with name for generated TO builder\r
- * @return generated TO builder for <code>typeDef</code>\r
- */\r
- private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,\r
- String leafName, LeafSchemaNode leaf, Module parentModule) {\r
- val classNameFromLeaf = parseToClassName(leafName);\r
- val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();\r
- val packageName = typeBuilder.fullyQualifiedName;\r
- if (typeDef instanceof UnionTypeDefinition) {\r
- genTOBuilders.addAll((typeProvider as TypeProviderImpl).provideGeneratedTOBuildersForUnionTypeDef(\r
- packageName, typeDef, classNameFromLeaf, leaf));\r
- } else if (typeDef instanceof BitsTypeDefinition) {\r
- genTOBuilders.add(((typeProvider as TypeProviderImpl) ).provideGeneratedTOBuilderForBitsTypeDefinition(\r
- packageName, typeDef, classNameFromLeaf));\r
- }\r
- if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {\r
- for (genTOBuilder : genTOBuilders) {\r
- typeBuilder.addEnclosingTransferObject(genTOBuilder);\r
- }\r
- return genTOBuilders.get(0);\r
- }\r
- return null;\r
-\r
- }\r
-\r
- /**\r
- * Adds the implemented types to type builder.\r
- *\r
- * The method passes through the list of <i>uses</i> in\r
- * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
- * generated type from {@link BindingGeneratorImpl#allGroupings\r
- * allGroupings} which is added as <i>implements type</i> to\r
- * <code>builder</code>\r
- *\r
- * @param dataNodeContainer\r
- * element which contains the list of used YANG groupings\r
- * @param builder\r
- * builder to which are added implemented types according to\r
- * <code>dataNodeContainer</code>\r
- * @return generated type builder with all implemented types\r
- */\r
- private def addImplementedInterfaceFromUses( DataNodeContainer dataNodeContainer,\r
- GeneratedTypeBuilder builder) {\r
- for (usesNode : dataNodeContainer.uses) {\r
- if (usesNode.groupingPath !== null) {\r
- val genType = allGroupings.get(usesNode.groupingPath);\r
- if (genType === null) {\r
- throw new IllegalStateException("Grouping " + usesNode.groupingPath + "is not resolved for "\r
- + builder.name);\r
- }\r
- builder.addImplementsType(genType);\r
- }\r
- }\r
- return builder;\r
- }\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.sal.binding.generator.impl;
+
+import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
+import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
+import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
+import org.opendaylight.yangtools.binding.generator.util.Types;
+import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
+import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
+import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
+import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
+import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
+import org.opendaylight.yangtools.sal.binding.model.api.Type;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
+import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
+import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
+import org.opendaylight.yangtools.yang.binding.RpcService;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
+import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
+import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
+import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
+import org.opendaylight.yangtools.yang.model.util.ExtendedType;
+import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
+import org.opendaylight.yangtools.yang.model.util.UnionType;
+import static com.google.common.base.Preconditions.*;
+import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
+
+public class BindingGeneratorImpl implements BindingGenerator {
+
+ /**
+ * Outter key represents the package name. Outter value represents map of
+ * all builders in the same package. Inner key represents the schema node
+ * name (in JAVA class/interface name format). Inner value represents
+ * instance of builder for schema node specified in key part.
+ */
+ private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
+
+ /**
+ * Provide methods for converting YANG types to JAVA types.
+ */
+ private var TypeProvider typeProvider;
+
+ /**
+ * Holds reference to schema context to resolve data of augmented elemnt
+ * when creating augmentation builder
+ */
+ private var SchemaContext schemaContext;
+
+ /**
+ * Each grouping which is converted from schema node to generated type is
+ * added to this map with its Schema path as key to make it easier to get
+ * reference to it. In schema nodes in <code>uses</code> attribute there is
+ * only Schema Path but when building list of implemented interfaces for
+ * Schema node the object of type <code>Type</code> is required. So in this
+ * case is used this map.
+ */
+ private val allGroupings = new HashMap<SchemaPath, GeneratedType>();
+
+
+ private val yangToJavaMapping = new HashMap<SchemaPath, Type>();
+
+ /**
+ * Constant with the concrete name of namespace.
+ */
+ private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
+
+ /**
+ * Constant with the concrete name of identifier.
+ */
+ private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
+
+
+ /**
+ * Resolves generated types from <code>context</code> schema nodes of all
+ * modules.
+ *
+ * Generated types are created for modules, groupings, types, containers,
+ * lists, choices, augments, rpcs, notification, identities.
+ *
+ * @param context
+ * schema context which contains data about all schema nodes
+ * saved in modules
+ * @return list of types (usually <code>GeneratedType</code>
+ * <code>GeneratedTransferObject</code>which are generated from
+ * <code>context</code> data.
+ * @throws IllegalArgumentException
+ * if param <code>context</code> is null
+ * @throws IllegalStateException
+ * if <code>context</code> contain no modules
+ */
+ override generateTypes(SchemaContext context) {
+ checkArgument(context !== null,"Schema Context reference cannot be NULL.");
+ checkState(context.modules !== null,"Schema Context does not contain defined modules.");
+ val List<Type> generatedTypes = new ArrayList();
+ schemaContext = context;
+ typeProvider = new TypeProviderImpl(context);
+ val Set<Module> modules = context.modules;
+ genTypeBuilders = new HashMap();
+ for (module : modules) {
+
+ generatedTypes.addAll(allGroupingsToGenTypes(module));
+
+ if (false == module.childNodes.isEmpty()) {
+ generatedTypes.add(moduleToDataType(module));
+ }
+ generatedTypes.addAll(allTypeDefinitionsToGenTypes(module));
+ generatedTypes.addAll(allContainersToGenTypes(module));
+ generatedTypes.addAll(allListsToGenTypes(module));
+ generatedTypes.addAll(allChoicesToGenTypes(module));
+ generatedTypes.addAll(allRPCMethodsToGenType(module));
+ generatedTypes.addAll(allNotificationsToGenType(module));
+ generatedTypes.addAll(allIdentitiesToGenTypes(module, context));
+ }
+ for (module : modules) {
+ generatedTypes.addAll(allAugmentsToGenTypes(module));
+
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Resolves generated types from <code>context</code> schema nodes only for
+ * modules specified in <code>modules</code>
+ *
+ * Generated types are created for modules, groupings, types, containers,
+ * lists, choices, augments, rpcs, notification, identities.
+ *
+ * @param context
+ * schema context which contains data about all schema nodes
+ * saved in modules
+ * @param modules
+ * set of modules for which schema nodes should be generated
+ * types
+ * @return list of types (usually <code>GeneratedType</code> or
+ * <code>GeneratedTransferObject</code>) which:
+ * <ul>
+ * <li>are generated from <code>context</code> schema nodes and</li>
+ * <li>are also part of some of the module in <code>modules</code>
+ * set</li>.
+ * </ul>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if param <code>context</code> is null or</li>
+ * <li>if param <code>modules</code> is null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if <code>context</code> contain no modules
+ */
+ override generateTypes(SchemaContext context, Set<Module> modules) {
+ checkArgument(context !== null,"Schema Context reference cannot be NULL.");
+ checkState(context.modules !== null,"Schema Context does not contain defined modules.");
+ checkArgument(modules !== null,"Set of Modules cannot be NULL.");
+
+ val List<Type> filteredGenTypes = new ArrayList();
+ schemaContext = context;
+ typeProvider = new TypeProviderImpl(context);
+ val Set<Module> contextModules = context.modules;
+ genTypeBuilders = new HashMap();
+
+ for (contextModule : contextModules) {
+ val List<Type> generatedTypes = new ArrayList();
+
+ generatedTypes.addAll(allGroupingsToGenTypes(contextModule));
+ if (false == contextModule.childNodes.isEmpty()) {
+ generatedTypes.add(moduleToDataType(contextModule));
+ }
+ generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));
+ generatedTypes.addAll(allContainersToGenTypes(contextModule));
+ generatedTypes.addAll(allListsToGenTypes(contextModule));
+ generatedTypes.addAll(allChoicesToGenTypes(contextModule));
+ generatedTypes.addAll(allRPCMethodsToGenType(contextModule));
+ generatedTypes.addAll(allNotificationsToGenType(contextModule));
+ generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));
+
+ if (modules.contains(contextModule)) {
+ filteredGenTypes.addAll(generatedTypes);
+ }
+ }
+ for (contextModule : contextModules) {
+ val generatedTypes = (allAugmentsToGenTypes(contextModule));
+ if (modules.contains(contextModule)) {
+ filteredGenTypes.addAll(generatedTypes);
+ }
+
+ }
+ return filteredGenTypes;
+ }
+
+ /**
+ * Converts all extended type definitions of module to the list of
+ * <code>Type</code> objects.
+ *
+ * @param module
+ * module from which is obtained set of type definitions
+ * @return list of <code>Type</code> which are generated from extended
+ * definition types (object of type <code>ExtendedType</code>)
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if module equals null</li>
+ * <li>if name of module equals null</li>
+ * <li>if type definitions of module equal null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allTypeDefinitionsToGenTypes( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+ val Set<TypeDefinition<?>> typeDefinitions = module.typeDefinitions;
+ checkState(typeDefinitions !== null,'''Type Definitions for module «module.name» cannot be NULL.''');
+
+
+ val List<Type> generatedTypes = new ArrayList();
+ for ( TypeDefinition<?> typedef : typeDefinitions) {
+ if (typedef !== null) {
+ val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
+ if ((type !== null) && !generatedTypes.contains(type)) {
+ generatedTypes.add(type);
+ }
+ }
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Converts all <b>containers</b> of the module to the list of
+ * <code>Type</code> objects.
+ *
+ * @param module
+ * module from which is obtained DataNodeIterator to iterate over
+ * all containers
+ * @return list of <code>Type</code> which are generated from containers
+ * (objects of type <code>ContainerSchemaNode</code>)
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * <li>if the set of child nodes equals null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allContainersToGenTypes( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+
+ if (module.childNodes === null) {
+ throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.name
+ + " cannot be NULL.");
+ }
+
+ val List<Type> generatedTypes = new ArrayList();
+ val it = new DataNodeIterator(module);
+ val List<ContainerSchemaNode> schemaContainers = it.allContainers();
+ val basePackageName = moduleNamespaceToPackageName(module);
+ for (container : schemaContainers) {
+ if (!container.isAddedByUses()) {
+ generatedTypes.add(containerToGenType(basePackageName, container));
+ }
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Converts all <b>lists</b> of the module to the list of <code>Type</code>
+ * objects.
+ *
+ * @param module
+ * module from which is obtained DataNodeIterator to iterate over
+ * all lists
+ * @return list of <code>Type</code> which are generated from lists (objects
+ * of type <code>ListSchemaNode</code>)
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * <li>if the set of child nodes equals null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allListsToGenTypes( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+
+ if (module.childNodes === null) {
+ throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.name
+ + " cannot be NULL.");
+ }
+
+ val List<Type> generatedTypes = new ArrayList();
+ val it = new DataNodeIterator(module);
+ val List<ListSchemaNode> schemaLists = it.allLists();
+ val basePackageName = moduleNamespaceToPackageName(module);
+ if (schemaLists !== null) {
+ for (list : schemaLists) {
+ if (!list.isAddedByUses()) {
+ generatedTypes.addAll(listToGenType(basePackageName, list));
+ }
+ }
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Converts all <b>choices</b> of the module to the list of
+ * <code>Type</code> objects.
+ *
+ * @param module
+ * module from which is obtained DataNodeIterator to iterate over
+ * all choices
+ * @return list of <code>Type</code> which are generated from choices
+ * (objects of type <code>ChoiceNode</code>)
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li> *
+ * </ul>
+ *
+ */
+ private def List<GeneratedType> allChoicesToGenTypes( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+
+ val it = new DataNodeIterator(module);
+ val choiceNodes = it.allChoices();
+ val basePackageName = moduleNamespaceToPackageName(module);
+
+ val List<GeneratedType> generatedTypes = new ArrayList();
+ for (choice : choiceNodes) {
+ if ((choice !== null) && !choice.isAddedByUses()) {
+ generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice));
+ }
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Converts all <b>augmentation</b> of the module to the list
+ * <code>Type</code> objects.
+ *
+ * @param module
+ * module from which is obtained list of all augmentation objects
+ * to iterate over them
+ * @return list of <code>Type</code> which are generated from augments
+ * (objects of type <code>AugmentationSchema</code>)
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * <li>if the set of child nodes equals null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allAugmentsToGenTypes( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+ if (module.childNodes === null) {
+ throw new IllegalArgumentException("Reference to Set of Augmentation Definitions in module "
+ + module.name + " cannot be NULL.");
+ }
+
+ val List<Type> generatedTypes = new ArrayList();
+ val basePackageName = moduleNamespaceToPackageName(module);
+ val List<AugmentationSchema> augmentations = resolveAugmentations(module);
+ for (augment : augmentations) {
+ generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment));
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Returns list of <code>AugmentationSchema</code> objects. The objects are
+ * sorted according to the length of their target path from the shortest to
+ * the longest.
+ *
+ * @param module
+ * module from which is obtained list of all augmentation objects
+ * @return list of sorted <code>AugmentationSchema</code> objects obtained
+ * from <code>module</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the set of augmentation equals null</li>
+ * </ul>
+ *
+ */
+ private def List<AugmentationSchema> resolveAugmentations( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ checkState(module.augmentations !== null,"Augmentations Set cannot be NULL.");
+
+ val Set<AugmentationSchema> augmentations = module.augmentations;
+ val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
+ Collections.sort(sortedAugmentations, [augSchema1, augSchema2 |
+
+ if (augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
+ return 1;
+ } else if (augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
+ return -1;
+ }
+ return 0;
+ ]);
+ return sortedAugmentations;
+ }
+
+ /**
+ * Converts whole <b>module</b> to <code>GeneratedType</code> object.
+ * Firstly is created the module builder object from which is vally
+ * obtained reference to <code>GeneratedType</code> object.
+ *
+ * @param module
+ * module from which are obtained the module name, child nodes,
+ * uses and is derived package name
+ * @return <code>GeneratedType</code> which is internal representation of
+ * the module
+ * @throws IllegalArgumentException
+ * if the module equals null
+ *
+ */
+ private def GeneratedType moduleToDataType( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+
+ val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
+ addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
+ moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
+
+ val basePackageName = moduleNamespaceToPackageName(module);
+ if (moduleDataTypeBuilder !== null) {
+ val Set<DataSchemaNode> dataNodes = module.childNodes;
+ resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);
+ }
+ return moduleDataTypeBuilder.toInstance();
+ }
+
+ /**
+ * Converts all <b>rpcs</b> inputs and outputs substatements of the module
+ * to the list of <code>Type</code> objects. In addition are to containers
+ * and lists which belong to input or output also part of returning list.
+ *
+ * @param module
+ * module from which is obtained set of all rpc objects to
+ * iterate over them
+ * @return list of <code>Type</code> which are generated from rpcs inputs,
+ * outputs + container and lists which are part of inputs or outputs
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * <li>if the set of child nodes equals null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allRPCMethodsToGenType( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+
+ if (module.childNodes === null) {
+ throw new IllegalArgumentException("Reference to Set of RPC Method Definitions in module "
+ + module.name + " cannot be NULL.");
+ }
+
+ val basePackageName = moduleNamespaceToPackageName(module);
+ val Set<RpcDefinition> rpcDefinitions = module.rpcs;
+
+ if (rpcDefinitions.isEmpty()) {
+ return Collections.emptyList();
+ }
+
+ val List<Type> genRPCTypes = new ArrayList();
+ val interfaceBuilder = moduleTypeBuilder(module, "Service");
+ interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
+ for (rpc : rpcDefinitions) {
+ if (rpc !== null) {
+
+ val rpcName = parseToClassName(rpc.QName.localName);
+ val rpcMethodName = parseToValidParamName(rpcName);
+ val method = interfaceBuilder.addMethod(rpcMethodName);
+
+ val rpcInOut = new ArrayList();
+
+ val input = rpc.input;
+ val output = rpc.output;
+
+ if (input !== null) {
+ rpcInOut.add(new DataNodeIterator(input));
+ val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
+ addImplementedInterfaceFromUses(input, inType);
+ inType.addImplementsType(DATA_OBJECT);
+ inType.addImplementsType(augmentable(inType));
+ resolveDataSchemaNodes(basePackageName, inType, input.childNodes);
+ val inTypeInstance = inType.toInstance();
+ genRPCTypes.add(inTypeInstance);
+ method.addParameter(inTypeInstance, "input");
+ }
+
+ var Type outTypeInstance = VOID;
+ if (output !== null) {
+ rpcInOut.add(new DataNodeIterator(output));
+ val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
+ addImplementedInterfaceFromUses(output, outType);
+ outType.addImplementsType(DATA_OBJECT);
+ outType.addImplementsType(augmentable(outType));
+
+ resolveDataSchemaNodes(basePackageName, outType, output.childNodes);
+ outTypeInstance = outType.toInstance();
+ genRPCTypes.add(outTypeInstance);
+
+ }
+
+ val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
+ method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
+ for (iter : rpcInOut) {
+ val List<ContainerSchemaNode> nContainers = iter.allContainers();
+ if ((nContainers !== null) && !nContainers.isEmpty()) {
+ for (container : nContainers) {
+ if (!container.isAddedByUses()) {
+ genRPCTypes.add(containerToGenType(basePackageName, container));
+ }
+ }
+ }
+ val List<ListSchemaNode> nLists = iter.allLists();
+ if ((nLists !== null) && !nLists.isEmpty()) {
+ for (list : nLists) {
+ if (!list.isAddedByUses()) {
+ genRPCTypes.addAll(listToGenType(basePackageName, list));
+ }
+ }
+ }
+ }
+ }
+ }
+ genRPCTypes.add(interfaceBuilder.toInstance());
+ return genRPCTypes;
+ }
+
+ /**
+ * Converts all <b>notifications</b> of the module to the list of
+ * <code>Type</code> objects. In addition are to this list added containers
+ * and lists which are part of this notification.
+ *
+ * @param module
+ * module from which is obtained set of all notification objects
+ * to iterate over them
+ * @return list of <code>Type</code> which are generated from notification
+ * (object of type <code>NotificationDefinition</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * <li>if the set of child nodes equals null</li>
+ * </ul>
+ *
+ */
+ private def List<Type> allNotificationsToGenType( Module module) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+
+ checkArgument(module.name !== null,"Module name cannot be NULL.");
+
+ if (module.childNodes === null) {
+ throw new IllegalArgumentException("Reference to Set of Notification Definitions in module "
+ + module.name + " cannot be NULL.");
+ }
+ val notifications = module.notifications;
+ if(notifications.isEmpty()) return Collections.emptyList();
+
+ val listenerInterface = moduleTypeBuilder(module, "Listener");
+ listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
+
+
+
+ val basePackageName = moduleNamespaceToPackageName(module);
+ val List<Type> generatedTypes = new ArrayList();
+
+
+ for ( notification : notifications) {
+ if (notification !== null) {
+ val iter = new DataNodeIterator(notification);
+
+ // Containers
+ for (node : iter.allContainers()) {
+ if (!node.isAddedByUses()) {
+ generatedTypes.add(containerToGenType(basePackageName, node));
+ }
+ }
+ // Lists
+ for (node : iter.allLists()) {
+ if (!node.isAddedByUses()) {
+ generatedTypes.addAll(listToGenType(basePackageName, node));
+ }
+ }
+ val notificationInterface = addDefaultInterfaceDefinition(basePackageName,
+ notification);
+ notificationInterface.addImplementsType(NOTIFICATION);
+ // Notification object
+ resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);
+
+ listenerInterface.addMethod("on"+notificationInterface.name) //
+ .setAccessModifier(AccessModifier.PUBLIC)
+ .addParameter(notificationInterface, "notification")
+ .setReturnType(Types.VOID);
+
+ generatedTypes.add(notificationInterface.toInstance());
+ }
+ }
+ generatedTypes.add(listenerInterface.toInstance());
+ return generatedTypes;
+ }
+
+ /**
+ * Converts all <b>identities</b> of the module to the list of
+ * <code>Type</code> objects.
+ *
+ * @param module
+ * module from which is obtained set of all identity objects to
+ * iterate over them
+ * @param context
+ * schema context only used as input parameter for method
+ * {@link identityToGenType}
+ * @return list of <code>Type</code> which are generated from identities
+ * (object of type <code>IdentitySchemaNode</code>
+ *
+ */
+ private def List<Type> allIdentitiesToGenTypes( Module module, SchemaContext context) {
+ val List<Type> genTypes = new ArrayList();
+
+ val Set<IdentitySchemaNode> schemaIdentities = module.identities;
+
+ val basePackageName = moduleNamespaceToPackageName(module);
+
+ if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {
+ for (identity : schemaIdentities) {
+ genTypes.add(identityToGenType(basePackageName, identity, context));
+ }
+ }
+ return genTypes;
+ }
+
+ /**
+ * Converts the <b>identity</b> object to GeneratedType. Firstly it is
+ * created transport object builder. If identity contains base identity then
+ * reference to base identity is added to superior identity as its extend.
+ * If identity doesn't contain base identity then only reference to abstract
+ * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
+ * BaseIdentity} is added
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param identity
+ * IdentitySchemaNode which contains data about identity
+ * @param context
+ * SchemaContext which is used to get package and name
+ * information about base of identity
+ *
+ * @return GeneratedType which is generated from identity (object of type
+ * <code>IdentitySchemaNode</code>
+ *
+ */
+ private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,
+ SchemaContext context) {
+ if (identity === null) {
+ return null;
+ }
+
+ val packageName = packageNameForGeneratedType(basePackageName, identity.path);
+ val genTypeName = parseToClassName(identity.QName.localName);
+ val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
+
+ val baseIdentity = identity.baseIdentity;
+ if (baseIdentity !== null) {
+ val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
+
+ val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
+ val returnTypeName = parseToClassName(baseIdentity.QName.localName);
+
+ val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
+ newType.setExtendsType(gto);
+ } else {
+ newType.setExtendsType(Types.baseIdentityTO);
+ }
+ newType.setAbstract(true);
+ return newType.toInstance();
+ }
+
+ /**
+ * Converts all <b>groupings</b> of the module to the list of
+ * <code>Type</code> objects. Firstly are groupings sorted according mutual
+ * dependencies. At least dependend (indepedent) groupings are in the list
+ * saved at first positions. For every grouping the record is added to map
+ * {@link BindingGeneratorImpl#allGroupings allGroupings}
+ *
+ * @param module
+ * module from which is obtained set of all grouping objects to
+ * iterate over them
+ * @return list of <code>Type</code> which are generated from groupings
+ * (object of type <code>GroupingDefinition</code>)
+ *
+ */
+ private def List<Type> allGroupingsToGenTypes( Module module) {
+ checkArgument(module !== null,"Module parameter can not be null");
+ val List<Type> genTypes = new ArrayList();
+ val basePackageName = moduleNamespaceToPackageName(module);
+ val Set<GroupingDefinition> groupings = module.groupings;
+ val GroupingDefinitionDependencySort groupingSort = new GroupingDefinitionDependencySort();
+ val List<GroupingDefinition> groupingsSortedByDependencies = groupingSort.sort(groupings);
+
+ for (grouping : groupingsSortedByDependencies) {
+ val genType = groupingToGenType(basePackageName, grouping);
+ genTypes.add(genType);
+ val schemaPath = grouping.path;
+ allGroupings.put(schemaPath, genType);
+ }
+ return genTypes;
+ }
+
+ /**
+ * Converts individual grouping to GeneratedType. Firstly generated type
+ * builder is created and every child node of grouping is resolved to the
+ * method.
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param grouping
+ * GroupingDefinition which contains data about grouping
+ * @return GeneratedType which is generated from grouping (object of type
+ * <code>GroupingDefinition</code>)
+ */
+ private def GeneratedType groupingToGenType( String basePackageName, GroupingDefinition grouping) {
+ if (grouping === null) {
+ return null;
+ }
+
+ val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
+ val Set<DataSchemaNode> schemaNodes = grouping.childNodes;
+ val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);
+
+ resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
+ return typeBuilder.toInstance();
+ }
+
+ /**
+ * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
+ * type of <code>typeDefinition</code> is of the type ExtendedType then this
+ * method is recursivelly called with this base type.
+ *
+ * @param typeDefinition
+ * TypeDefinition in which should be EnumTypeDefinition found as
+ * base type
+ * @return EnumTypeDefinition if it is found inside
+ * <code>typeDefinition</code> or <code>null</code> in other case
+ */
+ private def EnumTypeDefinition enumTypeDefFromExtendedType( TypeDefinition<?> typeDefinition) {
+ if (typeDefinition !== null) {
+ if (typeDefinition.baseType instanceof EnumTypeDefinition) {
+ return typeDefinition.baseType as EnumTypeDefinition;
+ } else if (typeDefinition.baseType instanceof ExtendedType) {
+ return enumTypeDefFromExtendedType(typeDefinition.baseType);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Adds enumeration builder created from <code>enumTypeDef</code> to
+ * <code>typeBuilder</code>.
+ *
+ * Each <code>enumTypeDef</code> item is added to builder with its name and
+ * value.
+ *
+ * @param enumTypeDef
+ * EnumTypeDefinition contains enum data
+ * @param enumName
+ * string contains name which will be assigned to enumeration
+ * builder
+ * @param typeBuilder
+ * GeneratedTypeBuilder to which will be enum builder assigned
+ * @return enumeration builder which contais data from
+ * <code>enumTypeDef</code>
+ */
+ private def EnumBuilder resolveInnerEnumFromTypeDefinition( EnumTypeDefinition enumTypeDef, String enumName,
+ GeneratedTypeBuilder typeBuilder) {
+ if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null)
+ && (enumTypeDef.QName.localName !== null)) {
+
+ val enumerationName = parseToClassName(enumName);
+ val enumBuilder = typeBuilder.addEnumeration(enumerationName);
+ enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
+
+ return enumBuilder;
+ }
+ return null;
+ }
+
+ /**
+ * Generates type builder for <code>module</code>.
+ *
+ * @param module
+ * Module which is source of package name for generated type
+ * builder
+ * @param postfix
+ * string which is added to the module class name representation
+ * as suffix
+ * @return instance of GeneratedTypeBuilder which represents
+ * <code>module</code>.
+ * @throws IllegalArgumentException
+ * if <code>module</code> equals null
+ */
+ private def GeneratedTypeBuilder moduleTypeBuilder( Module module, String postfix) {
+ checkArgument(module !== null,"Module reference cannot be NULL.");
+ val packageName = moduleNamespaceToPackageName(module);
+ val moduleName = parseToClassName(module.name) + postfix;
+
+ return new GeneratedTypeBuilderImpl(packageName, moduleName);
+
+ }
+
+ /**
+ * Converts <code>augSchema</code> to list of <code>Type</code> which
+ * contains generated type for augmentation. In addition there are also
+ * generated types for all containers, list and choices which are child of
+ * <code>augSchema</code> node or a generated types for cases are added if
+ * augmented node is choice.
+ *
+ * @param augmentPackageName
+ * string with the name of the package to which the augmentation
+ * belongs
+ * @param augSchema
+ * AugmentationSchema which is contains data about agumentation
+ * (target path, childs...)
+ * @return list of <code>Type</code> objects which contains generated type
+ * for augmentation and for container, list and choice child nodes
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>augmentPackageName</code> equals null</li>
+ * <li>if <code>augSchema</code> equals null</li>
+ * <li>if target path of <code>augSchema</code> equals null</li>
+ * </ul>
+ */
+ private def List<Type> augmentationToGenTypes( String augmentPackageName, AugmentationSchema augSchema) {
+ checkArgument(augmentPackageName !== null,"Package Name cannot be NULL.");
+ checkArgument(augSchema !== null,"Augmentation Schema cannot be NULL.");
+ checkState(augSchema.targetPath !== null,"Augmentation Schema does not contain Target Path (Target Path is NULL).");
+
+ val List<Type> genTypes = new ArrayList();
+
+ // EVERY augmented interface will extends Augmentation<T> interface
+ // and DataObject interface!!!
+ val targetPath = augSchema.targetPath;
+ val targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
+ val targetType = yangToJavaMapping.get(targetSchemaNode.path);
+ if ((targetSchemaNode !== null) && (targetSchemaNode.QName !== null)
+ && (targetSchemaNode.QName.localName !== null)) {
+
+ val targetPackageName = targetType.packageName;
+ val targetSchemaNodeName = targetType.name;
+
+
+ val augChildNodes = augSchema.childNodes;
+
+ if (!(targetSchemaNode instanceof ChoiceNode)) {
+ val augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName,
+ targetType, augSchema);
+ val augType = augTypeBuilder.toInstance();
+ genTypes.add(augType);
+ } else {
+ val refChoiceType = new ReferencedTypeImpl(targetPackageName,
+ parseToClassName(targetSchemaNodeName));
+ val choiceTarget = targetSchemaNode as ChoiceNode;
+ val choiceCaseNodes = choiceTarget.cases;
+ genTypes.addAll(generateTypesFromAugmentedChoiceCases(augmentPackageName, refChoiceType,
+ choiceCaseNodes));
+ }
+ genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes));
+ }
+ return genTypes;
+ }
+
+ /**
+ * Returns a generated type builder for an augmentation.
+ *
+ * The name of the type builder is equal to the name of augmented node with
+ * serial number as suffix.
+ *
+ * @param augmentPackageName
+ * string with contains the package name to which the augment
+ * belongs
+ * @param targetPackageName
+ * string with the package name to which the augmented node
+ * belongs
+ * @param targetSchemaNodeName
+ * string with the name of the augmented node
+ * @param augSchema
+ * augmentation schema which contains data about the child nodes
+ * and uses of augment
+ * @return generated type builder for augment
+ */
+ private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition( String augmentPackageName,
+ Type targetTypeRef, AugmentationSchema augSchema) {
+ var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
+ if (augmentBuilders === null) {
+ augmentBuilders = new HashMap();
+ genTypeBuilders.put(augmentPackageName, augmentBuilders);
+ }
+ val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
+
+ val augTypeName = if (augIdentifier !== null ) {
+ parseToClassName(augIdentifier)
+ } else {
+ augGenTypeName(augmentBuilders, targetTypeRef.name);
+ }
+ val Set<DataSchemaNode> augChildNodes = augSchema.childNodes;
+
+ val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
+
+ augTypeBuilder.addImplementsType(DATA_OBJECT);
+ augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
+ addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
+
+ augSchemaNodeToMethods(augmentPackageName, augTypeBuilder, augChildNodes);
+ augmentBuilders.put(augTypeName, augTypeBuilder);
+ return augTypeBuilder;
+ }
+
+ /**
+ *
+ * @param unknownSchemaNodes
+ * @return
+ */
+ private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
+ for (unknownSchemaNode : unknownSchemaNodes) {
+ val nodeType = unknownSchemaNode.nodeType;
+ if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName)
+ && YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
+ return unknownSchemaNode.nodeParameter;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Convert a container, list and choice subnodes (and recursivelly their
+ * subnodes) of augment to generated types
+ *
+ * @param augBasePackageName
+ * string with the augment package name
+ * @param augChildNodes
+ * set of data schema nodes which represents child nodes of the
+ * augment
+ *
+ * @return list of <code>Type</code> which represents container, list and
+ * choice subnodes of augment
+ */
+ private def List<Type> augmentationBodyToGenTypes( String augBasePackageName,
+ Set<DataSchemaNode> augChildNodes) {
+ val List<Type> genTypes = new ArrayList();
+ val List<DataNodeIterator> augSchemaIts = new ArrayList();
+ for (childNode : augChildNodes) {
+ if (childNode instanceof DataNodeContainer) {
+ augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));
+
+ if (childNode instanceof ContainerSchemaNode) {
+ genTypes.add(containerToGenType(augBasePackageName, childNode as ContainerSchemaNode));
+ } else if (childNode instanceof ListSchemaNode) {
+ genTypes.addAll(listToGenType(augBasePackageName, childNode as ListSchemaNode));
+ }
+ } else if (childNode instanceof ChoiceNode) {
+ val choice = childNode as ChoiceNode;
+ for (caseNode : choice.cases) {
+ augSchemaIts.add(new DataNodeIterator(caseNode));
+ }
+ genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode));
+ }
+ }
+
+ for (it : augSchemaIts) {
+ val List<ContainerSchemaNode> augContainers = it.allContainers();
+ val List<ListSchemaNode> augLists = it.allLists();
+ val List<ChoiceNode> augChoices = it.allChoices();
+
+ if (augContainers !== null) {
+ for (container : augContainers) {
+ genTypes.add(containerToGenType(augBasePackageName, container));
+ }
+ }
+ if (augLists !== null) {
+ for (list : augLists) {
+ genTypes.addAll(listToGenType(augBasePackageName, list));
+ }
+ }
+ if (augChoices !== null) {
+ for (choice : augChoices) {
+ genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice));
+ }
+ }
+ }
+ return genTypes;
+ }
+
+ /**
+ * Returns first unique name for the augment generated type builder. The
+ * generated type builder name for augment consists from name of augmented
+ * node and serial number of its augmentation.
+ *
+ * @param builders
+ * map of builders which were created in the package to which the
+ * augmentation belongs
+ * @param genTypeName
+ * string with name of augmented node
+ * @return string with unique name for augmentation builder
+ */
+ private def String augGenTypeName( Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
+ var index = 1;
+ while ((builders !== null) && builders.containsKey(genTypeName + index)) {
+ index = index + 1;
+ }
+ return genTypeName + index;
+ }
+
+ /**
+ * Converts <code>containerNode</code> to generated type. Firstly the
+ * generated type builder is created. The subnodes of
+ * <code>containerNode</code> are added as methods and the instance of
+ * <code>GeneratedType</code> is returned.
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param containerNode
+ * container schema node with the data about childs nodes and
+ * schema paths
+ * @return generated type for <code>containerNode</code>
+ */
+ private def GeneratedType containerToGenType( String basePackageName, ContainerSchemaNode containerNode) {
+ if (containerNode === null) {
+ return null;
+ }
+
+ val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
+ val schemaNodes = containerNode.childNodes;
+ val typeBuilder = addDefaultInterfaceDefinition(packageName, containerNode);
+
+ resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
+ return typeBuilder.toInstance();
+ }
+
+ /**
+ * Adds the methods to <code>typeBuilder</code> which represent subnodes of
+ * node for which <code>typeBuilder</code> was created.
+ *
+ * The subnodes aren't mapped to the methods if they are part of grouping or
+ * augment (in this case are already part of them).
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param typeBuilder
+ * generated type builder which represents any node. The subnodes
+ * of this node are added to the <code>typeBuilder</code> as
+ * methods. The subnode can be of type leaf, leaf-list, list,
+ * container, choice.
+ * @param schemaNodes
+ * set of data schema nodes which are the children of the node
+ * for which <code>typeBuilder</code> was created
+ * @return generated type builder which is the same builder as input
+ * parameter. The getter methods (representing child nodes) could be
+ * added to it.
+ */
+ private def GeneratedTypeBuilder resolveDataSchemaNodes( String basePackageName,
+ GeneratedTypeBuilder typeBuilder, Set<DataSchemaNode> schemaNodes) {
+ if ((schemaNodes !== null) && (typeBuilder !== null)) {
+ for (schemaNode : schemaNodes) {
+ if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
+ addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
+ }
+
+ }
+ }
+ return typeBuilder;
+ }
+
+ /**
+ * Adds the methods to <code>typeBuilder</code> what represents subnodes of
+ * node for which <code>typeBuilder</code> was created.
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param typeBuilder
+ * generated type builder which represents any node. The subnodes
+ * of this node are added to the <code>typeBuilder</code> as
+ * methods. The subnode can be of type leaf, leaf-list, list,
+ * container, choice.
+ * @param schemaNodes
+ * set of data schema nodes which are the children of the node
+ * for which <code>typeBuilder</code> was created
+ * @return generated type builder which is the same object as the input
+ * parameter <code>typeBuilder</code>. The getter method could be
+ * added to it.
+ */
+ private def GeneratedTypeBuilder augSchemaNodeToMethods( String basePackageName,
+ GeneratedTypeBuilder typeBuilder, Set<DataSchemaNode> schemaNodes) {
+ if ((schemaNodes !== null) && (typeBuilder !== null)) {
+ for (schemaNode : schemaNodes) {
+ if (schemaNode.isAugmenting()) {
+ addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
+ }
+ }
+ }
+ return typeBuilder;
+ }
+
+ /**
+ * Adds to <code>typeBuilder</code> a method which is derived from
+ * <code>schemaNode</code>.
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param schemaNode
+ * data schema node which is added to <code>typeBuilder</code> as
+ * a method
+ * @param typeBuilder
+ * generated type builder to which is <code>schemaNode</code>
+ * added as a method.
+ */
+ private def void addSchemaNodeToBuilderAsMethod( String basePackageName, DataSchemaNode node,
+ GeneratedTypeBuilder typeBuilder) {
+ if (node !== null && typeBuilder !== null) {
+ switch(node) {
+ case node instanceof LeafSchemaNode: resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
+ case node instanceof LeafListSchemaNode: resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
+ case node instanceof ContainerSchemaNode: resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)
+ case node instanceof ListSchemaNode: resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)
+ case node instanceof ChoiceNode: resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)
+ }
+ }
+ }
+
+ /**
+ * Creates a getter method for a choice node.
+ *
+ * Firstly generated type builder for choice is created or found in
+ * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
+ * in the builder is created as concatenation of module package name and
+ * names of all parent nodes. In the end the getter method for choice is
+ * added to <code>typeBuilder</code> and return type is set to choice
+ * builder.
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param typeBuilder
+ * generated type builder to which is <code>choiceNode</code>
+ * added as getter method
+ * @param choiceNode
+ * choice node which is mapped as a getter method
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>basePackageName</code> equals null</li>
+ * <li>if <code>typeBuilder</code> equals null</li>
+ * <li>if <code>choiceNode</code> equals null</li>
+ * </ul>
+ *
+ */
+ private def void resolveChoiceSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,
+ ChoiceNode choiceNode) {
+ checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");
+ checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");
+ checkArgument(choiceNode !== null,"Choice Schema Node cannot be NULL.");
+
+ val choiceName = choiceNode.QName.localName;
+ if (choiceName !== null && !choiceNode.isAddedByUses()) {
+ val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
+ val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);
+ constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);
+ }
+ }
+
+ /**
+ * Converts <code>choiceNode</code> to the list of generated types for
+ * choice and its cases.
+ *
+ * The package names for choice and for its cases are created as
+ * concatenation of the module package (<code>basePackageName</code>) and
+ * names of all parents node.
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param choiceNode
+ * choice node which is mapped to generated type. Also child
+ * nodes - cases are mapped to generated types.
+ * @return list of generated types which contains generated type for choice
+ * and generated types for all cases which aren't added do choice
+ * through <i>uses</i>.
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>basePackageName</code> equals null</li>
+ * <li>if <code>choiceNode</code> equals null</li>
+ * </ul>
+ *
+ */
+ private def List<GeneratedType> choiceToGeneratedType( String basePackageName, ChoiceNode choiceNode) {
+ checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");
+ checkArgument(choiceNode !== null,"Choice Schema Node cannot be NULL.");
+
+ val List<GeneratedType> generatedTypes = new ArrayList();
+ val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
+ val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
+ //choiceTypeBuilder.addImplementsType(DATA_OBJECT);
+ val choiceType = choiceTypeBuilder.toInstance();
+
+ generatedTypes.add(choiceType);
+ val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
+ if ((caseNodes !== null) && !caseNodes.isEmpty()) {
+ generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes));
+ }
+ return generatedTypes;
+ }
+
+ /**
+ * Converts <code>caseNodes</code> set to list of corresponding generated
+ * types.
+ *
+ * For every <i>case</i> which isn't added through augment or <i>uses</i> is
+ * created generated type builder. The package names for the builder is
+ * created as concatenation of the module package (
+ * <code>basePackageName</code>) and names of all parents nodes of the
+ * concrete <i>case</i>. There is also relation "<i>implements type</i>"
+ * between every case builder and <i>choice</i> type
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param refChoiceType
+ * type which represents superior <i>case</i>
+ * @param caseNodes
+ * set of choice case nodes which are mapped to generated types
+ * @return list of generated types for <code>caseNodes</code>.
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>basePackageName</code> equals null</li>
+ * <li>if <code>refChoiceType</code> equals null</li>
+ * <li>if <code>caseNodes</code> equals null</li>
+ * </ul>
+ * *
+ */
+ private def List<GeneratedType> generateTypesFromChoiceCases( String basePackageName, Type refChoiceType,
+ Set<ChoiceCaseNode> caseNodes) {
+ checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");
+ checkArgument(refChoiceType !== null,"Referenced Choice Type cannot be NULL.");
+ checkArgument(caseNodes !== null,"Set of Choice Case Nodes cannot be NULL.");
+
+ val List<GeneratedType> generatedTypes = new ArrayList();
+ for (caseNode : caseNodes) {
+ if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
+ val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
+ val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
+ caseTypeBuilder.addImplementsType(refChoiceType);
+
+ val Set<DataSchemaNode> childNodes = caseNode.childNodes;
+ if (childNodes !== null) {
+ resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);
+ }
+ generatedTypes.add(caseTypeBuilder.toInstance());
+ }
+ }
+
+ return generatedTypes;
+ }
+
+ /**
+ * Generates list of generated types for all the cases of a choice which are
+ * added to the choice through the augment.
+ *
+ *
+ * @param basePackageName
+ * string contains name of package to which augment belongs. If
+ * an augmented choice is from an other package (pcg1) than an
+ * augmenting choice (pcg2) then case's of the augmenting choice
+ * will belong to pcg2.
+ * @param refChoiceType
+ * Type which represents the choice to which case belongs. Every
+ * case has to contain its choice in extend part.
+ * @param caseNodes
+ * set of choice case nodes for which is checked if are/aren't
+ * added to choice through augmentation
+ * @return list of generated types which represents augmented cases of
+ * choice <code>refChoiceType</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>basePackageName</code> equals null</li>
+ * <li>if <code>refChoiceType</code> equals null</li>
+ * <li>if <code>caseNodes</code> equals null</li>
+ * </ul>
+ */
+ private def List<GeneratedType> generateTypesFromAugmentedChoiceCases( String basePackageName,
+ Type refChoiceType, Set<ChoiceCaseNode> caseNodes) {
+ checkArgument(basePackageName !== null,"Base Package Name cannot be NULL.");
+ checkArgument(refChoiceType !== null,"Referenced Choice Type cannot be NULL.");
+ checkArgument(caseNodes !== null,"Set of Choice Case Nodes cannot be NULL.");
+
+ val List<GeneratedType> generatedTypes = new ArrayList();
+ for (caseNode : caseNodes) {
+ if (caseNode !== null && caseNode.isAugmenting()) {
+ val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
+ val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
+ caseTypeBuilder.addImplementsType(refChoiceType);
+
+ val Set<DataSchemaNode> childNodes = caseNode.childNodes;
+ if (childNodes !== null) {
+ resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);
+ }
+ generatedTypes.add(caseTypeBuilder.toInstance());
+ }
+ }
+
+ return generatedTypes;
+ }
+
+ /**
+ * Converts <code>leaf</code> to the getter method which is added to
+ * <code>typeBuilder</code>.
+ *
+ * @param typeBuilder
+ * generated type builder to which is added getter method as
+ * <code>leaf</code> mapping
+ * @param leaf
+ * leaf schema node which is mapped as getter method which is
+ * added to <code>typeBuilder</code>
+ * @return boolean value
+ * <ul>
+ * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
+ * null</li>
+ * <li>true - in other cases</li>
+ * </ul>
+ */
+ private def boolean resolveLeafSchemaNodeAsMethod( GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
+ if ((leaf !== null) && (typeBuilder !== null)) {
+ val leafName = leaf.QName.localName;
+ var String leafDesc = leaf.description;
+ if (leafDesc === null) {
+ leafDesc = "";
+ }
+
+ val parentModule = findParentModule(schemaContext, leaf);
+ if (leafName !== null && !leaf.isAddedByUses()) {
+ val TypeDefinition<?> typeDef = leaf.type;
+
+ var Type returnType = null;
+ if (typeDef instanceof EnumTypeDefinition) {
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
+ val enumTypeDef = enumTypeDefFromExtendedType(typeDef);
+ val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName,
+ typeBuilder);
+
+ if (enumBuilder !== null) {
+ returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
+ }
+ (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
+ } else if (typeDef instanceof UnionType) {
+ val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
+ if (genTOBuilder !== null) {
+ returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
+ }
+ } else if (typeDef instanceof BitsTypeDefinition) {
+ val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
+ if (genTOBuilder !== null) {
+ returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
+ }
+ } else {
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
+ }
+ if (returnType !== null) {
+ constructGetter(typeBuilder, leafName, leafDesc, returnType);
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Converts <code>leaf</code> schema node to property of generated TO
+ * builder.
+ *
+ * @param toBuilder
+ * generated TO builder to which is <code>leaf</code> added as
+ * property
+ * @param leaf
+ * leaf schema node which is added to <code>toBuilder</code> as
+ * property
+ * @param isReadOnly
+ * boolean value which says if leaf property is|isn't read only
+ * @return boolean value
+ * <ul>
+ * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
+ * name equals null or if leaf is added by <i>uses</i>.</li>
+ * <li>true - other cases</li>
+ * </ul>
+ */
+ private def boolean resolveLeafSchemaNodeAsProperty( GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
+ boolean isReadOnly) {
+ if ((leaf !== null) && (toBuilder !== null)) {
+ val leafName = leaf.QName.localName;
+ var String leafDesc = leaf.description;
+ if (leafDesc === null) {
+ leafDesc = "";
+ }
+
+ if (leafName !== null && !leaf.isAddedByUses()) {
+ val TypeDefinition<?> typeDef = leaf.type;
+
+ // TODO: properly resolve enum types
+ val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
+
+ if (returnType !== null) {
+ val propBuilder = toBuilder.addProperty(parseToClassName(leafName));
+
+ propBuilder.setReadOnly(isReadOnly);
+ propBuilder.setReturnType(returnType);
+ propBuilder.setComment(leafDesc);
+
+ toBuilder.addEqualsIdentity(propBuilder);
+ toBuilder.addHashIdentity(propBuilder);
+ toBuilder.addToStringProperty(propBuilder);
+
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Converts <code>node</code> leaf list schema node to getter method of
+ * <code>typeBuilder</code>.
+ *
+ * @param typeBuilder
+ * generated type builder to which is <code>node</code> added as
+ * getter method
+ * @param node
+ * leaf list schema node which is added to
+ * <code>typeBuilder</code> as getter method
+ * @return boolean value
+ * <ul>
+ * <li>true - if <code>node</code>, <code>typeBuilder</code>,
+ * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
+ * <li>false - other cases</li>
+ * </ul>
+ */
+ private def boolean resolveLeafListSchemaNode( GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
+ if ((node !== null) && (typeBuilder !== null)) {
+ val nodeName = node.QName.localName;
+ var String nodeDesc = node.description;
+ if (nodeDesc === null) {
+ nodeDesc = "";
+ }
+
+ if (nodeName !== null && !node.isAddedByUses()) {
+ val TypeDefinition<?> type = node.type;
+ val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));
+
+ constructGetter(typeBuilder, nodeName, nodeDesc, listType);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Creates a getter method for a container node.
+ *
+ * Firstly generated type builder for container is created or found in
+ * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
+ * in the builder is created as concatenation of module package name and
+ * names of all parent nodes. In the end the getter method for container is
+ * added to <code>typeBuilder</code> and return type is set to container
+ * type builder.
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param typeBuilder
+ * generated type builder to which is <code>containerNode</code>
+ * added as getter method
+ * @param containerNode
+ * container schema node which is mapped as getter method to
+ * <code>typeBuilder</code>
+ * @return boolean value
+ * <ul>
+ * <li>false - if <code>containerNode</code>,
+ * <code>typeBuilder</code>, container node name equal null or
+ * <code>containerNode</code> is added by uses</li>
+ * <li>true - other cases</li>
+ * </ul>
+ */
+ private def boolean resolveContainerSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,
+ ContainerSchemaNode containerNode) {
+ if ((containerNode !== null) && (typeBuilder !== null)) {
+ val nodeName = containerNode.QName.localName;
+
+ if (nodeName !== null && !containerNode.isAddedByUses()) {
+ val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
+
+ val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);
+ constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);
+
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Creates a getter method for a list node.
+ *
+ * Firstly generated type builder for list is created or found in
+ * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
+ * in the builder is created as concatenation of module package name and
+ * names of all parent nodes. In the end the getter method for list is added
+ * to <code>typeBuilder</code> and return type is set to list type builder.
+ *
+ * @param basePackageName
+ * string with the module package name
+ * @param typeBuilder
+ * generated type builder to which is <code></code> added as
+ * getter method
+ * @param listNode
+ * list schema node which is mapped as getter method to
+ * <code>typeBuilder</code>
+ * @return boolean value
+ * <ul>
+ * <li>false - if <code>listNode</code>, <code>typeBuilder</code>,
+ * list node name equal null or <code>listNode</code> is added by
+ * uses</li>
+ * <li>true - other cases</li>
+ * </ul>
+ */
+ private def boolean resolveListSchemaNode( String basePackageName, GeneratedTypeBuilder typeBuilder,
+ ListSchemaNode listNode) {
+ if ((listNode !== null) && (typeBuilder !== null)) {
+ val listName = listNode.QName.localName;
+
+ if (listName !== null && !listNode.isAddedByUses()) {
+ val packageName = packageNameForGeneratedType(basePackageName, listNode.path);
+ val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);
+ constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Instantiates generated type builder with <code>packageName</code> and
+ * <code>schemaNode</code>.
+ *
+ * The new builder always implements
+ * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
+ * If <code>schemaNode</code> is instance of GroupingDefinition it also
+ * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
+ * Augmentable}.<br />
+ * If <code>schemaNode</code> is instance of
+ * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
+ * DataNodeContainer} it can also implement nodes which are specified in
+ * <i>uses</i>.
+ *
+ * @param packageName
+ * string with the name of the package to which
+ * <code>schemaNode</code> belongs.
+ * @param schemaNode
+ * schema node for which is created generated type builder
+ * @return generated type builder <code>schemaNode</code>
+ */
+ private def GeneratedTypeBuilder addDefaultInterfaceDefinition( String packageName, SchemaNode schemaNode) {
+ val builder = addRawInterfaceDefinition(packageName, schemaNode, "");
+ builder.addImplementsType(DATA_OBJECT);
+ if (!(schemaNode instanceof GroupingDefinition)) {
+ builder.addImplementsType(augmentable(builder));
+ }
+
+ if (schemaNode instanceof DataNodeContainer) {
+ addImplementedInterfaceFromUses( schemaNode as DataNodeContainer, builder);
+ }
+
+ return builder;
+ }
+
+ /**
+ * Wraps the calling of the same overloaded method.
+ *
+ * @param packageName
+ * string with the package name to which returning generated type
+ * builder belongs
+ * @param schemaNode
+ * schema node which provide data about the schema node name
+ * @return generated type builder for <code>schemaNode</code>
+ */
+ private def GeneratedTypeBuilder addRawInterfaceDefinition( String packageName, SchemaNode schemaNode) {
+ return addRawInterfaceDefinition(packageName, schemaNode, "");
+ }
+
+ /**
+ * Returns reference to generated type builder for specified
+ * <code>schemaNode</code> with <code>packageName</code>.
+ *
+ * Firstly the generated type builder is searched in
+ * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
+ * found it is created and added to <code>genTypeBuilders</code>.
+ *
+ * @param packageName
+ * string with the package name to which returning generated type
+ * builder belongs
+ * @param schemaNode
+ * schema node which provide data about the schema node name
+ * @return generated type builder for <code>schemaNode</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>schemaNode</code> equals null</li>
+ * <li>if <code>packageName</code> equals null</li>
+ * <li>if Q name of schema node is null</li>
+ * <li>if schema node name is nul</li>
+ * </ul>
+ *
+ */
+ private def GeneratedTypeBuilder addRawInterfaceDefinition( String packageName, SchemaNode schemaNode,
+ String prefix) {
+ checkArgument(schemaNode !== null,"Data Schema Node cannot be NULL.");
+ checkArgument(packageName !== null,"Package Name for Generated Type cannot be NULL.");
+ checkArgument(schemaNode.QName !== null,"QName for Data Schema Node cannot be NULL.");
+ val schemaNodeName = schemaNode.QName.localName;
+ checkArgument(schemaNodeName !== null,"Local Name of QName for Data Schema Node cannot be NULL.");
+
+ var String genTypeName;
+ if (prefix === null) {
+ genTypeName = parseToClassName(schemaNodeName);
+ } else {
+ genTypeName = prefix + parseToClassName(schemaNodeName);
+ }
+ //FIXME: Validation of name conflict
+ val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
+ yangToJavaMapping.put(schemaNode.path,newType);
+ if (!genTypeBuilders.containsKey(packageName)) {
+ val Map<String, GeneratedTypeBuilder> builders = new HashMap();
+ builders.put(genTypeName, newType);
+ genTypeBuilders.put(packageName, builders);
+ } else {
+ val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
+ if (!builders.containsKey(genTypeName)) {
+ builders.put(genTypeName, newType);
+ }
+ }
+ return newType;
+ }
+
+ /**
+ * Creates the name of the getter method from <code>methodName</code>.
+ *
+ * @param methodName
+ * string with the name of the getter method
+ * @return string with the name of the getter method for
+ * <code>methodName</code> in JAVA method format
+ */
+ private def String getterMethodName( String methodName,Type returnType) {
+ val method = new StringBuilder();
+ if(BOOLEAN.equals(returnType)) {
+ method.append("is");
+ } else {
+ method.append("get");
+ }
+ method.append(parseToClassName(methodName));
+ return method.toString();
+ }
+
+ /**
+ * Created a method signature builder as part of
+ * <code>interfaceBuilder</code>.
+ *
+ * The method signature builder is created for the getter method of
+ * <code>schemaNodeName</code>. Also <code>comment</code> and
+ * <code>returnType</code> information are added to the builder.
+ *
+ * @param interfaceBuilder
+ * generated type builder for which the getter method should be
+ * created
+ * @param schemaNodeName
+ * string with schema node name. The name will be the part of the
+ * getter method name.
+ * @param comment
+ * string with comment for the getter method
+ * @param returnType
+ * type which represents the return type of the getter method
+ * @return method signature builder which represents the getter method of
+ * <code>interfaceBuilder</code>
+ */
+ private def MethodSignatureBuilder constructGetter( GeneratedTypeBuilder interfaceBuilder,
+ String schemaNodeName, String comment, Type returnType) {
+
+ val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName,returnType));
+
+ getMethod.setComment(comment);
+ getMethod.setReturnType(returnType);
+
+ return getMethod;
+ }
+
+ private def listToGenType( String basePackageName, ListSchemaNode list) {
+ checkArgument(basePackageName !== null,"Package Name for Generated Type cannot be NULL.");
+ checkArgument(list !== null,"List Schema Node cannot be NULL.");
+
+ val packageName = packageNameForGeneratedType(basePackageName, list.path);
+ // val typeBuilder =
+ // resolveListTypeBuilder(packageName, list);
+ val typeBuilder = addDefaultInterfaceDefinition(packageName, list);
+
+ val List<String> listKeys = listKeys(list);
+ val genTOBuilder = resolveListKeyTOBuilder(packageName, list);
+
+ if (genTOBuilder !== null) {
+ val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);
+ val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
+ genTOBuilder.addImplementsType(identifierMarker);
+ typeBuilder.addImplementsType(identifiableMarker);
+ }
+ val schemaNodes = list.childNodes;
+
+ for (schemaNode : schemaNodes) {
+ if (!schemaNode.isAugmenting()) {
+ addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);
+ }
+ }
+ return typeBuildersToGenTypes(typeBuilder, genTOBuilder);
+ }
+
+ /**
+ * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
+ * or to <code>genTOBuilder</code> as property.
+ *
+ * @param basePackageName
+ * string contains the module package name
+ * @param schemaNode
+ * data schema node which should be added as getter method to
+ * <code>typeBuilder</code> or as a property to
+ * <code>genTOBuilder</code> if is part of the list key
+ * @param typeBuilder
+ * generated type builder for the list schema node
+ * @param genTOBuilder
+ * generated TO builder for the list keys
+ * @param listKeys
+ * list of string which contains names of the list keys
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>schemaNode</code> equals null</li>
+ * <li>if <code>typeBuilder</code> equals null</li>
+ * </ul>
+ */
+ private def void addSchemaNodeToListBuilders( String basePackageName, DataSchemaNode schemaNode,
+ GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {
+ checkArgument(schemaNode !== null,"Data Schema Node cannot be NULL.");
+
+ checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");
+
+ if (schemaNode instanceof LeafSchemaNode) {
+ val leaf = schemaNode as LeafSchemaNode;
+ val leafName = leaf.QName.localName;
+ if (!listKeys.contains(leafName)) {
+ resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
+ } else {
+ resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
+ }
+ } else if (schemaNode instanceof LeafListSchemaNode) {
+ resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
+ } else if (schemaNode instanceof ContainerSchemaNode) {
+ resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);
+ } else if (schemaNode instanceof ListSchemaNode) {
+ resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);
+ }
+ }
+
+ private def typeBuildersToGenTypes( GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
+ val List<Type> genTypes = new ArrayList();
+ checkArgument(typeBuilder !== null,"Generated Type Builder cannot be NULL.");
+
+ if (genTOBuilder !== null) {
+ val genTO = genTOBuilder.toInstance();
+ constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
+ genTypes.add(genTO);
+ }
+ genTypes.add(typeBuilder.toInstance());
+ return genTypes;
+ }
+
+ /**
+ * Selects the names of the list keys from <code>list</code> and returns
+ * them as the list of the strings
+ *
+ * @param list
+ * of string with names of the list keys
+ * @return list of string which represents names of the list keys. If the
+ * <code>list</code> contains no keys then the empty list is
+ * returned.
+ */
+ private def listKeys( ListSchemaNode list) {
+ val List<String> listKeys = new ArrayList();
+
+ if (list.keyDefinition !== null) {
+ val keyDefinitions = list.keyDefinition;
+ for (keyDefinition : keyDefinitions) {
+ listKeys.add(keyDefinition.localName);
+ }
+ }
+ return listKeys;
+ }
+
+ /**
+ * Generates for the <code>list</code> which contains any list keys special
+ * generated TO builder.
+ *
+ * @param packageName
+ * string with package name to which the list belongs
+ * @param list
+ * list schema node which is source of data about the list name
+ * @return generated TO builder which represents the keys of the
+ * <code>list</code> or null if <code>list</code> is null or list of
+ * key definitions is null or empty.
+ */
+ private def GeneratedTOBuilder resolveListKeyTOBuilder( String packageName, ListSchemaNode list) {
+ var GeneratedTOBuilder genTOBuilder = null;
+ if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
+ if (list !== null) {
+ val listName = list.QName.localName + "Key";
+ genTOBuilder = schemaNodeToTransferObjectBuilder(packageName, listName);
+ }
+ }
+ return genTOBuilder;
+
+ }
+
+ /**
+ * Builds generated TO builders for <code>typeDef</code> of type
+ * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
+ * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
+ * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
+ * enclosing transfer object.
+ *
+ * If more then one generated TO builder is created for enclosing then all
+ * of the generated TO builders are added to <code>typeBuilder</code> as
+ * enclosing transfer objects.
+ *
+ * @param typeDef
+ * type definition which can be of type <code>UnionType</code> or
+ * <code>BitsTypeDefinition</code>
+ * @param typeBuilder
+ * generated type builder to which is added generated TO created
+ * from <code>typeDef</code>
+ * @param leafName
+ * string with name for generated TO builder
+ * @return generated TO builder for <code>typeDef</code>
+ */
+ private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
+ String leafName, LeafSchemaNode leaf, Module parentModule) {
+ val classNameFromLeaf = parseToClassName(leafName);
+ val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
+ val packageName = typeBuilder.fullyQualifiedName;
+ if (typeDef instanceof UnionTypeDefinition) {
+ genTOBuilders.addAll((typeProvider as TypeProviderImpl).provideGeneratedTOBuildersForUnionTypeDef(
+ packageName, typeDef, classNameFromLeaf, leaf));
+ } else if (typeDef instanceof BitsTypeDefinition) {
+ genTOBuilders.add(((typeProvider as TypeProviderImpl) ).provideGeneratedTOBuilderForBitsTypeDefinition(
+ packageName, typeDef, classNameFromLeaf));
+ }
+ if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
+ for (genTOBuilder : genTOBuilders) {
+ typeBuilder.addEnclosingTransferObject(genTOBuilder);
+ }
+ return genTOBuilders.get(0);
+ }
+ return null;
+
+ }
+
+ /**
+ * Adds the implemented types to type builder.
+ *
+ * The method passes through the list of <i>uses</i> in
+ * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding
+ * generated type from {@link BindingGeneratorImpl#allGroupings
+ * allGroupings} which is added as <i>implements type</i> to
+ * <code>builder</code>
+ *
+ * @param dataNodeContainer
+ * element which contains the list of used YANG groupings
+ * @param builder
+ * builder to which are added implemented types according to
+ * <code>dataNodeContainer</code>
+ * @return generated type builder with all implemented types
+ */
+ private def addImplementedInterfaceFromUses( DataNodeContainer dataNodeContainer,
+ GeneratedTypeBuilder builder) {
+ for (usesNode : dataNodeContainer.uses) {
+ if (usesNode.groupingPath !== null) {
+ val genType = allGroupings.get(usesNode.groupingPath);
+ if (genType === null) {
+ throw new IllegalStateException("Grouping " + usesNode.groupingPath + "is not resolved for "
+ + builder.name);
+ }
+ builder.addImplementsType(genType);
+ }
+ }
+ return builder;
+ }
+}
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.sal.java.api.generator;\r
-\r
-import static org.opendaylight.yangtools.sal.java.api.generator.Constants.COMMA;\r
-\r
-import java.util.ArrayList;\r
-import java.util.LinkedHashMap;\r
-import java.util.List;\r
-import java.util.Map;\r
-\r
-import org.opendaylight.yangtools.binding.generator.util.TypeConstants;\r
-import org.opendaylight.yangtools.binding.generator.util.Types;\r
-import org.opendaylight.yangtools.sal.binding.model.api.Constant;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;\r
-import org.opendaylight.yangtools.sal.binding.model.api.MethodSignature;\r
-import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;\r
-import org.opendaylight.yangtools.sal.binding.model.api.Type;\r
-import org.opendaylight.yangtools.sal.binding.model.api.WildcardType;\r
-\r
-public final class GeneratorUtil {\r
-\r
- /**\r
- * It doesn't have the sense to create the instances of this class.\r
- */\r
- private GeneratorUtil() {\r
- }\r
-\r
- /**\r
- * Returns the map of imports. The map maps the type name to the package\r
- * name. To the map are added packages for <code>genType</code> and for all\r
- * enclosed types, constants, methods (parameter types, return values),\r
- * implemented types.\r
- * \r
- * @param genType\r
- * generated type for which the map of the imports is created\r
- * @return map of the necessary imports\r
- * @throws IllegalArgumentException\r
- * if <code>genType</code> equals <code>null</code>\r
- */\r
- public static Map<String, String> createImports(GeneratedType genType) {\r
- if (genType == null) {\r
- throw new IllegalArgumentException("Generated Type cannot be NULL!");\r
- }\r
- final Map<String, String> imports = new LinkedHashMap<>();\r
-\r
- List<GeneratedType> childGeneratedTypes = genType.getEnclosedTypes();\r
- if (!childGeneratedTypes.isEmpty()) {\r
- for (GeneratedType genTypeChild : childGeneratedTypes) {\r
- imports.putAll(createImports(genTypeChild));\r
- }\r
- }\r
-\r
- final List<Constant> constants = genType.getConstantDefinitions();\r
- final List<MethodSignature> methods = genType.getMethodDefinitions();\r
- final List<Type> impl = genType.getImplements();\r
-\r
- // IMPLEMENTATIONS\r
- if (impl != null) {\r
- for (final Type type : impl) {\r
- putTypeIntoImports(genType, type, imports);\r
- }\r
- }\r
-\r
- // CONSTANTS\r
- if (constants != null) {\r
- for (final Constant constant : constants) {\r
- final Type constantType = constant.getType();\r
- putTypeIntoImports(genType, constantType, imports);\r
- }\r
- }\r
-\r
- // REGULAR EXPRESSION\r
- if (genType instanceof GeneratedTransferObject) {\r
- if (isConstantInTO(TypeConstants.PATTERN_CONSTANT_NAME, (GeneratedTransferObject) genType)) {\r
- putTypeIntoImports(genType, Types.typeForClass(java.util.regex.Pattern.class), imports);\r
- putTypeIntoImports(genType, Types.typeForClass(java.util.Arrays.class), imports);\r
- putTypeIntoImports(genType, Types.typeForClass(java.util.ArrayList.class), imports);\r
- }\r
- }\r
-\r
- // METHODS\r
- if (methods != null) {\r
- for (final MethodSignature method : methods) {\r
- final Type methodReturnType = method.getReturnType();\r
- putTypeIntoImports(genType, methodReturnType, imports);\r
- for (final MethodSignature.Parameter methodParam : method.getParameters()) {\r
- putTypeIntoImports(genType, methodParam.getType(), imports);\r
- }\r
- }\r
- }\r
-\r
- // PROPERTIES\r
- if (genType instanceof GeneratedTransferObject) {\r
- final GeneratedTransferObject genTO = (GeneratedTransferObject) genType;\r
- final List<GeneratedProperty> properties = genTO.getProperties();\r
- if (properties != null) {\r
- for (GeneratedProperty property : properties) {\r
- final Type propertyType = property.getReturnType();\r
- putTypeIntoImports(genType, propertyType, imports);\r
- }\r
- }\r
- }\r
-\r
- return imports;\r
- }\r
-\r
- /**\r
- * Evaluates if it is necessary to add the package name for\r
- * <code>type</code> to the map of imports for <code>parentGenType</code>.\r
- * If it is so the package name is saved to the map <code>imports</code>.\r
- * \r
- * @param parentGenType\r
- * generated type for which is the map of the necessary imports\r
- * built\r
- * @param type\r
- * JAVA <code>Type</code> for which is the necessary of the\r
- * package import evaluated\r
- * @param imports\r
- * map of the imports for <code>parentGenType</code>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the <code>parentGenType</code> equals\r
- * <code>null</code></li>\r
- * <li>if the name of <code>parentGenType</code> equals\r
- * <code>null</code></li>\r
- * <li>if the name of the package of <code>parentGenType</code>\r
- * equals <code>null</code></li>\r
- * <li>if the <code>type</code> equals <code>null</code></li>\r
- * <li>if the name of <code>type</code> equals <code>null</code>\r
- * </li>\r
- * <li>if the name of the package of <code>type</code> equals\r
- * <code>null</code></li>\r
- * </ul>\r
- */\r
- public static void putTypeIntoImports(final GeneratedType parentGenType, final Type type,\r
- final Map<String, String> imports) {\r
- if (parentGenType == null) {\r
- throw new IllegalArgumentException("Parent Generated Type parameter MUST be specified and cannot be "\r
- + "NULL!");\r
- }\r
- if (parentGenType.getName() == null) {\r
- throw new IllegalArgumentException("Parent Generated Type name cannot be NULL!");\r
- }\r
- if (parentGenType.getPackageName() == null) {\r
- throw new IllegalArgumentException("Parent Generated Type cannot have Package Name referenced as NULL!");\r
- }\r
- if (type == null) {\r
- throw new IllegalArgumentException("Type parameter MUST be specified and cannot be NULL!");\r
- }\r
- if (type.getName() == null) {\r
- throw new IllegalArgumentException("Type name cannot be NULL!");\r
- }\r
- if (type.getPackageName() == null) {\r
- throw new IllegalArgumentException("Type cannot have Package Name referenced as NULL!");\r
- }\r
-\r
- final String typeName = type.getName();\r
- final String typePackageName = type.getPackageName();\r
- final String parentTypeName = parentGenType.getName();\r
- final String parentTypePackageName = parentGenType.getPackageName();\r
- if (typeName.equals(parentTypeName) || typePackageName.startsWith("java.lang")\r
- || typePackageName.equals(parentTypePackageName) || typePackageName.isEmpty()) {\r
- return;\r
- }\r
- if (!imports.containsKey(typeName)) {\r
- imports.put(typeName, typePackageName);\r
- }\r
- if (type instanceof ParameterizedType) {\r
- final ParameterizedType paramType = (ParameterizedType) type;\r
- final Type[] params = paramType.getActualTypeArguments();\r
- for (Type param : params) {\r
- putTypeIntoImports(parentGenType, param, imports);\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Checks if the constant with the name <code>constName</code> is in the\r
- * list of the constant definition for <code>genTO</code>.\r
- * \r
- * @param constName\r
- * string with the name of constant which is sought\r
- * @param genTO\r
- * generated transfer object in which is <code>constName</code>\r
- * sought\r
- * @return boolean value\r
- * <ul>\r
- * <li>true - if <code>constName</code> is in the list of the\r
- * constant definition for <code>genTO</code></li>\r
- * <li>false - in other cases</li>\r
- * </ul>\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if <code>constName</code> equals <code>null</code></li>\r
- * <li>if <code>genTO</code> equals <code>null</code></li>\r
- * </ul>\r
- */\r
- public static boolean isConstantInTO(String constName, GeneratedTransferObject genTO) {\r
- if (constName == null || genTO == null)\r
- throw new IllegalArgumentException();\r
- List<Constant> consts = genTO.getConstantDefinitions();\r
- for (Constant cons : consts) {\r
- if (cons.getName().equals(constName)) {\r
- return true;\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- /**\r
- * Creates the map which maps the type name to package name and contains\r
- * only package names for enclosed types of <code>genType</code> and\r
- * recursivelly their enclosed types.\r
- * \r
- * @param genType\r
- * JAVA <code>Type</code> for which is the map created\r
- * @return map of the package names for all the enclosed types and\r
- * recursivelly their enclosed types\r
- */\r
- public static Map<String, String> createChildImports(GeneratedType genType) {\r
- Map<String, String> childImports = new LinkedHashMap<>();\r
- List<GeneratedType> childGeneratedTypes = genType.getEnclosedTypes();\r
- if (!childGeneratedTypes.isEmpty()) {\r
- for (GeneratedType genTypeChild : childGeneratedTypes) {\r
- createChildImports(genTypeChild);\r
- childImports.put(genTypeChild.getName(), genTypeChild.getPackageName());\r
- }\r
- }\r
- return childImports;\r
- }\r
-\r
- /**\r
- * Builds the string which contains either the full path to the type\r
- * (package name with type) or only type name if the package is among\r
- * <code>imports</code>.\r
- * \r
- * @param parentGenType\r
- * generated type which contains <code>type</code>\r
- * @param type\r
- * JAVA <code>Type</code> for which is the string with type info\r
- * generated\r
- * @param imports\r
- * map of necessary imports for <code>parentGenType</code>\r
- * @return string with type name for <code>type</code> in the full format or\r
- * in the short format\r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>if the <code>type</code> equals <code>null</code></li>\r
- * <li>if the name of the <code>type</code> equals\r
- * <code>null</code></li>\r
- * <li>if the name of the package of the <code>type</code>\r
- * equals <code>null</code></li>\r
- * <li>if the <code>imports</code> equals <code>null</code></li>\r
- * </ul>\r
- */\r
- public static String getExplicitType(final GeneratedType parentGenType, final Type type,\r
- final Map<String, String> imports) {\r
- if (type == null) {\r
- throw new IllegalArgumentException("Type parameter MUST be specified and cannot be NULL!");\r
- }\r
- if (type.getName() == null) {\r
- throw new IllegalArgumentException("Type name cannot be NULL!");\r
- }\r
- if (type.getPackageName() == null) {\r
- throw new IllegalArgumentException("Type cannot have Package Name referenced as NULL!");\r
- }\r
- if (imports == null) {\r
- throw new IllegalArgumentException("Imports Map cannot be NULL!");\r
- }\r
-\r
- final String typePackageName = type.getPackageName();\r
- final String typeName = type.getName();\r
- final String importedPackageName = imports.get(typeName);\r
- if (typePackageName.equals(importedPackageName) || typePackageName.equals(parentGenType.getPackageName())) {\r
- final StringBuilder builder = new StringBuilder(type.getName());\r
- if (type instanceof ParameterizedType) {\r
- final ParameterizedType pType = (ParameterizedType) type;\r
- final Type[] pTypes = pType.getActualTypeArguments();\r
- builder.append("<");\r
- builder.append(getParameters(parentGenType, pTypes, imports));\r
- builder.append(">");\r
- }\r
- if (builder.toString().equals("Void")) {\r
- return "void";\r
- }\r
- return builder.toString();\r
- } else {\r
- final StringBuilder builder = new StringBuilder();\r
- if (typePackageName.startsWith("java.lang")) {\r
- builder.append(type.getName());\r
- } else {\r
- if (!typePackageName.isEmpty()) {\r
- builder.append(typePackageName + Constants.DOT + type.getName());\r
- } else {\r
- builder.append(type.getName());\r
- }\r
- }\r
- if (type.equals(Types.voidType())) {\r
- return "void";\r
- }\r
- if (type instanceof ParameterizedType) {\r
- final ParameterizedType pType = (ParameterizedType) type;\r
- final Type[] pTypes = pType.getActualTypeArguments();\r
- builder.append("<");\r
- builder.append(getParameters(parentGenType, pTypes, imports));\r
- builder.append(">");\r
- }\r
- return builder.toString();\r
- }\r
- }\r
-\r
- /**\r
- * Generates the string with all actual type parameters from\r
- * <code>pTypes</code>\r
- * \r
- * @param parentGenType\r
- * generated type for which is the JAVA code generated\r
- * @param pTypes\r
- * array of <code>Type</code> instances = actual type parameters\r
- * @param availableImports\r
- * map of imports for <code>parentGenType</code>\r
- * @return string with all actual type parameters from <code>pTypes</code>\r
- */\r
- private static String getParameters(final GeneratedType parentGenType, final Type[] pTypes,\r
- Map<String, String> availableImports) {\r
- final StringBuilder builder = new StringBuilder();\r
- for (int i = 0; i < pTypes.length; i++) {\r
- final Type t = pTypes[i];\r
-\r
- String separator = COMMA;\r
- if (i == (pTypes.length - 1)) {\r
- separator = "";\r
- }\r
-\r
- String wildcardParam = "";\r
- if (t.equals(Types.voidType())) {\r
- builder.append("java.lang.Void" + separator);\r
- continue;\r
- } else {\r
-\r
- if (t instanceof WildcardType) {\r
- wildcardParam = "? extends ";\r
- }\r
-\r
- builder.append(wildcardParam + getExplicitType(parentGenType, t, availableImports) + separator);\r
- }\r
- }\r
- return builder.toString();\r
- }\r
-\r
- /**\r
- * Returns the reference to highest (top parent) Generated Transfer Object.\r
- * \r
- * @param childTransportObject\r
- * is generated transfer object which can be extended by other\r
- * generated transfer object\r
- * @return in first case that <code>childTransportObject</code> isn't\r
- * extended then <code>childTransportObject</code> is returned. In\r
- * second case the method is recursive called until first case.\r
- * @throws IllegalArgumentException\r
- * if <code>childTransportObject</code> equals <code>null</code>\r
- */\r
- public static GeneratedTransferObject getTopParrentTransportObject(GeneratedTransferObject childTransportObject) {\r
- if (childTransportObject == null) {\r
- throw new IllegalArgumentException("Parameter childTransportObject can't be null.");\r
- }\r
- if (childTransportObject.getSuperType() == null) {\r
- return childTransportObject;\r
- } else {\r
- return getTopParrentTransportObject(childTransportObject.getSuperType());\r
- }\r
- }\r
-\r
- /**\r
- * Selects from input list of properties only those which have read only\r
- * attribute set to true.\r
- * \r
- * @param properties\r
- * list of properties of generated transfer object\r
- * @return subset of <code>properties</code> which have read only attribute\r
- * set to true\r
- */\r
- public static List<GeneratedProperty> resolveReadOnlyPropertiesFromTO(List<GeneratedProperty> properties) {\r
- List<GeneratedProperty> readOnlyProperties = new ArrayList<GeneratedProperty>();\r
- if (properties != null) {\r
- for (final GeneratedProperty property : properties) {\r
- if (property.isReadOnly()) {\r
- readOnlyProperties.add(property);\r
- }\r
- }\r
- }\r
- return readOnlyProperties;\r
- }\r
-\r
- /**\r
- * Returns the list of the read only properties of all extending generated\r
- * transfer object from <code>genTO</code> to highest parent generated\r
- * transfer object\r
- * \r
- * @param genTO\r
- * generated transfer object for which is the list of read only\r
- * properties generated\r
- * @return list of all read only properties from actual to highest parent\r
- * generated transfer object. In case when extension exists the\r
- * method is recursive called.\r
- */\r
- public static List<GeneratedProperty> getPropertiesOfAllParents(GeneratedTransferObject genTO) {\r
- List<GeneratedProperty> propertiesOfAllParents = new ArrayList<GeneratedProperty>();\r
- if (genTO.getSuperType() != null) {\r
- final List<GeneratedProperty> allPropertiesOfTO = genTO.getSuperType().getProperties();\r
- List<GeneratedProperty> readOnlyPropertiesOfTO = resolveReadOnlyPropertiesFromTO(allPropertiesOfTO);\r
- propertiesOfAllParents.addAll(readOnlyPropertiesOfTO);\r
- propertiesOfAllParents.addAll(getPropertiesOfAllParents(genTO.getSuperType()));\r
- }\r
- return propertiesOfAllParents;\r
- }\r
-\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.sal.java.api.generator;
+
+import static org.opendaylight.yangtools.sal.java.api.generator.Constants.COMMA;
+
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.opendaylight.yangtools.binding.generator.util.TypeConstants;
+import org.opendaylight.yangtools.binding.generator.util.Types;
+import org.opendaylight.yangtools.sal.binding.model.api.Constant;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
+import org.opendaylight.yangtools.sal.binding.model.api.MethodSignature;
+import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
+import org.opendaylight.yangtools.sal.binding.model.api.Type;
+import org.opendaylight.yangtools.sal.binding.model.api.WildcardType;
+import com.google.common.base.Preconditions;
+
+public final class GeneratorUtil {
+
+ /**
+ * It doesn't have the sense to create the instances of this class.
+ */
+ private GeneratorUtil() {
+ }
+
+ /**
+ * Returns the map of imports. The map maps the type name to the package
+ * name. To the map are added packages for <code>genType</code> and for all
+ * enclosed types, constants, methods (parameter types, return values),
+ * implemented types.
+ *
+ * @param genType
+ * generated type for which the map of the imports is created
+ * @return map of the necessary imports
+ * @throws IllegalArgumentException
+ * if <code>genType</code> equals <code>null</code>
+ */
+ public static Map<String, String> createImports(GeneratedType genType) {
+ if (genType == null) {
+ throw new IllegalArgumentException("Generated Type cannot be NULL!");
+ }
+ final Map<String, String> imports = new LinkedHashMap<>();
+
+ List<GeneratedType> childGeneratedTypes = genType.getEnclosedTypes();
+ if (!childGeneratedTypes.isEmpty()) {
+ for (GeneratedType genTypeChild : childGeneratedTypes) {
+ imports.putAll(createImports(genTypeChild));
+ }
+ }
+
+ final List<Constant> constants = genType.getConstantDefinitions();
+ final List<MethodSignature> methods = genType.getMethodDefinitions();
+ final List<Type> impl = genType.getImplements();
+
+ // IMPLEMENTATIONS
+ if (impl != null) {
+ for (final Type type : impl) {
+ putTypeIntoImports(genType, type, imports);
+ }
+ }
+
+ // CONSTANTS
+ if (constants != null) {
+ for (final Constant constant : constants) {
+ final Type constantType = constant.getType();
+ putTypeIntoImports(genType, constantType, imports);
+ }
+ }
+
+ // REGULAR EXPRESSION
+ if (genType instanceof GeneratedTransferObject
+ && isConstantInTO(TypeConstants.PATTERN_CONSTANT_NAME, (GeneratedTransferObject) genType)) {
+ putTypeIntoImports(genType, Types.typeForClass(java.util.regex.Pattern.class), imports);
+ putTypeIntoImports(genType, Types.typeForClass(java.util.Arrays.class), imports);
+ putTypeIntoImports(genType, Types.typeForClass(java.util.ArrayList.class), imports);
+ }
+
+ // METHODS
+ if (methods != null) {
+ for (final MethodSignature method : methods) {
+ final Type methodReturnType = method.getReturnType();
+ putTypeIntoImports(genType, methodReturnType, imports);
+ for (final MethodSignature.Parameter methodParam : method.getParameters()) {
+ putTypeIntoImports(genType, methodParam.getType(), imports);
+ }
+ }
+ }
+
+ // PROPERTIES
+ if (genType instanceof GeneratedTransferObject) {
+ final GeneratedTransferObject genTO = (GeneratedTransferObject) genType;
+ final List<GeneratedProperty> properties = genTO.getProperties();
+ if (properties != null) {
+ for (GeneratedProperty property : properties) {
+ final Type propertyType = property.getReturnType();
+ putTypeIntoImports(genType, propertyType, imports);
+ }
+ }
+ }
+
+ return imports;
+ }
+
+ /**
+ * Evaluates if it is necessary to add the package name for
+ * <code>type</code> to the map of imports for <code>parentGenType</code>.
+ * If it is so the package name is saved to the map <code>imports</code>.
+ *
+ * @param parentGenType
+ * generated type for which is the map of the necessary imports
+ * built
+ * @param type
+ * JAVA <code>Type</code> for which is the necessary of the
+ * package import evaluated
+ * @param imports
+ * map of the imports for <code>parentGenType</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the <code>parentGenType</code> equals
+ * <code>null</code></li>
+ * <li>if the name of <code>parentGenType</code> equals
+ * <code>null</code></li>
+ * <li>if the name of the package of <code>parentGenType</code>
+ * equals <code>null</code></li>
+ * <li>if the <code>type</code> equals <code>null</code></li>
+ * <li>if the name of <code>type</code> equals <code>null</code>
+ * </li>
+ * <li>if the name of the package of <code>type</code> equals
+ * <code>null</code></li>
+ * </ul>
+ */
+ public static void putTypeIntoImports(final GeneratedType parentGenType, final Type type,
+ final Map<String, String> imports) {
+ Preconditions.checkArgument(parentGenType != null,
+ "Parent Generated Type parameter MUST be specified and cannot be " + "NULL!");
+ Preconditions.checkArgument(parentGenType.getName() != null, "Parent Generated Type name cannot be NULL!");
+ Preconditions.checkArgument(parentGenType.getPackageName() != null,
+ "Parent Generated Type cannot have Package Name referenced as NULL!");
+ Preconditions.checkArgument(type != null, "Type parameter MUST be specified and cannot be NULL!");
+
+ Preconditions.checkArgument(type.getName() != null, "Type name cannot be NULL!");
+ Preconditions.checkArgument(type.getPackageName() != null, "Type cannot have Package Name referenced as NULL!");
+
+ final String typeName = type.getName();
+ final String typePackageName = type.getPackageName();
+ final String parentTypeName = parentGenType.getName();
+ final String parentTypePackageName = parentGenType.getPackageName();
+ if (typeName.equals(parentTypeName) || typePackageName.startsWith("java.lang")
+ || typePackageName.equals(parentTypePackageName) || typePackageName.isEmpty()) {
+ return;
+ }
+ if (!imports.containsKey(typeName)) {
+ imports.put(typeName, typePackageName);
+ }
+ if (type instanceof ParameterizedType) {
+ final ParameterizedType paramType = (ParameterizedType) type;
+ final Type[] params = paramType.getActualTypeArguments();
+ for (Type param : params) {
+ putTypeIntoImports(parentGenType, param, imports);
+ }
+ }
+ }
+
+ /**
+ * Checks if the constant with the name <code>constName</code> is in the
+ * list of the constant definition for <code>genTO</code>.
+ *
+ * @param constName
+ * string with the name of constant which is sought
+ * @param genTO
+ * generated transfer object in which is <code>constName</code>
+ * sought
+ * @return boolean value
+ * <ul>
+ * <li>true - if <code>constName</code> is in the list of the
+ * constant definition for <code>genTO</code></li>
+ * <li>false - in other cases</li>
+ * </ul>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>constName</code> equals <code>null</code></li>
+ * <li>if <code>genTO</code> equals <code>null</code></li>
+ * </ul>
+ */
+ public static boolean isConstantInTO(String constName, GeneratedTransferObject genTO) {
+ if (constName == null || genTO == null)
+ throw new IllegalArgumentException();
+ List<Constant> consts = genTO.getConstantDefinitions();
+ for (Constant cons : consts) {
+ if (cons.getName().equals(constName)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Creates the map which maps the type name to package name and contains
+ * only package names for enclosed types of <code>genType</code> and
+ * recursivelly their enclosed types.
+ *
+ * @param genType
+ * JAVA <code>Type</code> for which is the map created
+ * @return map of the package names for all the enclosed types and
+ * recursivelly their enclosed types
+ */
+ public static Map<String, String> createChildImports(GeneratedType genType) {
+ Map<String, String> childImports = new LinkedHashMap<>();
+ List<GeneratedType> childGeneratedTypes = genType.getEnclosedTypes();
+ if (!childGeneratedTypes.isEmpty()) {
+ for (GeneratedType genTypeChild : childGeneratedTypes) {
+ createChildImports(genTypeChild);
+ childImports.put(genTypeChild.getName(), genTypeChild.getPackageName());
+ }
+ }
+ return childImports;
+ }
+
+ /**
+ * Builds the string which contains either the full path to the type
+ * (package name with type) or only type name if the package is among
+ * <code>imports</code>.
+ *
+ * @param parentGenType
+ * generated type which contains <code>type</code>
+ * @param type
+ * JAVA <code>Type</code> for which is the string with type info
+ * generated
+ * @param imports
+ * map of necessary imports for <code>parentGenType</code>
+ * @return string with type name for <code>type</code> in the full format or
+ * in the short format
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the <code>type</code> equals <code>null</code></li>
+ * <li>if the name of the <code>type</code> equals
+ * <code>null</code></li>
+ * <li>if the name of the package of the <code>type</code>
+ * equals <code>null</code></li>
+ * <li>if the <code>imports</code> equals <code>null</code></li>
+ * </ul>
+ */
+ public static String getExplicitType(final GeneratedType parentGenType, final Type type,
+ final Map<String, String> imports) {
+
+ Preconditions.checkArgument(type != null, "Type parameter MUST be specified and cannot be NULL!");
+ Preconditions.checkArgument(type.getName() != null, "Type name cannot be NULL!");
+ Preconditions.checkArgument(type.getPackageName() != null, "Type cannot have Package Name referenced as NULL!");
+ Preconditions.checkArgument(imports != null, "Imports Map cannot be NULL!");
+
+ final String typePackageName = type.getPackageName();
+ final String typeName = type.getName();
+ final String importedPackageName = imports.get(typeName);
+ final StringBuilder builder;
+ if (typePackageName.equals(importedPackageName) || typePackageName.equals(parentGenType.getPackageName())) {
+ builder = new StringBuilder(type.getName());
+ addActualTypeParameters(builder, type, parentGenType, imports);
+ if (builder.toString().equals("Void")) {
+ return "void";
+ }
+ } else {
+ builder = new StringBuilder();
+ if (typePackageName.startsWith("java.lang")) {
+ builder.append(type.getName());
+ } else {
+ if (!typePackageName.isEmpty()) {
+ builder.append(typePackageName + Constants.DOT + type.getName());
+ } else {
+ builder.append(type.getName());
+ }
+ }
+ if (type.equals(Types.voidType())) {
+ return "void";
+ }
+ addActualTypeParameters(builder, type, parentGenType, imports);
+ }
+ return builder.toString();
+
+ }
+
+ /**
+ * Adds actual type parameters from <code>type</code> to
+ * <code>builder</code> if <code>type</code> is
+ * <code>ParametrizedType</code>.
+ *
+ * @param builder
+ * string builder which contains type name
+ * @param type
+ * JAVA <code>Type</code> for which is the string with type info
+ * generated
+ * @param parentGenType
+ * generated type which contains <code>type</code>
+ * @param imports
+ * map of necessary imports for <code>parentGenType</code>
+ * @return if <code>type</code> is of the type <code>ParametrizedType</code> <br />
+ * <li>then <code>builder</code> + actual <code>type</code>
+ * parameters</li> <li>else only <code>builder</code></li>
+ */
+ private static StringBuilder addActualTypeParameters(StringBuilder builder, final Type type,
+ final GeneratedType parentGenType, final Map<String, String> imports) {
+ if (type instanceof ParameterizedType) {
+ final ParameterizedType pType = (ParameterizedType) type;
+ final Type[] pTypes = pType.getActualTypeArguments();
+ builder.append("<");
+ builder.append(getParameters(parentGenType, pTypes, imports));
+ builder.append(">");
+ }
+ return builder;
+ }
+
+ /**
+ * Generates the string with all actual type parameters from
+ * <code>pTypes</code>
+ *
+ * @param parentGenType
+ * generated type for which is the JAVA code generated
+ * @param pTypes
+ * array of <code>Type</code> instances = actual type parameters
+ * @param availableImports
+ * map of imports for <code>parentGenType</code>
+ * @return string with all actual type parameters from <code>pTypes</code>
+ */
+ private static String getParameters(final GeneratedType parentGenType, final Type[] pTypes,
+ Map<String, String> availableImports) {
+ final StringBuilder builder = new StringBuilder();
+ for (int i = 0; i < pTypes.length; i++) {
+ final Type t = pTypes[i];
+
+ String separator = COMMA;
+ if (i == (pTypes.length - 1)) {
+ separator = "";
+ }
+
+ String wildcardParam = "";
+ if (t.equals(Types.voidType())) {
+ builder.append("java.lang.Void" + separator);
+ continue;
+ } else {
+
+ if (t instanceof WildcardType) {
+ wildcardParam = "? extends ";
+ }
+
+ builder.append(wildcardParam + getExplicitType(parentGenType, t, availableImports) + separator);
+ }
+ }
+ return builder.toString();
+ }
+
+ /**
+ * Returns the reference to highest (top parent) Generated Transfer Object.
+ *
+ * @param childTransportObject
+ * is generated transfer object which can be extended by other
+ * generated transfer object
+ * @return in first case that <code>childTransportObject</code> isn't
+ * extended then <code>childTransportObject</code> is returned. In
+ * second case the method is recursive called until first case.
+ * @throws IllegalArgumentException
+ * if <code>childTransportObject</code> equals <code>null</code>
+ */
+ public static GeneratedTransferObject getTopParrentTransportObject(GeneratedTransferObject childTransportObject) {
+ if (childTransportObject == null) {
+ throw new IllegalArgumentException("Parameter childTransportObject can't be null.");
+ }
+ if (childTransportObject.getSuperType() == null) {
+ return childTransportObject;
+ } else {
+ return getTopParrentTransportObject(childTransportObject.getSuperType());
+ }
+ }
+
+ /**
+ * Selects from input list of properties only those which have read only
+ * attribute set to true.
+ *
+ * @param properties
+ * list of properties of generated transfer object
+ * @return subset of <code>properties</code> which have read only attribute
+ * set to true
+ */
+ public static List<GeneratedProperty> resolveReadOnlyPropertiesFromTO(List<GeneratedProperty> properties) {
+ List<GeneratedProperty> readOnlyProperties = new ArrayList<GeneratedProperty>();
+ if (properties != null) {
+ for (final GeneratedProperty property : properties) {
+ if (property.isReadOnly()) {
+ readOnlyProperties.add(property);
+ }
+ }
+ }
+ return readOnlyProperties;
+ }
+
+ /**
+ * Returns the list of the read only properties of all extending generated
+ * transfer object from <code>genTO</code> to highest parent generated
+ * transfer object
+ *
+ * @param genTO
+ * generated transfer object for which is the list of read only
+ * properties generated
+ * @return list of all read only properties from actual to highest parent
+ * generated transfer object. In case when extension exists the
+ * method is recursive called.
+ */
+ public static List<GeneratedProperty> getPropertiesOfAllParents(GeneratedTransferObject genTO) {
+ List<GeneratedProperty> propertiesOfAllParents = new ArrayList<GeneratedProperty>();
+ if (genTO.getSuperType() != null) {
+ final List<GeneratedProperty> allPropertiesOfTO = genTO.getSuperType().getProperties();
+ List<GeneratedProperty> readOnlyPropertiesOfTO = resolveReadOnlyPropertiesFromTO(allPropertiesOfTO);
+ propertiesOfAllParents.addAll(readOnlyPropertiesOfTO);
+ propertiesOfAllParents.addAll(getPropertiesOfAllParents(genTO.getSuperType()));
+ }
+ return propertiesOfAllParents;
+ }
+
+}
Code Review / yangtools.git / commitdiff