-/*\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.binding.generator.util.Types.BOOLEAN;\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.Comparator;\r
-import java.util.HashMap;\r
-import java.util.List;\r
-import java.util.Map;\r
-import java.util.Set;\r
-import java.util.concurrent.Future;\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.GeneratedTransferObject;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;\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.type.builder.EnumBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;\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.DataRoot;\r
-import org.opendaylight.yangtools.yang.binding.Identifiable;\r
-import org.opendaylight.yangtools.yang.binding.Identifier;\r
-import org.opendaylight.yangtools.yang.binding.RpcService;\r
-import org.opendaylight.yangtools.yang.common.QName;\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.NotificationDefinition;\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.UsesNode;\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
-\r
-import com.google.common.base.Preconditions;\r
-\r
-public final 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 TypeProvider typeProvider;\r
-\r
- /**\r
- * Holds reference to schema context to resolve data of augmented elemnt\r
- * when creating augmentation builder\r
- */\r
- private 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 final Map<SchemaPath, GeneratedType> allGroupings = new HashMap<SchemaPath, GeneratedType>();\r
-\r
- /**\r
- * Constant with the concrete name of namespace.\r
- */\r
- private final static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";\r
-\r
- /**\r
- * Constant with the concrete name of identifier.\r
- */\r
- private final static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";\r
-\r
- /**\r
- * Only parent constructor is invoked.\r
- */\r
- public BindingGeneratorImpl() {\r
- super();\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\r
- public List<Type> generateTypes(final SchemaContext context) {\r
- Preconditions.checkArgument(context != null,"Schema Context reference cannot be NULL.");\r
- Preconditions.checkState(context.getModules() != null,"Schema Context does not contain defined modules.");\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- schemaContext = context;\r
- typeProvider = new TypeProviderImpl(context);\r
- final Set<Module> modules = context.getModules();\r
- genTypeBuilders = new HashMap<>();\r
- for (final Module module : modules) {\r
-\r
- generatedTypes.addAll(allGroupingsToGenTypes(module));\r
-\r
- if (false == module.getChildNodes().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(allAugmentsToGenTypes(module));\r
- generatedTypes.addAll(allRPCMethodsToGenType(module));\r
- generatedTypes.addAll(allNotificationsToGenType(module));\r
- generatedTypes.addAll(allIdentitiesToGenTypes(module, context));\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\r
- public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {\r
- Preconditions.checkArgument(context != null,"Schema Context reference cannot be NULL.");\r
- Preconditions.checkState(context.getModules() != null,"Schema Context does not contain defined modules.");\r
- Preconditions.checkArgument(modules != null,"Sef of Modules cannot be NULL.");\r
-\r
- final List<Type> filteredGenTypes = new ArrayList<>();\r
- schemaContext = context;\r
- typeProvider = new TypeProviderImpl(context);\r
- final Set<Module> contextModules = context.getModules();\r
- genTypeBuilders = new HashMap<>();\r
- for (final Module contextModule : contextModules) {\r
- final List<Type> generatedTypes = new ArrayList<>();\r
-\r
- generatedTypes.addAll(allGroupingsToGenTypes(contextModule));\r
- if (false == contextModule.getChildNodes().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(allAugmentsToGenTypes(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
- 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 List<Type> allTypeDefinitionsToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
- Preconditions.checkArgument(module.getTypeDefinitions() != null,"Type Definitions for module " + module.getName() + " cannot be NULL.");\r
-\r
- final Set<TypeDefinition<?>> typeDefinitions = module.getTypeDefinitions();\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- for (final TypeDefinition<?> typedef : typeDefinitions) {\r
- if (typedef != null) {\r
- final Type type = ((TypeProviderImpl) typeProvider).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 List<Type> allContainersToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
-\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
-\r
- if (module.getChildNodes() == null) {\r
- throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.getName()\r
- + " cannot be NULL.");\r
- }\r
-\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- final DataNodeIterator it = new DataNodeIterator(module);\r
- final List<ContainerSchemaNode> schemaContainers = it.allContainers();\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- for (final ContainerSchemaNode 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 List<Type> allListsToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
-\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
-\r
- if (module.getChildNodes() == null) {\r
- throw new IllegalArgumentException("Reference to Set of Child Nodes in module " + module.getName()\r
- + " cannot be NULL.");\r
- }\r
-\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- final DataNodeIterator it = new DataNodeIterator(module);\r
- final List<ListSchemaNode> schemaLists = it.allLists();\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- if (schemaLists != null) {\r
- for (final ListSchemaNode 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 List<GeneratedType> allChoicesToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
-\r
- final DataNodeIterator it = new DataNodeIterator(module);\r
- final List<ChoiceNode> choiceNodes = it.allChoices();\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
-\r
- final List<GeneratedType> generatedTypes = new ArrayList<>();\r
- for (final ChoiceNode 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 List<Type> allAugmentsToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
- if (module.getChildNodes() == null) {\r
- throw new IllegalArgumentException("Reference to Set of Augmentation Definitions in module "\r
- + module.getName() + " cannot be NULL.");\r
- }\r
-\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- final List<AugmentationSchema> augmentations = resolveAugmentations(module);\r
- for (final AugmentationSchema 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 List<AugmentationSchema> resolveAugmentations(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
- Preconditions.checkState(module.getAugmentations() != null,"Augmentations Set cannot be NULL.");\r
-\r
- final Set<AugmentationSchema> augmentations = module.getAugmentations();\r
- final List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);\r
- Collections.sort(sortedAugmentations, new Comparator<AugmentationSchema>() {\r
-\r
- @Override\r
- public int compare(AugmentationSchema augSchema1, AugmentationSchema augSchema2) {\r
-\r
- if (augSchema1.getTargetPath().getPath().size() > augSchema2.getTargetPath().getPath().size()) {\r
- return 1;\r
- } else if (augSchema1.getTargetPath().getPath().size() < augSchema2.getTargetPath().getPath().size()) {\r
- return -1;\r
- }\r
- return 0;\r
-\r
- }\r
- });\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 finally\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 GeneratedType moduleToDataType(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
-\r
- final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");\r
- addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);\r
- moduleDataTypeBuilder.addImplementsType(Types.typeForClass(DataRoot.class));\r
-\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- if (moduleDataTypeBuilder != null) {\r
- final Set<DataSchemaNode> dataNodes = module.getChildNodes();\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 List<Type> allRPCMethodsToGenType(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
-\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
-\r
- if (module.getChildNodes() == null) {\r
- throw new IllegalArgumentException("Reference to Set of RPC Method Definitions in module "\r
- + module.getName() + " cannot be NULL.");\r
- }\r
-\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- final Set<RpcDefinition> rpcDefinitions = module.getRpcs();\r
-\r
- if (rpcDefinitions.isEmpty()) {\r
- return Collections.emptyList();\r
- }\r
-\r
- final List<Type> genRPCTypes = new ArrayList<>();\r
- final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");\r
- interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));\r
- final Type future = Types.typeForClass(Future.class);\r
- for (final RpcDefinition rpc : rpcDefinitions) {\r
- if (rpc != null) {\r
-\r
- String rpcName = parseToClassName(rpc.getQName().getLocalName());\r
- String rpcMethodName = parseToValidParamName(rpcName);\r
- MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);\r
-\r
- final List<DataNodeIterator> rpcInOut = new ArrayList<>();\r
-\r
- ContainerSchemaNode input = rpc.getInput();\r
- ContainerSchemaNode output = rpc.getOutput();\r
-\r
- if (input != null) {\r
- rpcInOut.add(new DataNodeIterator(input));\r
- GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);\r
- addImplementedInterfaceFromUses(input, inType);\r
- inType.addImplementsType(DATA_OBJECT);\r
- inType.addImplementsType(augmentable(inType));\r
- resolveDataSchemaNodes(basePackageName, inType, input.getChildNodes());\r
- Type inTypeInstance = inType.toInstance();\r
- genRPCTypes.add(inTypeInstance);\r
- method.addParameter(inTypeInstance, "input");\r
- }\r
-\r
- Type outTypeInstance = Types.typeForClass(Void.class);\r
- if (output != null) {\r
- rpcInOut.add(new DataNodeIterator(output));\r
- GeneratedTypeBuilder 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.getChildNodes());\r
- outTypeInstance = outType.toInstance();\r
- genRPCTypes.add(outTypeInstance);\r
-\r
- }\r
-\r
- final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);\r
- method.setReturnType(Types.parameterizedTypeFor(future, rpcRes));\r
- for (DataNodeIterator it : rpcInOut) {\r
- List<ContainerSchemaNode> nContainers = it.allContainers();\r
- if ((nContainers != null) && !nContainers.isEmpty()) {\r
- for (final ContainerSchemaNode container : nContainers) {\r
- if (!container.isAddedByUses()) {\r
- genRPCTypes.add(containerToGenType(basePackageName, container));\r
- }\r
- }\r
- }\r
- List<ListSchemaNode> nLists = it.allLists();\r
- if ((nLists != null) && !nLists.isEmpty()) {\r
- for (final ListSchemaNode 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 List<Type> allNotificationsToGenType(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
-\r
- Preconditions.checkArgument(module.getName() != null,"Module name cannot be NULL.");\r
-\r
- if (module.getChildNodes() == null) {\r
- throw new IllegalArgumentException("Reference to Set of Notification Definitions in module "\r
- + module.getName() + " cannot be NULL.");\r
- }\r
- final Set<NotificationDefinition> notifications = module.getNotifications();\r
- if(notifications.isEmpty()) return Collections.emptyList();\r
- \r
- final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");\r
- listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);\r
- \r
- \r
- \r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- final List<Type> generatedTypes = new ArrayList<>();\r
- \r
- \r
- for (final NotificationDefinition notification : notifications) {\r
- if (notification != null) {\r
- DataNodeIterator it = new DataNodeIterator(notification);\r
-\r
- // Containers\r
- for (ContainerSchemaNode node : it.allContainers()) {\r
- if (!node.isAddedByUses()) {\r
- generatedTypes.add(containerToGenType(basePackageName, node));\r
- }\r
- }\r
- // Lists\r
- for (ListSchemaNode node : it.allLists()) {\r
- if (!node.isAddedByUses()) {\r
- generatedTypes.addAll(listToGenType(basePackageName, node));\r
- }\r
- }\r
- final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,\r
- notification);\r
- notificationInterface.addImplementsType(Types\r
- .typeForClass(org.opendaylight.yangtools.yang.binding.Notification.class));\r
- // Notification object\r
- resolveDataSchemaNodes(basePackageName, notificationInterface, notification.getChildNodes());\r
- \r
- listenerInterface.addMethod("on"+notificationInterface.getName()) //\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 List<Type> allIdentitiesToGenTypes(final Module module, final SchemaContext context) {\r
- List<Type> genTypes = new ArrayList<>();\r
-\r
- final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();\r
-\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
-\r
- if (schemaIdentities != null && !schemaIdentities.isEmpty()) {\r
- for (final IdentitySchemaNode 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 GeneratedType identityToGenType(final String basePackageName, final IdentitySchemaNode identity,\r
- final SchemaContext context) {\r
- if (identity == null) {\r
- return null;\r
- }\r
-\r
- final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());\r
- final String genTypeName = parseToClassName(identity.getQName().getLocalName());\r
- final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);\r
-\r
- IdentitySchemaNode baseIdentity = identity.getBaseIdentity();\r
- if (baseIdentity != null) {\r
- Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);\r
-\r
- final String returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);\r
- final String returnTypeName = parseToClassName(baseIdentity.getQName().getLocalName());\r
-\r
- GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();\r
- newType.setExtendsType(gto);\r
- } else {\r
- newType.setExtendsType(Types.getBaseIdentityTO());\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 List<Type> allGroupingsToGenTypes(final Module module) {\r
- Preconditions.checkArgument(module != null,"Module parameter can not be null");\r
- final List<Type> genTypes = new ArrayList<>();\r
- final String basePackageName = moduleNamespaceToPackageName(module);\r
- final Set<GroupingDefinition> groupings = module.getGroupings();\r
- List<GroupingDefinition> groupingsSortedByDependencies;\r
-\r
- groupingsSortedByDependencies = GroupingDefinitionDependencySort.sort(groupings);\r
-\r
- for (final GroupingDefinition grouping : groupingsSortedByDependencies) {\r
- GeneratedType genType = groupingToGenType(basePackageName, grouping);\r
- genTypes.add(genType);\r
- SchemaPath schemaPath = grouping.getPath();\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 GeneratedType groupingToGenType(final String basePackageName, GroupingDefinition grouping) {\r
- if (grouping == null) {\r
- return null;\r
- }\r
-\r
- final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());\r
- final Set<DataSchemaNode> schemaNodes = grouping.getChildNodes();\r
- final GeneratedTypeBuilder 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 EnumTypeDefinition enumTypeDefFromExtendedType(final TypeDefinition<?> typeDefinition) {\r
- if (typeDefinition != null) {\r
- if (typeDefinition.getBaseType() instanceof EnumTypeDefinition) {\r
- return (EnumTypeDefinition) typeDefinition.getBaseType();\r
- } else if (typeDefinition.getBaseType() instanceof ExtendedType) {\r
- return enumTypeDefFromExtendedType(typeDefinition.getBaseType());\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 EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final String enumName,\r
- final GeneratedTypeBuilder typeBuilder) {\r
- if ((enumTypeDef != null) && (typeBuilder != null) && (enumTypeDef.getQName() != null)\r
- && (enumTypeDef.getQName().getLocalName() != null)) {\r
-\r
- final String enumerationName = parseToClassName(enumName);\r
- final EnumBuilder 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 GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {\r
- Preconditions.checkArgument(module != null,"Module reference cannot be NULL.");\r
- String packageName = moduleNamespaceToPackageName(module);\r
- final String moduleName = parseToClassName(module.getName()) + 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 List<Type> augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema) {\r
- Preconditions.checkArgument(augmentPackageName != null,"Package Name cannot be NULL.");\r
- Preconditions.checkArgument(augSchema != null,"Augmentation Schema cannot be NULL.");\r
- Preconditions.checkState(augSchema.getTargetPath() != null,"Augmentation Schema does not contain Target Path (Target Path is NULL).");\r
-\r
- final List<Type> genTypes = new ArrayList<>();\r
-\r
- // EVERY augmented interface will extends Augmentation<T> interface\r
- // and DataObject interface!!!\r
- final SchemaPath targetPath = augSchema.getTargetPath();\r
- final DataSchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);\r
- if ((targetSchemaNode != null) && (targetSchemaNode.getQName() != null)\r
- && (targetSchemaNode.getQName().getLocalName() != null)) {\r
- final Module targetModule = findParentModule(schemaContext, targetSchemaNode);\r
- final String targetBasePackage = moduleNamespaceToPackageName(targetModule);\r
- final String targetPackageName = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());\r
- final String targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();\r
- final Set<DataSchemaNode> augChildNodes = augSchema.getChildNodes();\r
-\r
- if (!(targetSchemaNode instanceof ChoiceNode)) {\r
- final GeneratedTypeBuilder augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName,\r
- targetPackageName, targetSchemaNodeName, augSchema);\r
- final GeneratedType augType = augTypeBuilder.toInstance();\r
- genTypes.add(augType);\r
- } else {\r
- final Type refChoiceType = new ReferencedTypeImpl(targetPackageName,\r
- parseToClassName(targetSchemaNodeName));\r
- final ChoiceNode choiceTarget = (ChoiceNode) targetSchemaNode;\r
- final Set<ChoiceCaseNode> choiceCaseNodes = choiceTarget.getCases();\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 GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final String augmentPackageName,\r
- final String targetPackageName, final String targetSchemaNodeName, final AugmentationSchema augSchema) {\r
- final String targetTypeName = parseToClassName(targetSchemaNodeName);\r
- Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);\r
- if (augmentBuilders == null) {\r
- augmentBuilders = new HashMap<>();\r
- genTypeBuilders.put(augmentPackageName, augmentBuilders);\r
- }\r
- final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());\r
-\r
- final String augTypeName = augIdentifier != null ? parseToClassName(augIdentifier) : augGenTypeName(\r
- augmentBuilders, targetTypeName);\r
- final Type targetTypeRef = new ReferencedTypeImpl(targetPackageName, targetTypeName);\r
- final Set<DataSchemaNode> augChildNodes = augSchema.getChildNodes();\r
-\r
- final GeneratedTypeBuilder 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 String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {\r
- String ret = null;\r
- for (UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {\r
- QName nodeType = unknownSchemaNode.getNodeType();\r
- if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())\r
- && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {\r
- return unknownSchemaNode.getNodeParameter();\r
- }\r
- }\r
- return ret;\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 List<Type> augmentationBodyToGenTypes(final String augBasePackageName,\r
- final Set<DataSchemaNode> augChildNodes) {\r
- final List<Type> genTypes = new ArrayList<>();\r
- final List<DataNodeIterator> augSchemaIts = new ArrayList<>();\r
- for (final DataSchemaNode childNode : augChildNodes) {\r
- if (childNode instanceof DataNodeContainer) {\r
- augSchemaIts.add(new DataNodeIterator((DataNodeContainer) childNode));\r
-\r
- if (childNode instanceof ContainerSchemaNode) {\r
- genTypes.add(containerToGenType(augBasePackageName, (ContainerSchemaNode) childNode));\r
- } else if (childNode instanceof ListSchemaNode) {\r
- genTypes.addAll(listToGenType(augBasePackageName, (ListSchemaNode) childNode));\r
- }\r
- } else if (childNode instanceof ChoiceNode) {\r
- final ChoiceNode choice = (ChoiceNode) childNode;\r
- for (final ChoiceCaseNode caseNode : choice.getCases()) {\r
- augSchemaIts.add(new DataNodeIterator(caseNode));\r
- }\r
- genTypes.addAll(choiceToGeneratedType(augBasePackageName, (ChoiceNode) childNode));\r
- }\r
- }\r
-\r
- for (final DataNodeIterator it : augSchemaIts) {\r
- final List<ContainerSchemaNode> augContainers = it.allContainers();\r
- final List<ListSchemaNode> augLists = it.allLists();\r
- final List<ChoiceNode> augChoices = it.allChoices();\r
-\r
- if (augContainers != null) {\r
- for (final ContainerSchemaNode container : augContainers) {\r
- genTypes.add(containerToGenType(augBasePackageName, container));\r
- }\r
- }\r
- if (augLists != null) {\r
- for (final ListSchemaNode list : augLists) {\r
- genTypes.addAll(listToGenType(augBasePackageName, list));\r
- }\r
- }\r
- if (augChoices != null) {\r
- for (final ChoiceNode 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 String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {\r
- String augTypeName = genTypeName;\r
-\r
- int index = 1;\r
- while ((builders != null) && builders.containsKey(genTypeName + index)) {\r
- index++;\r
- }\r
- augTypeName += index;\r
- return augTypeName;\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 GeneratedType containerToGenType(final String basePackageName, ContainerSchemaNode containerNode) {\r
- if (containerNode == null) {\r
- return null;\r
- }\r
-\r
- final String packageName = packageNameForGeneratedType(basePackageName, containerNode.getPath());\r
- final Set<DataSchemaNode> schemaNodes = containerNode.getChildNodes();\r
- final GeneratedTypeBuilder 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 GeneratedTypeBuilder resolveDataSchemaNodes(final String basePackageName,\r
- final GeneratedTypeBuilder typeBuilder, final Set<DataSchemaNode> schemaNodes) {\r
- if ((schemaNodes != null) && (typeBuilder != null)) {\r
- for (final DataSchemaNode schemaNode : schemaNodes) {\r
- if (schemaNode.isAugmenting() || schemaNode.isAddedByUses()) {\r
- continue;\r
- }\r
- addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\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 GeneratedTypeBuilder augSchemaNodeToMethods(final String basePackageName,\r
- final GeneratedTypeBuilder typeBuilder, final Set<DataSchemaNode> schemaNodes) {\r
- if ((schemaNodes != null) && (typeBuilder != null)) {\r
- for (final DataSchemaNode 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 void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode schemaNode,\r
- final GeneratedTypeBuilder typeBuilder) {\r
- if (schemaNode != null && typeBuilder != null) {\r
- if (schemaNode instanceof LeafSchemaNode) {\r
- resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof LeafListSchemaNode) {\r
- resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof ContainerSchemaNode) {\r
- resolveContainerSchemaNode(basePackageName, typeBuilder, (ContainerSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof ListSchemaNode) {\r
- resolveListSchemaNode(basePackageName, typeBuilder, (ListSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof ChoiceNode) {\r
- resolveChoiceSchemaNode(basePackageName, typeBuilder, (ChoiceNode) schemaNode);\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 void resolveChoiceSchemaNode(final String basePackageName, final GeneratedTypeBuilder typeBuilder,\r
- final ChoiceNode choiceNode) {\r
- Preconditions.checkArgument(basePackageName != null,"Base Package Name cannot be NULL.");\r
- Preconditions.checkArgument(typeBuilder != null,"Generated Type Builder cannot be NULL.");\r
- Preconditions.checkArgument(choiceNode != null,"Choice Schema Node cannot be NULL.");\r
-\r
- final String choiceName = choiceNode.getQName().getLocalName();\r
- if (choiceName != null && !choiceNode.isAddedByUses()) {\r
- final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());\r
- final GeneratedTypeBuilder choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);\r
- constructGetter(typeBuilder, choiceName, choiceNode.getDescription(), 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 List<GeneratedType> choiceToGeneratedType(final String basePackageName, final ChoiceNode choiceNode) {\r
- Preconditions.checkArgument(basePackageName != null,"Base Package Name cannot be NULL.");\r
- Preconditions.checkArgument(choiceNode != null,"Choice Schema Node cannot be NULL.");\r
-\r
- final List<GeneratedType> generatedTypes = new ArrayList<>();\r
- final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());\r
- final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);\r
- choiceTypeBuilder.addImplementsType(DATA_OBJECT);\r
- final GeneratedType choiceType = choiceTypeBuilder.toInstance();\r
-\r
- generatedTypes.add(choiceType);\r
- final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();\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 List<GeneratedType> generateTypesFromChoiceCases(final String basePackageName, final Type refChoiceType,\r
- final Set<ChoiceCaseNode> caseNodes) {\r
- Preconditions.checkArgument(basePackageName != null,"Base Package Name cannot be NULL.");\r
- Preconditions.checkArgument(refChoiceType != null,"Referenced Choice Type cannot be NULL.");\r
- Preconditions.checkArgument(caseNodes != null,"Set of Choice Case Nodes cannot be NULL.");\r
-\r
- final List<GeneratedType> generatedTypes = new ArrayList<>();\r
- for (final ChoiceCaseNode caseNode : caseNodes) {\r
- if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {\r
- final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());\r
- final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
- caseTypeBuilder.addImplementsType(refChoiceType);\r
-\r
- final Set<DataSchemaNode> childNodes = caseNode.getChildNodes();\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 List<GeneratedType> generateTypesFromAugmentedChoiceCases(final String basePackageName,\r
- final Type refChoiceType, final Set<ChoiceCaseNode> caseNodes) {\r
- Preconditions.checkArgument(basePackageName != null,"Base Package Name cannot be NULL.");\r
- Preconditions.checkArgument(refChoiceType != null,"Referenced Choice Type cannot be NULL.");\r
- Preconditions.checkArgument(caseNodes != null,"Set of Choice Case Nodes cannot be NULL.");\r
-\r
- final List<GeneratedType> generatedTypes = new ArrayList<>();\r
- for (final ChoiceCaseNode caseNode : caseNodes) {\r
- if (caseNode != null && caseNode.isAugmenting()) {\r
- final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());\r
- final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
- caseTypeBuilder.addImplementsType(refChoiceType);\r
-\r
- final Set<DataSchemaNode> childNodes = caseNode.getChildNodes();\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 boolean resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) {\r
- if ((leaf != null) && (typeBuilder != null)) {\r
- final String leafName = leaf.getQName().getLocalName();\r
- String leafDesc = leaf.getDescription();\r
- if (leafDesc == null) {\r
- leafDesc = "";\r
- }\r
-\r
- final Module parentModule = findParentModule(schemaContext, leaf);\r
- if (leafName != null && !leaf.isAddedByUses()) {\r
- final TypeDefinition<?> typeDef = leaf.getType();\r
-\r
- Type returnType = null;\r
- if (typeDef instanceof EnumTypeDefinition) {\r
- returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
- final EnumTypeDefinition enumTypeDef = enumTypeDefFromExtendedType(typeDef);\r
- final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName,\r
- typeBuilder);\r
-\r
- if (enumBuilder != null) {\r
- returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());\r
- }\r
- ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);\r
- } else if (typeDef instanceof UnionType) {\r
- GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
- if (genTOBuilder != null) {\r
- returnType = new ReferencedTypeImpl(genTOBuilder.getPackageName(), genTOBuilder.getName());\r
- }\r
- } else if (typeDef instanceof BitsTypeDefinition) {\r
- GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
- if (genTOBuilder != null) {\r
- returnType = new ReferencedTypeImpl(genTOBuilder.getPackageName(), genTOBuilder.getName());\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 boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,\r
- boolean isReadOnly) {\r
- if ((leaf != null) && (toBuilder != null)) {\r
- final String leafName = leaf.getQName().getLocalName();\r
- String leafDesc = leaf.getDescription();\r
- if (leafDesc == null) {\r
- leafDesc = "";\r
- }\r
-\r
- if (leafName != null && !leaf.isAddedByUses()) {\r
- final TypeDefinition<?> typeDef = leaf.getType();\r
-\r
- // TODO: properly resolve enum types\r
- final Type returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
-\r
- if (returnType != null) {\r
- final GeneratedPropertyBuilder 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 boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node) {\r
- if ((node != null) && (typeBuilder != null)) {\r
- final String nodeName = node.getQName().getLocalName();\r
- String nodeDesc = node.getDescription();\r
- if (nodeDesc == null) {\r
- nodeDesc = "";\r
- }\r
-\r
- if (nodeName != null && !node.isAddedByUses()) {\r
- final TypeDefinition<?> type = node.getType();\r
- final Type 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 boolean resolveContainerSchemaNode(final String basePackageName, final GeneratedTypeBuilder typeBuilder,\r
- final ContainerSchemaNode containerNode) {\r
- if ((containerNode != null) && (typeBuilder != null)) {\r
- final String nodeName = containerNode.getQName().getLocalName();\r
-\r
- if (nodeName != null && !containerNode.isAddedByUses()) {\r
- final String packageName = packageNameForGeneratedType(basePackageName, containerNode.getPath());\r
-\r
- final GeneratedTypeBuilder rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);\r
- constructGetter(typeBuilder, nodeName, containerNode.getDescription(), 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 boolean resolveListSchemaNode(final String basePackageName, final GeneratedTypeBuilder typeBuilder,\r
- final ListSchemaNode listNode) {\r
- if ((listNode != null) && (typeBuilder != null)) {\r
- final String listName = listNode.getQName().getLocalName();\r
-\r
- if (listName != null && !listNode.isAddedByUses()) {\r
- final String packageName = packageNameForGeneratedType(basePackageName, listNode.getPath());\r
- final GeneratedTypeBuilder rawGenType = addDefaultInterfaceDefinition(packageName, listNode);\r
- constructGetter(typeBuilder, listName, listNode.getDescription(), 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 GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode) {\r
- final GeneratedTypeBuilder 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((DataNodeContainer) schemaNode, 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 GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final 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 GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,\r
- final String prefix) {\r
- Preconditions.checkArgument(schemaNode != null,"Data Schema Node cannot be NULL.");\r
- Preconditions.checkArgument(packageName != null,"Package Name for Generated Type cannot be NULL.");\r
- Preconditions.checkArgument(schemaNode.getQName() != null,"QName for Data Schema Node cannot be NULL.");\r
- final String schemaNodeName = schemaNode.getQName().getLocalName();\r
- Preconditions.checkArgument(schemaNodeName != null,"Local Name of QName for Data Schema Node cannot be NULL.");\r
-\r
- final String genTypeName;\r
- if (prefix == null) {\r
- genTypeName = parseToClassName(schemaNodeName);\r
- } else {\r
- genTypeName = prefix + parseToClassName(schemaNodeName);\r
- }\r
-\r
- final GeneratedTypeBuilder newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);\r
- if (!genTypeBuilders.containsKey(packageName)) {\r
- final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();\r
- builders.put(genTypeName, newType);\r
- genTypeBuilders.put(packageName, builders);\r
- } else {\r
- final 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 String getterMethodName(final String methodName,Type returnType) {\r
- final StringBuilder 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
- * Creates the name of the setter method from <code>methodName</code>.\r
- *\r
- * @param methodName\r
- * string with the name of the setter method\r
- * @return string with the name of the setter method for\r
- * <code>methodName</code> in JAVA method format\r
- */\r
- private String setterMethodName(final String methodName) {\r
- final StringBuilder method = new StringBuilder();\r
- method.append("set");\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 MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,\r
- final String schemaNodeName, final String comment, final Type returnType) {\r
-\r
- final MethodSignatureBuilder getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName,returnType));\r
-\r
- getMethod.setComment(comment);\r
- getMethod.setReturnType(returnType);\r
-\r
- return getMethod;\r
- }\r
-\r
- private List<Type> listToGenType(final String basePackageName, final ListSchemaNode list) {\r
- Preconditions.checkArgument(basePackageName != null,"Package Name for Generated Type cannot be NULL.");\r
- Preconditions.checkArgument(list != null,"List Schema Node cannot be NULL.");\r
-\r
- final String packageName = packageNameForGeneratedType(basePackageName, list.getPath());\r
- // final GeneratedTypeBuilder typeBuilder =\r
- // resolveListTypeBuilder(packageName, list);\r
- final GeneratedTypeBuilder typeBuilder = addDefaultInterfaceDefinition(packageName, list);\r
-\r
- final List<String> listKeys = listKeys(list);\r
- GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, list);\r
-\r
- if (genTOBuilder != null) {\r
- ParameterizedType identifierMarker = Types.parameterizedTypeFor(Types.typeForClass(Identifier.class),\r
- typeBuilder);\r
- ParameterizedType identifiableMarker = Types.parameterizedTypeFor(Types.typeForClass(Identifiable.class),\r
- genTOBuilder);\r
- genTOBuilder.addImplementsType(identifierMarker);\r
- typeBuilder.addImplementsType(identifiableMarker);\r
- }\r
- final Set<DataSchemaNode> schemaNodes = list.getChildNodes();\r
-\r
- for (final DataSchemaNode schemaNode : schemaNodes) {\r
- if (schemaNode.isAugmenting()) {\r
- continue;\r
- }\r
- addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);\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 void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,\r
- final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys) {\r
- Preconditions.checkArgument(schemaNode != null,"Data Schema Node cannot be NULL.");\r
-\r
- Preconditions.checkArgument(typeBuilder != null,"Generated Type Builder cannot be NULL.");\r
-\r
- if (schemaNode instanceof LeafSchemaNode) {\r
- final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;\r
- final String leafName = leaf.getQName().getLocalName();\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, (LeafListSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof ContainerSchemaNode) {\r
- resolveContainerSchemaNode(basePackageName, typeBuilder, (ContainerSchemaNode) schemaNode);\r
- } else if (schemaNode instanceof ListSchemaNode) {\r
- resolveListSchemaNode(basePackageName, typeBuilder, (ListSchemaNode) schemaNode);\r
- }\r
- }\r
-\r
- private List<Type> typeBuildersToGenTypes(final GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {\r
- final List<Type> genTypes = new ArrayList<>();\r
- Preconditions.checkArgument(typeBuilder != null,"Generated Type Builder cannot be NULL.");\r
-\r
- if (genTOBuilder != null) {\r
- final GeneratedTransferObject 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 List<String> listKeys(final ListSchemaNode list) {\r
- final List<String> listKeys = new ArrayList<>();\r
-\r
- if (list.getKeyDefinition() != null) {\r
- final List<QName> keyDefinitions = list.getKeyDefinition();\r
-\r
- for (final QName keyDefinition : keyDefinitions) {\r
- listKeys.add(keyDefinition.getLocalName());\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 GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {\r
- GeneratedTOBuilder genTOBuilder = null;\r
- if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {\r
- if (list != null) {\r
- final String listName = list.getQName().getLocalName() + "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 GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,\r
- String leafName, LeafSchemaNode leaf, Module parentModule) {\r
- final String classNameFromLeaf = parseToClassName(leafName);\r
- List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();\r
- final String packageName = typeBuilder.getFullyQualifiedName();\r
- if (typeDef instanceof UnionTypeDefinition) {\r
- genTOBuilders.addAll(((TypeProviderImpl) typeProvider).provideGeneratedTOBuildersForUnionTypeDef(\r
- packageName, typeDef, classNameFromLeaf, leaf));\r
- } else if (typeDef instanceof BitsTypeDefinition) {\r
- genTOBuilders.add(((TypeProviderImpl) typeProvider).provideGeneratedTOBuilderForBitsTypeDefinition(\r
- packageName, typeDef, classNameFromLeaf));\r
- }\r
- if (genTOBuilders != null && !genTOBuilders.isEmpty()) {\r
- for (GeneratedTOBuilder 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 adde 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 GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,\r
- final GeneratedTypeBuilder builder) {\r
- for (UsesNode usesNode : dataNodeContainer.getUses()) {\r
- if (usesNode.getGroupingPath() != null) {\r
- GeneratedType genType = allGroupings.get(usesNode.getGroupingPath());\r
- if (genType == null) {\r
- throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "\r
- + builder.getName());\r
- }\r
- builder.addImplementsType(genType);\r
- }\r
- }\r
- return builder;\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.binding.generator.impl;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Preconditions.checkState;
+import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.computeDefaultSUID;
+import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.packageNameForGeneratedType;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_OBJECT;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.DATA_ROOT;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIABLE;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.IDENTIFIER;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.NOTIFICATION;
+import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.augmentable;
+import static org.opendaylight.yangtools.binding.generator.util.Types.BOOLEAN;
+import static org.opendaylight.yangtools.binding.generator.util.Types.FUTURE;
+import static org.opendaylight.yangtools.binding.generator.util.Types.VOID;
+import static org.opendaylight.yangtools.binding.generator.util.Types.typeForClass;
+import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
+import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findNodeInSchemaContext;
+import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
+import com.google.common.base.Preconditions;
+import com.google.common.base.Splitter;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Sets;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
+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.GeneratedPropertyBuilderImpl;
+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.Constant;
+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.ParameterizedType;
+import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
+import org.opendaylight.yangtools.sal.binding.model.api.Type;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
+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.GeneratedTypeBuilderBase;
+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.BaseIdentity;
+import org.opendaylight.yangtools.yang.binding.BindingMapping;
+import org.opendaylight.yangtools.yang.binding.DataContainer;
+import org.opendaylight.yangtools.yang.binding.RpcService;
+import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
+import org.opendaylight.yangtools.yang.common.QName;
+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.ChoiceSchemaNode;
+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.DerivableSchemaNode;
+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.ModuleImport;
+import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
+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.UsesNode;
+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.SchemaContextUtil;
+import org.opendaylight.yangtools.yang.model.util.UnionType;
+import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
+import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class BindingGeneratorImpl implements BindingGenerator {
+ private static final Logger LOG = LoggerFactory.getLogger(BindingGeneratorImpl.class);
+ private static final Splitter COLON_SPLITTER = Splitter.on(':');
+ private static final Splitter BSDOT_SPLITTER = Splitter.on("\\.");
+ private static final char NEW_LINE = '\n';
+
+ /**
+ * Constant with the concrete name of identifier.
+ */
+ private static final String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
+
+ /**
+ * Constant with the concrete name of namespace.
+ */
+ private static final String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
+
+ private final Map<Module, ModuleContext> genCtx = new HashMap<>();
+
+ /**
+ * When set to true, generated classes will include javadoc comments which
+ * are useful for users.
+ */
+ private final boolean verboseClassComments;
+
+ /**
+ * Outer key represents the package name. Outer 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 TypeProvider typeProvider;
+
+ /**
+ * Holds reference to schema context to resolve data of augmented element
+ * when creating augmentation builder
+ */
+ private SchemaContext schemaContext;
+
+ /**
+ * Create a new binding generator with verboe comments.
+ *
+ * @deprecated Use {@link #BindingGeneratorImpl(boolean)} instead.
+ */
+ @Deprecated
+ public BindingGeneratorImpl() {
+ this(true);
+ }
+
+ /**
+ * Create a new binding generator.
+ *
+ * @param verboseClassComments generate verbose comments
+ */
+ public BindingGeneratorImpl(final boolean verboseClassComments) {
+ this.verboseClassComments = verboseClassComments;
+ }
+
+ /**
+ * 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 arg <code>context</code> is null
+ * @throws IllegalStateException
+ * if <code>context</code> contain no modules
+ */
+ @Override
+ public List<Type> generateTypes(final SchemaContext context) {
+ checkArgument(context != null, "Schema Context reference cannot be NULL.");
+ checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
+ schemaContext = context;
+ typeProvider = new TypeProviderImpl(context);
+ final Set<Module> modules = context.getModules();
+ return generateTypes(context, modules);
+ }
+
+ /**
+ * 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 arg <code>context</code> is null or</li>
+ * <li>if arg <code>modules</code> is null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if <code>context</code> contain no modules
+ */
+ @Override
+ public List<Type> generateTypes(final SchemaContext context, final Set<Module> modules) {
+ checkArgument(context != null, "Schema Context reference cannot be NULL.");
+ checkState(context.getModules() != null, "Schema Context does not contain defined modules.");
+ checkArgument(modules != null, "Set of Modules cannot be NULL.");
+
+ schemaContext = context;
+ typeProvider = new TypeProviderImpl(context);
+ Module[] modulesArray = new Module[context.getModules().size()];
+ context.getModules().toArray(modulesArray);
+ final List<Module> contextModules = ModuleDependencySort.sort(modulesArray);
+ genTypeBuilders = new HashMap<>();
+
+ for (Module contextModule : contextModules) {
+ moduleToGenTypes(contextModule, context);
+ }
+ for (Module contextModule : contextModules) {
+ allAugmentsToGenTypes(contextModule);
+ }
+
+ final List<Type> filteredGenTypes = new ArrayList<>();
+ for (Module m : modules) {
+ final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m);
+ filteredGenTypes.addAll(ctx.getGeneratedTypes());
+ final Set<Type> additionalTypes = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(m);
+ if (additionalTypes != null) {
+ filteredGenTypes.addAll(additionalTypes);
+ }
+ }
+
+ return filteredGenTypes;
+ }
+
+ private void moduleToGenTypes(final Module m, final SchemaContext context) {
+ genCtx.put(m, new ModuleContext());
+ allTypeDefinitionsToGenTypes(m);
+ groupingsToGenTypes(m, m.getGroupings());
+ rpcMethodsToGenType(m);
+ allIdentitiesToGenTypes(m, context);
+ notificationsToGenType(m);
+
+ if (!m.getChildNodes().isEmpty()) {
+ final GeneratedTypeBuilder moduleType = moduleToDataType(m);
+ genCtx.get(m).addModuleNode(moduleType);
+ final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
+ resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.getChildNodes());
+ }
+ }
+
+ /**
+ * 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
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if module is null</li>
+ * <li>if name of module is null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if set of type definitions from module is null
+ */
+ private void allTypeDefinitionsToGenTypes(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ checkArgument(module.getName() != null, "Module name cannot be NULL.");
+ final DataNodeIterator it = new DataNodeIterator(module);
+ final List<TypeDefinition<?>> typeDefinitions = it.allTypedefs();
+ checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL.");
+
+ for (TypeDefinition<?> typedef : typeDefinitions) {
+ if (typedef != null) {
+ final Type type = ((TypeProviderImpl) typeProvider).generatedTypeForExtendedDefinitionType(typedef,
+ typedef);
+ if (type != null) {
+ final ModuleContext ctx = genCtx.get(module);
+ ctx.addTypedefType(typedef.getPath(), type);
+ ctx.addTypeToSchema(type,typedef);
+ }
+ }
+ }
+ }
+
+ private GeneratedTypeBuilder processDataSchemaNode(final Module module, final String basePackageName,
+ final GeneratedTypeBuilder childOf, final DataSchemaNode node) {
+ if (node.isAugmenting() || node.isAddedByUses()) {
+ return null;
+ }
+ final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
+ final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, node, childOf, module);
+ genType.addComment(node.getDescription());
+ genType.setDescription(createDescription(node, genType.getFullyQualifiedName()));
+ genType.setModuleName(module.getName());
+ genType.setReference(node.getReference());
+ genType.setSchemaPath(node.getPath().getPathFromRoot());
+ if (node instanceof DataNodeContainer) {
+ genCtx.get(module).addChildNodeType(node, genType);
+ groupingsToGenTypes(module, ((DataNodeContainer) node).getGroupings());
+ processUsesAugments((DataNodeContainer) node, module);
+ }
+ return genType;
+ }
+
+ private void containerToGenType(final Module module, final String basePackageName,
+ final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final ContainerSchemaNode node) {
+ final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
+ if (genType != null) {
+ constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), genType);
+ resolveDataSchemaNodes(module, basePackageName, genType, genType, node.getChildNodes());
+ }
+ }
+
+ private void listToGenType(final Module module, final String basePackageName, final GeneratedTypeBuilder parent,
+ final GeneratedTypeBuilder childOf, final ListSchemaNode node) {
+ final GeneratedTypeBuilder genType = processDataSchemaNode(module, basePackageName, childOf, node);
+ if (genType != null) {
+ constructGetter(parent, node.getQName().getLocalName(), node.getDescription(), Types.listTypeFor(genType));
+
+ final List<String> listKeys = listKeys(node);
+ final String packageName = packageNameForGeneratedType(basePackageName, node.getPath());
+ final GeneratedTOBuilder genTOBuilder = resolveListKeyTOBuilder(packageName, node);
+ if (genTOBuilder != null) {
+ final Type identifierMarker = Types.parameterizedTypeFor(IDENTIFIER, genType);
+ final Type identifiableMarker = Types.parameterizedTypeFor(IDENTIFIABLE, genTOBuilder);
+ genTOBuilder.addImplementsType(identifierMarker);
+ genType.addImplementsType(identifiableMarker);
+ }
+
+ for (DataSchemaNode schemaNode : node.getChildNodes()) {
+ if (!schemaNode.isAugmenting()) {
+ addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
+ }
+ }
+
+ // serialVersionUID
+ if (genTOBuilder != null) {
+ final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
+ prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder)));
+ genTOBuilder.setSUID(prop);
+ }
+
+ typeBuildersToGenTypes(module, genType, genTOBuilder);
+ }
+ }
+
+ private void processUsesAugments(final DataNodeContainer node, final Module module) {
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ for (UsesNode usesNode : node.getUses()) {
+ for (AugmentationSchema augment : usesNode.getAugmentations()) {
+ usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
+ processUsesAugments(augment, module);
+ }
+ }
+ }
+
+ /**
+ * 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
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module is null</li>
+ * <li>if the name of module is null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if set of augmentations from module is null
+ */
+ private void allAugmentsToGenTypes(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ checkArgument(module.getName() != null, "Module name cannot be NULL.");
+ checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
+
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ final List<AugmentationSchema> augmentations = resolveAugmentations(module);
+ for (AugmentationSchema augment : augmentations) {
+ augmentationToGenTypes(basePackageName, augment, module);
+ }
+ }
+
+ /**
+ * 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
+ * if module is null
+ * @throws IllegalStateException
+ * if set of module augmentations is null
+ */
+ private List<AugmentationSchema> resolveAugmentations(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL.");
+
+ final Set<AugmentationSchema> augmentations = module.getAugmentations();
+ List<AugmentationSchema> sortedAugmentations = new ArrayList<>(augmentations);
+ Collections.sort(sortedAugmentations, Comparators.AUGMENT_COMP);
+
+ return sortedAugmentations;
+ }
+
+ /**
+ * Create GeneratedTypeBuilder object from module argument.
+ *
+ * @param module
+ * Module object from which builder will be created
+ * @return <code>GeneratedTypeBuilder</code> which is internal
+ * representation of the module
+ * @throws IllegalArgumentException
+ * if module is null
+ */
+ private GeneratedTypeBuilder moduleToDataType(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+
+ final GeneratedTypeBuilder moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
+ addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
+ moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
+ moduleDataTypeBuilder.addComment(module.getDescription());
+ moduleDataTypeBuilder.setDescription(createDescription(module));
+ moduleDataTypeBuilder.setReference(module.getReference());
+ return moduleDataTypeBuilder;
+ }
+
+ /**
+ * 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
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module is null</li>
+ * <li>if the name of module is null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if set of rpcs from module is null
+ */
+ private void rpcMethodsToGenType(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ checkArgument(module.getName() != null, "Module name cannot be NULL.");
+ final Set<RpcDefinition> rpcDefinitions = module.getRpcs();
+ checkState(rpcDefinitions != null, "Set of rpcs from module " + module.getName() + " cannot be NULL.");
+ if (rpcDefinitions.isEmpty()) {
+ return;
+ }
+
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ final GeneratedTypeBuilder interfaceBuilder = moduleTypeBuilder(module, "Service");
+ interfaceBuilder.addImplementsType(Types.typeForClass(RpcService.class));
+ interfaceBuilder.setDescription(createDescription(rpcDefinitions, module.getName(), module.getModuleSourcePath()));
+
+ for (RpcDefinition rpc : rpcDefinitions) {
+ if (rpc != null) {
+ final String rpcName = BindingMapping.getClassName(rpc.getQName());
+ final String rpcMethodName = BindingMapping.getPropertyName(rpcName);
+ final String rpcComment = rpc.getDescription();
+ final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName);
+ final ContainerSchemaNode input = rpc.getInput();
+ final ContainerSchemaNode output = rpc.getOutput();
+
+ if (input != null) {
+ final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
+ addImplementedInterfaceFromUses(input, inType);
+ inType.addImplementsType(DATA_OBJECT);
+ inType.addImplementsType(augmentable(inType));
+ resolveDataSchemaNodes(module, basePackageName, inType, inType, input.getChildNodes());
+ genCtx.get(module).addChildNodeType(input, inType);
+ final GeneratedType inTypeInstance = inType.toInstance();
+ method.addParameter(inTypeInstance, "input");
+ }
+
+ Type outTypeInstance = VOID;
+ if (output != null) {
+ final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
+ addImplementedInterfaceFromUses(output, outType);
+ outType.addImplementsType(DATA_OBJECT);
+ outType.addImplementsType(augmentable(outType));
+ resolveDataSchemaNodes(module, basePackageName, outType, outType, output.getChildNodes());
+ genCtx.get(module).addChildNodeType(output, outType);
+ outTypeInstance = outType.toInstance();
+ }
+
+ final Type rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult.class), outTypeInstance);
+ method.setComment(rpcComment);
+ method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
+ }
+ }
+
+ genCtx.get(module).addTopLevelNodeType(interfaceBuilder);
+ }
+
+ /**
+ * 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
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if the module equals null</li>
+ * <li>if the name of module equals null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if set of notifications from module is null
+ */
+ private void notificationsToGenType(final Module module) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ checkArgument(module.getName() != null, "Module name cannot be NULL.");
+ final Set<NotificationDefinition> notifications = module.getNotifications();
+ checkState(notifications != null, "Set of notification from module " + module.getName() + " cannot be NULL.");
+ if (notifications.isEmpty()) {
+ return;
+ }
+
+ final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener");
+ listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+
+
+
+ for (NotificationDefinition notification : notifications) {
+ if (notification != null) {
+ processUsesAugments(notification, module);
+
+ final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName,
+ notification, BindingTypes.DATA_OBJECT, module);
+ notificationInterface.addImplementsType(NOTIFICATION);
+ genCtx.get(module).addChildNodeType(notification, notificationInterface);
+
+ // Notification object
+ resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
+ notification.getChildNodes());
+
+ listenerInterface.addMethod("on" + notificationInterface.getName())
+ .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification")
+ .setComment(notification.getDescription()).setReturnType(Types.VOID);
+ }
+ }
+ listenerInterface.setDescription(createDescription(notifications, module.getName(), module.getModuleSourcePath()));
+
+ genCtx.get(module).addTopLevelNodeType(listenerInterface);
+ }
+
+ /**
+ * 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}
+ *
+ */
+ private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) {
+ final Set<IdentitySchemaNode> schemaIdentities = module.getIdentities();
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+
+ if (schemaIdentities != null && !schemaIdentities.isEmpty()) {
+ for (IdentitySchemaNode identity : schemaIdentities) {
+ identityToGenType(module, basePackageName, identity, context);
+ }
+ }
+ }
+
+ /**
+ * 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 module
+ * current module
+ * @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
+ *
+ */
+ private void identityToGenType(final Module module, final String basePackageName,
+ final IdentitySchemaNode identity, final SchemaContext context) {
+ if (identity == null) {
+ return;
+ }
+ final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
+ final String genTypeName = BindingMapping.getClassName(identity.getQName());
+ final GeneratedTOBuilderImpl newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
+ final IdentitySchemaNode baseIdentity = identity.getBaseIdentity();
+ if (baseIdentity == null) {
+ final GeneratedTOBuilderImpl gto = new GeneratedTOBuilderImpl(BaseIdentity.class.getPackage().getName(),
+ BaseIdentity.class.getSimpleName());
+ newType.setExtendsType(gto.toInstance());
+ } else {
+ final Module baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
+ final String returnTypePkgName = BindingMapping.getRootPackageName(baseIdentityParentModule
+ .getQNameModule());
+ final String returnTypeName = BindingMapping.getClassName(baseIdentity.getQName());
+ final GeneratedTransferObject gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName)
+ .toInstance();
+ newType.setExtendsType(gto);
+ }
+ newType.setAbstract(true);
+ newType.addComment(identity.getDescription());
+ newType.setDescription(createDescription(identity, newType.getFullyQualifiedName()));
+ newType.setReference(identity.getReference());
+ newType.setModuleName(module.getName());
+ newType.setSchemaPath(identity.getPath().getPathFromRoot());
+
+ final QName qname = identity.getQName();
+ qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, qname);
+
+ genCtx.get(module).addIdentityType(identity.getQName(), newType);
+ }
+
+ private static Constant qnameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
+ final QName name) {
+ StringBuilder sb = new StringBuilder("org.opendaylight.yangtools.yang.common.QName");
+ sb.append(".create(");
+ sb.append('"');
+ sb.append(name.getNamespace());
+ sb.append("\",\"");
+ sb.append(name.getFormattedRevision());
+ sb.append("\",\"");
+ sb.append(name.getLocalName());
+ sb.append("\");");
+
+ return toBuilder.addConstant(typeForClass(QName.class), constantName, sb.toString());
+ }
+
+ /**
+ * 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 dependent (independent) groupings are in the list
+ * saved at first positions. For every grouping the record is added to map
+ * {@link BindingGeneratorImpl#allGroupings allGroupings}
+ *
+ * @param module
+ * current module
+ * @param collection
+ * of groupings from which types will be generated
+ *
+ */
+ private void groupingsToGenTypes(final Module module, final Collection<GroupingDefinition> groupings) {
+ final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ final List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort()
+ .sort(groupings);
+ for (GroupingDefinition grouping : groupingsSortedByDependencies) {
+ groupingToGenType(basePackageName, grouping, module);
+ }
+ }
+
+ /**
+ * 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
+ * @param module
+ * current module
+ * @return GeneratedType which is generated from grouping (object of type
+ * <code>GroupingDefinition</code>)
+ */
+ private void groupingToGenType(final String basePackageName, final GroupingDefinition grouping, final Module module) {
+ final String packageName = packageNameForGeneratedType(basePackageName, grouping.getPath());
+ final GeneratedTypeBuilder genType = addDefaultInterfaceDefinition(packageName, grouping, module);
+ genCtx.get(module).addGroupingType(grouping.getPath(), genType);
+ resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.getChildNodes());
+ groupingsToGenTypes(module, grouping.getGroupings());
+ processUsesAugments(grouping, module);
+ }
+
+ /**
+ * 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 contains data from
+ * <code>enumTypeDef</code>
+ */
+ private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
+ final GeneratedTypeBuilder typeBuilder) {
+ if ((enumTypeDef != null) && (typeBuilder != null) && (enumTypeDef.getQName() != null)
+ && (enumTypeDef.getQName().getLocalName() != null)) {
+ final String enumerationName = BindingMapping.getClassName(enumName);
+ final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
+ enumBuilder.setDescription(enumTypeDef.getDescription());
+ 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> is null
+ */
+ private GeneratedTypeBuilder moduleTypeBuilder(final Module module, final String postfix) {
+ checkArgument(module != null, "Module reference cannot be NULL.");
+ final String packageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ final String moduleName = BindingMapping.getClassName(module.getName()) + postfix;
+
+ final GeneratedTypeBuilderImpl moduleBuilder = new GeneratedTypeBuilderImpl(packageName, moduleName);
+ moduleBuilder.setDescription(createDescription(module));
+ moduleBuilder.setReference(module.getReference());
+ moduleBuilder.setModuleName(moduleName);
+
+ return moduleBuilder;
+ }
+
+ /**
+ * 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 augmentation
+ * (target path, childs...)
+ * @param module
+ * current module
+ * @param parentUsesNode
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>augmentPackageName</code> equals null</li>
+ * <li>if <code>augSchema</code> equals null</li>
+ * </ul>
+ * @throws IllegalStateException
+ * if augment target path is null
+ */
+ private void augmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
+ final Module module) {
+ checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
+ checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
+ checkState(augSchema.getTargetPath() != null,
+ "Augmentation Schema does not contain Target Path (Target Path is NULL).");
+
+ processUsesAugments(augSchema, module);
+ final SchemaPath targetPath = augSchema.getTargetPath();
+ SchemaNode targetSchemaNode = null;
+
+ targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
+ if (targetSchemaNode instanceof DataSchemaNode && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
+ if (targetSchemaNode instanceof DerivableSchemaNode) {
+ targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
+ }
+ if (targetSchemaNode == null) {
+ throw new IllegalStateException("Failed to find target node from grouping in augmentation " + augSchema
+ + " in module " + module.getName());
+ }
+ }
+ if (targetSchemaNode == null) {
+ throw new IllegalArgumentException("augment target not found: " + targetPath);
+ }
+
+ GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
+ if (targetTypeBuilder == null) {
+ targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
+ }
+ if (targetTypeBuilder == null) {
+ throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
+ }
+
+ if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
+ String packageName = augmentPackageName;
+ final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(),
+ targetTypeBuilder.getName());
+ addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetType, augSchema);
+
+ } else {
+ generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
+ (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes());
+ }
+ }
+
+ private void usesAugmentationToGenTypes(final String augmentPackageName, final AugmentationSchema augSchema,
+ final Module module, final UsesNode usesNode, final DataNodeContainer usesNodeParent) {
+ checkArgument(augmentPackageName != null, "Package Name cannot be NULL.");
+ checkArgument(augSchema != null, "Augmentation Schema cannot be NULL.");
+ checkState(augSchema.getTargetPath() != null,
+ "Augmentation Schema does not contain Target Path (Target Path is NULL).");
+
+ processUsesAugments(augSchema, module);
+ final SchemaPath targetPath = augSchema.getTargetPath();
+ SchemaNode targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
+ if (targetSchemaNode == null) {
+ throw new IllegalArgumentException("augment target not found: " + targetPath);
+ }
+
+ GeneratedTypeBuilder targetTypeBuilder = findChildNodeByPath(targetSchemaNode.getPath());
+ if (targetTypeBuilder == null) {
+ targetTypeBuilder = findCaseByPath(targetSchemaNode.getPath());
+ }
+ if (targetTypeBuilder == null) {
+ throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
+ }
+
+ if (!(targetSchemaNode instanceof ChoiceSchemaNode)) {
+ String packageName = augmentPackageName;
+ if (usesNodeParent instanceof SchemaNode) {
+ packageName = packageNameForGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath(),
+ true);
+ }
+ addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(),
+ augSchema);
+ } else {
+ generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(),
+ (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes());
+ }
+ }
+
+ /**
+ * Convenient method to find node added by uses statement.
+ *
+ * @param targetPath
+ * node path
+ * @param parentUsesNode
+ * parent of uses node
+ * @return node from its original location in grouping
+ */
+ private DataSchemaNode findOriginalTargetFromGrouping(final SchemaPath targetPath, final UsesNode parentUsesNode) {
+ SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath()
+ .getPathFromRoot());
+ if (!(targetGrouping instanceof GroupingDefinition)) {
+ throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
+ }
+
+ GroupingDefinition grouping = (GroupingDefinition) targetGrouping;
+ SchemaNode result = grouping;
+ for (QName node : targetPath.getPathFromRoot()) {
+ // finding by local name is valid, grouping cannot contain nodes
+ // with same name and different namespace
+ if (result instanceof DataNodeContainer) {
+ result = ((DataNodeContainer) result).getDataChildByName(node.getLocalName());
+ } else if (result instanceof ChoiceSchemaNode) {
+ result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName());
+ }
+ }
+ if (result == null) {
+ return null;
+ }
+
+ boolean fromUses = ((DataSchemaNode) result).isAddedByUses();
+ Iterator<UsesNode> groupingUses = grouping.getUses().iterator();
+ while (groupingUses.hasNext() && fromUses) {
+ result = findOriginalTargetFromGrouping(targetPath, groupingUses.next());
+ if (result != null) {
+ fromUses = ((DataSchemaNode) result).isAddedByUses();
+ }
+ }
+ if (fromUses) {
+ // this indicates invalid yang and thus possible bug in code because
+ // invalid yang should be already spotted by parser
+ throw new IllegalStateException("Failed to generate code for augment in " + parentUsesNode);
+ }
+
+ return (DataSchemaNode) result;
+ }
+
+ /**
+ * 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 module
+ * current module
+ * @param augmentPackageName
+ * string with contains the package name to which the augment
+ * belongs
+ * @param basePackageName
+ * string with the package name to which the augmented node
+ * belongs
+ * @param targetTypeRef
+ * target type
+ * @param augSchema
+ * augmentation schema which contains data about the child nodes
+ * and uses of augment
+ * @return generated type builder for augment
+ */
+ private GeneratedTypeBuilder addRawAugmentGenTypeDefinition(final Module module, final String augmentPackageName,
+ final String basePackageName, final Type targetTypeRef, final AugmentationSchema augSchema) {
+ Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
+ if (augmentBuilders == null) {
+ augmentBuilders = new HashMap<>();
+ genTypeBuilders.put(augmentPackageName, augmentBuilders);
+ }
+ final String augIdentifier = getAugmentIdentifier(augSchema.getUnknownSchemaNodes());
+
+ String augTypeName;
+ if (augIdentifier != null) {
+ augTypeName = BindingMapping.getClassName(augIdentifier);
+ } else {
+ augTypeName = augGenTypeName(augmentBuilders, targetTypeRef.getName());
+ }
+
+ final GeneratedTypeBuilder augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
+
+ augTypeBuilder.addImplementsType(DATA_OBJECT);
+ augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
+ addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
+
+ augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes());
+ augmentBuilders.put(augTypeName, augTypeBuilder);
+
+ if(!augSchema.getChildNodes().isEmpty()) {
+ genCtx.get(module).addTargetToAugmentation(targetTypeRef, augTypeBuilder);
+ genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
+
+ }
+ genCtx.get(module).addAugmentType(augTypeBuilder);
+ return augTypeBuilder;
+ }
+
+ /**
+ *
+ * @param unknownSchemaNodes
+ * @return nodeParameter of UnknownSchemaNode
+ */
+ private String getAugmentIdentifier(final List<UnknownSchemaNode> unknownSchemaNodes) {
+ for (UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
+ final QName nodeType = unknownSchemaNode.getNodeType();
+ if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.getLocalName())
+ && YANG_EXT_NAMESPACE.equals(nodeType.getNamespace().toString())) {
+ return unknownSchemaNode.getNodeParameter();
+ }
+ }
+ return null;
+ }
+
+ /**
+ * 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 String augGenTypeName(final Map<String, GeneratedTypeBuilder> builders, final String genTypeName) {
+ int index = 1;
+ if (builders != null) {
+ while (builders.containsKey(genTypeName + index)) {
+ index = index + 1;
+ }
+ }
+ return genTypeName + index;
+ }
+
+ /**
+ * 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 module
+ * current module
+ * @param basePackageName
+ * string contains the module package name
+ * @param parent
+ * 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 childOf
+ * parent type
+ * @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 GeneratedTypeBuilder resolveDataSchemaNodes(final Module module, final String basePackageName,
+ final GeneratedTypeBuilder parent, final GeneratedTypeBuilder childOf, final Iterable<DataSchemaNode> schemaNodes) {
+ if (schemaNodes != null && parent != null) {
+ for (DataSchemaNode schemaNode : schemaNodes) {
+ if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
+ addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
+ }
+ }
+ }
+ return parent;
+ }
+
+ /**
+ * Adds the methods to <code>typeBuilder</code> what represents subnodes of
+ * node for which <code>typeBuilder</code> was created.
+ *
+ * @param module
+ * current module
+ * @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 childOf
+ * parent type
+ * @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 GeneratedTypeBuilder augSchemaNodeToMethods(final Module module, final String basePackageName,
+ final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf,
+ final Iterable<DataSchemaNode> schemaNodes) {
+ if ((schemaNodes != null) && (typeBuilder != null)) {
+ for (DataSchemaNode schemaNode : schemaNodes) {
+ if (!schemaNode.isAugmenting()) {
+ addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
+ }
+ }
+ }
+ 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 node
+ * 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.
+ * @param childOf
+ * parent type
+ * @param module
+ * current module
+ */
+ private void addSchemaNodeToBuilderAsMethod(final String basePackageName, final DataSchemaNode node,
+ final GeneratedTypeBuilder typeBuilder, final GeneratedTypeBuilder childOf, final Module module) {
+ if (node != null && typeBuilder != null) {
+ if (node instanceof LeafSchemaNode) {
+ resolveLeafSchemaNodeAsMethod(typeBuilder, (LeafSchemaNode) node);
+ } else if (node instanceof LeafListSchemaNode) {
+ resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node);
+ } else if (node instanceof ContainerSchemaNode) {
+ containerToGenType(module, basePackageName, typeBuilder, childOf, (ContainerSchemaNode) node);
+ } else if (node instanceof ListSchemaNode) {
+ listToGenType(module, basePackageName, typeBuilder, childOf, (ListSchemaNode) node);
+ } else if (node instanceof ChoiceSchemaNode) {
+ choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) node);
+ } else {
+ // TODO: anyxml not yet supported
+ LOG.debug("Unable to add schema node {} as method in {}: unsupported type of node.", node.getClass(),
+ typeBuilder.getFullyQualifiedName());
+ }
+ }
+ }
+
+ /**
+ * 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 module
+ * current module
+ * @param basePackageName
+ * string with the module package name
+ * @param parent
+ * parent type
+ * @param choiceNode
+ * choice node which is mapped to generated type. Also child
+ * nodes - cases are mapped to generated types.
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>basePackageName</code> is null</li>
+ * <li>if <code>choiceNode</code> is null</li>
+ * </ul>
+ */
+ private void choiceToGeneratedType(final Module module, final String basePackageName,
+ final GeneratedTypeBuilder parent, final ChoiceSchemaNode choiceNode) {
+ checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
+ checkArgument(choiceNode != null, "Choice Schema Node cannot be NULL.");
+
+ if (!choiceNode.isAddedByUses()) {
+ final String packageName = packageNameForGeneratedType(basePackageName, choiceNode.getPath());
+ final GeneratedTypeBuilder choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
+ constructGetter(parent, choiceNode.getQName().getLocalName(), choiceNode.getDescription(),
+ choiceTypeBuilder);
+ choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class));
+ genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder);
+ generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode);
+ }
+ }
+
+ /**
+ * 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 module
+ * current module
+ * @param basePackageName
+ * string with the module package name
+ * @param refChoiceType
+ * type which represents superior <i>case</i>
+ * @param choiceNode
+ * choice case node which is mapped to generated type
+ * @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 void generateTypesFromChoiceCases(final Module module, final String basePackageName,
+ final Type refChoiceType, final ChoiceSchemaNode choiceNode) {
+ checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
+ checkArgument(refChoiceType != null, "Referenced Choice Type cannot be NULL.");
+ checkArgument(choiceNode != null, "ChoiceNode cannot be NULL.");
+
+ final Set<ChoiceCaseNode> caseNodes = choiceNode.getCases();
+ if (caseNodes == null) {
+ return;
+ }
+
+ for (ChoiceCaseNode caseNode : caseNodes) {
+ if (caseNode != null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
+ final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
+ final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
+ caseTypeBuilder.addImplementsType(refChoiceType);
+ genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
+ genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode);
+ final Iterable<DataSchemaNode> caseChildNodes = caseNode.getChildNodes();
+ if (caseChildNodes != null) {
+ final SchemaPath nodeSp = choiceNode.getPath();
+ final Object parentNode = findDataSchemaNode(schemaContext, nodeSp.getParent());
+
+ SchemaNode parent;
+ if (parentNode instanceof AugmentationSchema) {
+ final AugmentationSchema augSchema = (AugmentationSchema) parentNode;
+ final SchemaPath targetPath = augSchema.getTargetPath();
+ SchemaNode targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
+ if (targetSchemaNode instanceof DataSchemaNode
+ && ((DataSchemaNode) targetSchemaNode).isAddedByUses()) {
+ if (targetSchemaNode instanceof DerivableSchemaNode) {
+ targetSchemaNode = ((DerivableSchemaNode) targetSchemaNode).getOriginal().orNull();
+ }
+ if (targetSchemaNode == null) {
+ throw new IllegalStateException(
+ "Failed to find target node from grouping for augmentation " + augSchema
+ + " in module " + module.getName());
+ }
+ }
+ parent = targetSchemaNode;
+ } else {
+ final SchemaPath sp = choiceNode.getPath();
+ parent = findDataSchemaNode(schemaContext, sp.getParent());
+ }
+ Preconditions.checkState(parent != null, "Could not find Choice node parent "+choiceNode.getPath().getParent());
+ GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath());
+ if (childOfType == null) {
+ childOfType = findGroupingByPath(parent.getPath());
+ }
+ resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes);
+ }
+ }
+ processUsesAugments(caseNode, module);
+ }
+ }
+
+ /**
+ * Generates list of generated types for all the cases of a choice which are
+ * added to the choice through the augment.
+ *
+ * @param module
+ * current module
+ * @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 targetType
+ * Type which represents target choice
+ * @param targetNode
+ * node which represents target choice
+ * @param augmentedNodes
+ * 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> is null</li>
+ * <li>if <code>targetType</code> is null</li>
+ * <li>if <code>augmentedNodes</code> is null</li>
+ * </ul>
+ */
+ private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName,
+ final Type targetType, final ChoiceSchemaNode targetNode, final Iterable<DataSchemaNode> augmentedNodes) {
+ checkArgument(basePackageName != null, "Base Package Name cannot be NULL.");
+ checkArgument(targetType != null, "Referenced Choice Type cannot be NULL.");
+ checkArgument(augmentedNodes != null, "Set of Choice Case Nodes cannot be NULL.");
+
+ for (DataSchemaNode caseNode : augmentedNodes) {
+ if (caseNode != null) {
+ final String packageName = packageNameForGeneratedType(basePackageName, caseNode.getPath());
+ final GeneratedTypeBuilder caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode, module);
+ caseTypeBuilder.addImplementsType(targetType);
+
+ SchemaNode parent = null;
+ final SchemaPath nodeSp = targetNode.getPath();
+ parent = findDataSchemaNode(schemaContext, nodeSp.getParent());
+
+ GeneratedTypeBuilder childOfType = null;
+ if (parent instanceof Module) {
+ childOfType = genCtx.get(parent).getModuleNode();
+ } else if (parent instanceof ChoiceCaseNode) {
+ childOfType = findCaseByPath(parent.getPath());
+ } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
+ childOfType = findChildNodeByPath(parent.getPath());
+ } else if (parent instanceof GroupingDefinition) {
+ childOfType = findGroupingByPath(parent.getPath());
+ }
+
+ if (childOfType == null) {
+ throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
+ }
+
+ ChoiceCaseNode node = null;
+ if (caseNode instanceof ChoiceCaseNode) {
+ node = (ChoiceCaseNode) caseNode;
+ } else {
+ node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
+ }
+ final Iterable<DataSchemaNode> childNodes = node.getChildNodes();
+ if (childNodes != null) {
+ resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
+ }
+ genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder);
+ genCtx.get(module).addChoiceToCaseMapping(targetType, caseTypeBuilder, node);
+ }
+ }
+ }
+
+ /**
+ * 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 Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) {
+ Type returnType = null;
+ if ((leaf != null) && (typeBuilder != null)) {
+ final String leafName = leaf.getQName().getLocalName();
+ String leafDesc = leaf.getDescription();
+ if (leafDesc == null) {
+ leafDesc = "";
+ }
+
+ final Module parentModule = findParentModule(schemaContext, leaf);
+ if (leafName != null && !leaf.isAddedByUses()) {
+ final TypeDefinition<?> typeDef = leaf.getType();
+
+ GeneratedTOBuilder genTOBuilder;
+ if (typeDef instanceof EnumTypeDefinition) {
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
+ final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
+ final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(),
+ typeBuilder);
+
+ if (enumBuilder != null) {
+ returnType = enumBuilder.toInstance(typeBuilder);
+ }
+ ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType);
+ } else if (typeDef instanceof UnionType) {
+ genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
+ if (genTOBuilder != null) {
+ returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
+ }
+ } else if (typeDef instanceof BitsTypeDefinition) {
+ genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
+ if (genTOBuilder != null) {
+ returnType = genTOBuilder.toInstance();
+ }
+ } else {
+ final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
+ }
+ if (returnType != null) {
+ final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
+ processContextRefExtension(leaf, getter, parentModule);
+ }
+ }
+ }
+ return returnType;
+ }
+
+ private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter,
+ final Module module) {
+ for (UnknownSchemaNode node : leaf.getUnknownSchemaNodes()) {
+ final QName nodeType = node.getNodeType();
+ if ("context-reference".equals(nodeType.getLocalName())) {
+ final String nodeParam = node.getNodeParameter();
+ IdentitySchemaNode identity = null;
+ String basePackageName = null;
+ final Iterable<String> splittedElement = COLON_SPLITTER.split(nodeParam);
+ final Iterator<String> iterator = splittedElement.iterator();
+ final int length = Iterables.size(splittedElement);
+ if (length == 1) {
+ identity = findIdentityByName(module.getIdentities(), iterator.next());
+ basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
+ } else if (length == 2) {
+ String prefix = iterator.next();
+ final Module dependentModule = findModuleFromImports(module.getImports(), prefix);
+ if (dependentModule == null) {
+ throw new IllegalArgumentException("Failed to process context-reference: unknown prefix "
+ + prefix);
+ }
+ identity = findIdentityByName(dependentModule.getIdentities(), iterator.next());
+ basePackageName = BindingMapping.getRootPackageName(dependentModule.getQNameModule());
+ } else {
+ throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
+ + nodeParam);
+ }
+ if (identity == null) {
+ throw new IllegalArgumentException("Failed to process context-reference: unknown identity "
+ + nodeParam);
+ }
+
+ final Class<RoutingContext> clazz = RoutingContext.class;
+ final AnnotationTypeBuilder rc = getter.addAnnotation(clazz.getPackage().getName(),
+ clazz.getSimpleName());
+ final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
+ final String genTypeName = BindingMapping.getClassName(identity.getQName().getLocalName());
+ rc.addParameter("value", packageName + "." + genTypeName + ".class");
+ }
+ }
+ }
+
+ private IdentitySchemaNode findIdentityByName(final Set<IdentitySchemaNode> identities, final String name) {
+ for (IdentitySchemaNode id : identities) {
+ if (id.getQName().getLocalName().equals(name)) {
+ return id;
+ }
+ }
+ return null;
+ }
+
+ private Module findModuleFromImports(final Set<ModuleImport> imports, final String prefix) {
+ for (ModuleImport imp : imports) {
+ if (imp.getPrefix().equals(prefix)) {
+ return schemaContext.findModuleByName(imp.getModuleName(), imp.getRevision());
+ }
+ }
+ return null;
+ }
+
+ private boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
+ final boolean isReadOnly, final Module module) {
+ if ((leaf != null) && (toBuilder != null)) {
+ final String leafName = leaf.getQName().getLocalName();
+ String leafDesc = leaf.getDescription();
+ if (leafDesc == null) {
+ leafDesc = "";
+ }
+
+ if (leafName != null) {
+ Type returnType = null;
+ final TypeDefinition<?> typeDef = leaf.getType();
+ if (typeDef instanceof UnionTypeDefinition) {
+ // GeneratedType for this type definition should be already
+ // created
+ QName qname = typeDef.getQName();
+ Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(),
+ qname.getRevision());
+ final ModuleContext mc = genCtx.get(unionModule);
+ returnType = mc.getTypedefs().get(typeDef.getPath());
+ } else {
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
+ }
+ return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly);
+ }
+ }
+ 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 returnType
+ * property type
+ * @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 boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
+ final Type returnType, final boolean isReadOnly) {
+ if (returnType == null) {
+ return false;
+ }
+ final String leafName = leaf.getQName().getLocalName();
+ final String leafDesc = leaf.getDescription();
+ final GeneratedPropertyBuilder propBuilder = toBuilder.addProperty(BindingMapping.getPropertyName(leafName));
+ propBuilder.setReadOnly(isReadOnly);
+ propBuilder.setReturnType(returnType);
+ propBuilder.setComment(leafDesc);
+ toBuilder.addEqualsIdentity(propBuilder);
+ toBuilder.addHashIdentity(propBuilder);
+ toBuilder.addToStringProperty(propBuilder);
+ return true;
+ }
+
+ /**
+ * 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 boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node) {
+ if ((node != null) && (typeBuilder != null)) {
+ final QName nodeName = node.getQName();
+
+ if (nodeName != null && !node.isAddedByUses()) {
+ final TypeDefinition<?> typeDef = node.getType();
+ final Module parentModule = findParentModule(schemaContext, node);
+
+ Type returnType = null;
+ if (typeDef instanceof EnumTypeDefinition) {
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
+ final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef;
+ final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName,
+ typeBuilder);
+ returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName());
+ ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType);
+ } else if (typeDef instanceof UnionType) {
+ final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
+ if (genTOBuilder != null) {
+ returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule);
+ }
+ } else if (typeDef instanceof BitsTypeDefinition) {
+ final GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
+ returnType = genTOBuilder.toInstance();
+ } else {
+ final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
+ returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
+ }
+
+ final ParameterizedType listType = Types.listTypeFor(returnType);
+ constructGetter(typeBuilder, nodeName.getLocalName(), node.getDescription(), listType);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition<?> typeDef,
+ final GeneratedTypeBuilder typeBuilder, final Module parentModule) {
+ final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(),
+ genTOBuilder.getName());
+
+ returnType.setDescription(typeDef.getDescription());
+ returnType.setReference(typeDef.getReference());
+ returnType.setSchemaPath(typeDef.getPath().getPathFromRoot());
+ returnType.setModuleName(parentModule.getName());
+
+ genTOBuilder.setTypedef(true);
+ genTOBuilder.setIsUnion(true);
+ ((TypeProviderImpl) typeProvider).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
+
+ // union builder
+ final GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
+ genTOBuilder.getName() + "Builder");
+ unionBuilder.setIsUnionBuilder(true);
+ final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
+ method.setReturnType(returnType);
+ method.addParameter(Types.STRING, "defaultValue");
+ method.setAccessModifier(AccessModifier.PUBLIC);
+ method.setStatic(true);
+
+ final Set<Type> types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule);
+ if (types == null) {
+ ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule,
+ Sets.<Type> newHashSet(unionBuilder.toInstance()));
+ } else {
+ types.add(unionBuilder.toInstance());
+ }
+ return returnType.toInstance();
+ }
+
+ private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
+ final Module module) {
+ return addDefaultInterfaceDefinition(packageName, schemaNode, null, module);
+ }
+
+ /**
+ * 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
+ * @param parent
+ * parent type (can be null)
+ * @return generated type builder <code>schemaNode</code>
+ */
+ private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
+ final Type parent, final Module module) {
+ final GeneratedTypeBuilder it = addRawInterfaceDefinition(packageName, schemaNode, "");
+ if (parent == null) {
+ it.addImplementsType(DATA_OBJECT);
+ } else {
+ it.addImplementsType(BindingTypes.childOf(parent));
+ }
+ if (!(schemaNode instanceof GroupingDefinition)) {
+ it.addImplementsType(augmentable(it));
+ }
+
+ if (schemaNode instanceof DataNodeContainer) {
+ groupingsToGenTypes(module, ((DataNodeContainer) schemaNode).getGroupings());
+ addImplementedInterfaceFromUses((DataNodeContainer) schemaNode, it);
+ }
+
+ return it;
+ }
+
+ /**
+ * 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 GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final 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
+ * @param prefix
+ * return type name prefix
+ * @return generated type builder for <code>schemaNode</code>
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>schemaNode</code> is null</li>
+ * <li>if <code>packageName</code> is null</li>
+ * <li>if QName of schema node is null</li>
+ * <li>if schemaNode name is null</li>
+ * </ul>
+ *
+ */
+ private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode,
+ final String prefix) {
+ checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
+ checkArgument(packageName != null, "Package Name for Generated Type cannot be NULL.");
+ checkArgument(schemaNode.getQName() != null, "QName for Data Schema Node cannot be NULL.");
+ final String schemaNodeName = schemaNode.getQName().getLocalName();
+ checkArgument(schemaNodeName != null, "Local Name of QName for Data Schema Node cannot be NULL.");
+
+ String genTypeName;
+ if (prefix == null) {
+ genTypeName = BindingMapping.getClassName(schemaNodeName);
+ } else {
+ genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
+ }
+
+ // FIXME: Validation of name conflict
+ final GeneratedTypeBuilderImpl newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
+ final Module module = findParentModule(schemaContext, schemaNode);
+ qnameConstant(newType, BindingMapping.QNAME_STATIC_FIELD_NAME, schemaNode.getQName());
+ newType.addComment(schemaNode.getDescription());
+ newType.setDescription(createDescription(schemaNode, newType.getFullyQualifiedName()));
+ newType.setReference(schemaNode.getReference());
+ newType.setSchemaPath(schemaNode.getPath().getPathFromRoot());
+ newType.setModuleName(module.getName());
+
+ if (!genTypeBuilders.containsKey(packageName)) {
+ final Map<String, GeneratedTypeBuilder> builders = new HashMap<>();
+ builders.put(genTypeName, newType);
+ genTypeBuilders.put(packageName, builders);
+ } else {
+ final Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
+ if (!builders.containsKey(genTypeName)) {
+ builders.put(genTypeName, newType);
+ }
+ }
+ return newType;
+ }
+
+ /**
+ * Creates the name of the getter method name from <code>localName</code>.
+ *
+ * @param localName
+ * string with the name of the getter method
+ * @param returnType
+ * return type
+ * @return string with the name of the getter method for
+ * <code>methodName</code> in JAVA method format
+ */
+ public static String getterMethodName(final String localName, final Type returnType) {
+ final StringBuilder method = new StringBuilder();
+ if (BOOLEAN.equals(returnType)) {
+ method.append("is");
+ } else {
+ method.append("get");
+ }
+ String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName));
+ method.append(name);
+ 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 MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder,
+ final String schemaNodeName, final String comment, final Type returnType) {
+ final MethodSignatureBuilder getMethod = interfaceBuilder
+ .addMethod(getterMethodName(schemaNodeName, returnType));
+ getMethod.setComment(comment);
+ getMethod.setReturnType(returnType);
+ return getMethod;
+ }
+
+ /**
+ * 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
+ * @param module
+ * current module
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>if <code>schemaNode</code> equals null</li>
+ * <li>if <code>typeBuilder</code> equals null</li>
+ * </ul>
+ */
+ private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode,
+ final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List<String> listKeys,
+ final Module module) {
+ checkArgument(schemaNode != null, "Data Schema Node cannot be NULL.");
+ checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
+
+ if (schemaNode instanceof LeafSchemaNode) {
+ final LeafSchemaNode leaf = (LeafSchemaNode) schemaNode;
+ final String leafName = leaf.getQName().getLocalName();
+ final Type type = resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
+ if (listKeys.contains(leafName)) {
+ if (type == null) {
+ resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module);
+ } else {
+ resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, type, true);
+ }
+ }
+ } else if (!schemaNode.isAddedByUses()) {
+ if (schemaNode instanceof LeafListSchemaNode) {
+ resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) schemaNode);
+ } else if (schemaNode instanceof ContainerSchemaNode) {
+ containerToGenType(module, basePackageName, typeBuilder, typeBuilder, (ContainerSchemaNode) schemaNode);
+ } else if (schemaNode instanceof ChoiceSchemaNode) {
+ choiceToGeneratedType(module, basePackageName, typeBuilder, (ChoiceSchemaNode) schemaNode);
+ } else if (schemaNode instanceof ListSchemaNode) {
+ listToGenType(module, basePackageName, typeBuilder, typeBuilder, (ListSchemaNode) schemaNode);
+ }
+ }
+ }
+
+ private void typeBuildersToGenTypes(final Module module, final GeneratedTypeBuilder typeBuilder,
+ final GeneratedTOBuilder genTOBuilder) {
+ checkArgument(typeBuilder != null, "Generated Type Builder cannot be NULL.");
+
+ if (genTOBuilder != null) {
+ GeneratedTransferObject genTO = genTOBuilder.toInstance();
+ constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
+ genCtx.get(module).addGeneratedTOBuilder(genTOBuilder);
+ }
+ }
+
+ /**
+ * 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 List<String> listKeys(final ListSchemaNode list) {
+ final List<String> listKeys = new ArrayList<>();
+
+ List<QName> keyDefinition = list.getKeyDefinition();
+ if (keyDefinition != null) {
+ for (QName keyDef : keyDefinition) {
+ listKeys.add(keyDef.getLocalName());
+ }
+ }
+ 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 GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
+ GeneratedTOBuilder genTOBuilder = null;
+ if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
+ final String listName = list.getQName().getLocalName() + "Key";
+ final String genTOName = BindingMapping.getClassName(listName);
+ genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
+ }
+ 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
+ * @param leaf
+ * @return generated TO builder for <code>typeDef</code>
+ */
+ private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef,
+ final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) {
+ final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName());
+ final List<GeneratedTOBuilder> genTOBuilders = new ArrayList<>();
+ final String packageName = typeBuilder.getFullyQualifiedName();
+ if (typeDef instanceof UnionTypeDefinition) {
+ final List<GeneratedTOBuilder> types = ((TypeProviderImpl) typeProvider)
+ .provideGeneratedTOBuildersForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
+ classNameFromLeaf, leaf);
+ genTOBuilders.addAll(types);
+
+ GeneratedTOBuilder resultTOBuilder = null;
+ if (types.isEmpty()) {
+ throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef);
+ }
+ resultTOBuilder = types.remove(0);
+ for (GeneratedTOBuilder genTOBuilder : types) {
+ resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
+ }
+
+ final GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");
+ genPropBuilder.setReturnType(Types.CHAR_ARRAY);
+ resultTOBuilder.addEqualsIdentity(genPropBuilder);
+ resultTOBuilder.addHashIdentity(genPropBuilder);
+ resultTOBuilder.addToStringProperty(genPropBuilder);
+
+ } else if (typeDef instanceof BitsTypeDefinition) {
+ genTOBuilders.add((((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
+ packageName, typeDef, classNameFromLeaf, parentModule.getName()));
+ }
+ if (genTOBuilders != null && !genTOBuilders.isEmpty()) {
+ for (GeneratedTOBuilder 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 corresponding
+ * 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 GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer,
+ final GeneratedTypeBuilder builder) {
+ for (UsesNode usesNode : dataNodeContainer.getUses()) {
+ if (usesNode.getGroupingPath() != null) {
+ final GeneratedType genType = findGroupingByPath(usesNode.getGroupingPath()).toInstance();
+ if (genType == null) {
+ throw new IllegalStateException("Grouping " + usesNode.getGroupingPath() + "is not resolved for "
+ + builder.getName());
+ }
+
+ builder.addImplementsType(genType);
+ /*
+ builder.addComment(genType.getDescription());
+ builder.setDescription(genType.getDescription());
+ builder.setModuleName(genType.getModuleName());
+ builder.setReference(genType.getReference());
+ builder.setSchemaPath(genType.getSchemaPath());
+ */
+ }
+ }
+ return builder;
+ }
+
+ private boolean isNullOrEmpty(final Collection<?> list) {
+ return (list == null || list.isEmpty() ? true : false);
+ }
+
+ private String createDescription(final Set<? extends SchemaNode> schemaNodes, final String moduleName, final String moduleSourcePath) {
+ final StringBuilder sb = new StringBuilder();
+
+ if (!isNullOrEmpty(schemaNodes)) {
+ final SchemaNode node = schemaNodes.iterator().next();
+
+ if (node instanceof RpcDefinition) {
+ sb.append("Interface for implementing the following YANG RPCs defined in module <b>" + moduleName + "</b>");
+ } else if (node instanceof NotificationDefinition) {
+ sb.append("Interface for receiving the following YANG notifications defined in module <b>" + moduleName + "</b>");
+ }
+ }
+ sb.append(NEW_LINE);
+ sb.append("<br>(Source path: <i>");
+ sb.append(moduleSourcePath);
+ sb.append("</i>):");
+ sb.append(NEW_LINE);
+
+ if (verboseClassComments) {
+ sb.append("<pre>");
+ sb.append(NEW_LINE);
+ sb.append(YangTemplate.generateYangSnipet(schemaNodes));
+ sb.append("</pre>");
+ sb.append(NEW_LINE);
+ }
+
+ return sb.toString();
+ }
+
+ private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) {
+ final StringBuilder sb = new StringBuilder();
+ final String formattedDescription = YangTemplate.formatToParagraph(schemaNode.getDescription(), 0);
+
+ if (!isNullOrEmpty(formattedDescription)) {
+ sb.append(formattedDescription);
+ sb.append(NEW_LINE);
+ }
+
+ if (verboseClassComments) {
+ final Module module = findParentModule(schemaContext, schemaNode);
+ final StringBuilder linkToBuilderClass = new StringBuilder();
+ final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
+ String className = namespace[namespace.length - 1];
+
+ if (hasBuilderClass(schemaNode)) {
+ linkToBuilderClass.append(className);
+ linkToBuilderClass.append("Builder");
+ }
+
+ sb.append("<p>");
+ sb.append("This class represents the following YANG schema fragment defined in module <b>");
+ sb.append(module.getName());
+ sb.append("</b>");
+ sb.append(NEW_LINE);
+ sb.append("<br>(Source path: <i>");
+ sb.append(module.getModuleSourcePath());
+ sb.append("</i>):");
+ sb.append(NEW_LINE);
+ sb.append("<pre>");
+ sb.append(NEW_LINE);
+ sb.append(YangTemplate.generateYangSnipet(schemaNode));
+ sb.append("</pre>");
+ sb.append(NEW_LINE);
+ sb.append("The schema path to identify an instance is");
+ sb.append(NEW_LINE);
+ sb.append("<i>");
+ sb.append(YangTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot()));
+ sb.append("</i>");
+ sb.append(NEW_LINE);
+
+ if (hasBuilderClass(schemaNode)) {
+ sb.append(NEW_LINE);
+ sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
+ sb.append(NEW_LINE);
+ sb.append("@see ");
+ sb.append(linkToBuilderClass);
+ sb.append(NEW_LINE);
+ if (schemaNode instanceof ListSchemaNode) {
+ final List<QName> keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition();
+ if (keyDef != null && !keyDef.isEmpty()) {
+ sb.append("@see ");
+ sb.append(className);
+ sb.append("Key");
+ }
+ sb.append(NEW_LINE);
+ }
+ }
+ }
+
+ return sb.toString();
+ }
+
+ private boolean hasBuilderClass(final SchemaNode schemaNode) {
+ if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
+ schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
+ return true;
+ }
+ return false;
+ }
+
+ private boolean isNullOrEmpty(final String string) {
+ return (string == null || string.isEmpty() ? true : false);
+ }
+
+ private String createDescription(final Module module) {
+ final StringBuilder sb = new StringBuilder();
+ final String formattedDescription = YangTemplate.formatToParagraph(module.getDescription(), 0);
+
+ if (!isNullOrEmpty(formattedDescription)) {
+ sb.append(formattedDescription);
+ sb.append(NEW_LINE);
+ }
+
+ if (verboseClassComments) {
+ sb.append("<p>");
+ sb.append("This class represents the following YANG schema fragment defined in module <b>");
+ sb.append(module.getName());
+ sb.append("</b>");
+ sb.append(NEW_LINE);
+ sb.append("<br>Source path: <i>");
+ sb.append(module.getModuleSourcePath());
+ sb.append("</i>):");
+ sb.append(NEW_LINE);
+ sb.append("<pre>");
+ sb.append(NEW_LINE);
+ sb.append(YangTemplate.generateYangSnipet(module));
+ sb.append("</pre>");
+ }
+
+ return sb.toString();
+ }
+
+ private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) {
+ for (ModuleContext ctx : genCtx.values()) {
+ GeneratedTypeBuilder result = ctx.getChildNode(path);
+ if (result != null) {
+ return result;
+ }
+ }
+ return null;
+ }
+
+ private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) {
+ for (ModuleContext ctx : genCtx.values()) {
+ GeneratedTypeBuilder result = ctx.getGrouping(path);
+ if (result != null) {
+ return result;
+ }
+ }
+ return null;
+ }
+
+ private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) {
+ for (ModuleContext ctx : genCtx.values()) {
+ GeneratedTypeBuilder result = ctx.getCase(path);
+ if (result != null) {
+ return result;
+ }
+ }
+ return null;
+ }
+
+ public Map<Module, ModuleContext> getModuleContexts() {
+ return genCtx;
+ }
+
+}
Code Review / mdsal.git / blobdiff