X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-generator-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fgenerator%2Fimpl%2FBindingGeneratorImpl.java;h=4a7818b86494086fe3e801efb796d39548e7c11f;hb=480afab4e0a0eb8d64367c0bd12fa3ec892a3383;hp=f6bb3c5f630af4f8ab74ca573188cd5e77afd0c1;hpb=de43fdaa5adfeaa05324abaf3f47a9b1174b086a;p=mdsal.git diff --git a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/BindingGeneratorImpl.java b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/BindingGeneratorImpl.java index f6bb3c5f63..4a7818b864 100644 --- a/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/BindingGeneratorImpl.java +++ b/binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/BindingGeneratorImpl.java @@ -8,225 +8,36 @@ package org.opendaylight.mdsal.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.mdsal.binding.model.util.BindingGeneratorUtil.computeDefaultSUID; -import static org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil.encodeAngleBrackets; -import static org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil.packageNameForAugmentedGeneratedType; -import static org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil.packageNameForGeneratedType; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.DATA_OBJECT; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.DATA_ROOT; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.IDENTIFIABLE; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.IDENTIFIER; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.NOTIFICATION; -import static org.opendaylight.mdsal.binding.model.util.BindingTypes.augmentable; -import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN; -import static org.opendaylight.mdsal.binding.model.util.Types.FUTURE; -import static org.opendaylight.mdsal.binding.model.util.Types.VOID; -import static org.opendaylight.mdsal.binding.model.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.annotations.VisibleForTesting; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; -import com.google.common.base.Splitter; -import com.google.common.base.Strings; -import com.google.common.collect.Iterables; -import com.google.common.collect.Sets; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Comparator; -import java.util.HashMap; -import java.util.Iterator; +import java.util.IdentityHashMap; import java.util.List; import java.util.Map; import java.util.Set; -import java.util.regex.Pattern; import org.opendaylight.mdsal.binding.generator.api.BindingGenerator; -import org.opendaylight.mdsal.binding.generator.spi.TypeProvider; -import org.opendaylight.mdsal.binding.model.api.AccessModifier; -import org.opendaylight.mdsal.binding.model.api.Constant; -import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject; -import org.opendaylight.mdsal.binding.model.api.GeneratedType; -import org.opendaylight.mdsal.binding.model.api.ParameterizedType; -import org.opendaylight.mdsal.binding.model.api.Restrictions; +import org.opendaylight.mdsal.binding.generator.api.BindingRuntimeGenerator; +import org.opendaylight.mdsal.binding.generator.api.BindingRuntimeTypes; +import org.opendaylight.mdsal.binding.model.api.JavaTypeName; import org.opendaylight.mdsal.binding.model.api.Type; -import org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder; -import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder; -import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder; -import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder; -import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder; -import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase; -import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder; -import org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil; -import org.opendaylight.mdsal.binding.model.util.BindingTypes; -import org.opendaylight.mdsal.binding.model.util.ReferencedTypeImpl; -import org.opendaylight.mdsal.binding.model.util.Types; -import org.opendaylight.mdsal.binding.model.util.generated.type.builder.GeneratedPropertyBuilderImpl; -import org.opendaylight.mdsal.binding.model.util.generated.type.builder.GeneratedTOBuilderImpl; -import org.opendaylight.mdsal.binding.model.util.generated.type.builder.GeneratedTypeBuilderImpl; -import org.opendaylight.mdsal.binding.yang.types.GroupingDefinitionDependencySort; -import org.opendaylight.mdsal.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.Status; 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.meta.EffectiveStatement; -import org.opendaylight.yangtools.yang.model.api.meta.StatementSource; -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.ModuleDependencySort; -import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil; -import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils; -import org.opendaylight.yangtools.yang.model.util.type.CompatUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -public class BindingGeneratorImpl implements BindingGenerator { +public class BindingGeneratorImpl implements BindingGenerator, BindingRuntimeGenerator { 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'; /** - * Comparator based on augment target path. - */ - private static final Comparator AUGMENT_COMP = (o1, o2) -> { - final Iterator thisIt = o1.getTargetPath().getPathFromRoot().iterator(); - final Iterator otherIt = o2.getTargetPath().getPathFromRoot().iterator(); - - while (thisIt.hasNext()) { - if (!otherIt.hasNext()) { - return 1; - } - - final int comp = thisIt.next().compareTo(otherIt.next()); - if (comp != 0) { - return comp; - } - } - - return otherIt.hasNext() ? -1 : 0; - }; - - /** - * 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 static final Pattern UNICODE_CHAR_PATTERN = Pattern.compile("\\\\+u"); - - private final Map 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> 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. - * - * @param verboseClassComments generate verbose comments - */ - public BindingGeneratorImpl(final boolean verboseClassComments) { - this.verboseClassComments = verboseClassComments; - } - - /** - * Resolves generated types from context 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 GeneratedType - * GeneratedTransferObjectwhich are generated from - * context data. - * @throws IllegalArgumentException - * if arg context is null - * @throws IllegalStateException - * if context contain no modules - */ - @Override - public List 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; - final Set modules = context.getModules(); - return generateTypes(context, modules); - } - - /** - * Resolves generated types from context schema nodes only for - * modules specified in modules + * Resolves generated types from context schema nodes only for modules specified + * in modules. Generated types are created for modules, groupings, types, containers, lists, choices, + * augments, rpcs, notification, identities. * - * 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 + * @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 GeneratedType or * GeneratedTransferObject) which: *
    @@ -244,2016 +55,60 @@ public class BindingGeneratorImpl implements BindingGenerator { */ @Override public List generateTypes(final SchemaContext context, final Set modules) { - checkArgument(context != null, "Schema Context reference cannot be NULL."); - checkState(context.getModules() != null, "Schema Context does not contain defined modules."); + checkContext(context); checkArgument(modules != null, "Set of Modules cannot be NULL."); - schemaContext = context; - typeProvider = new TypeProviderImpl(context); - final List contextModules = ModuleDependencySort.sort(context.getModules()); - genTypeBuilders = new HashMap<>(); - - for (final Module contextModule : contextModules) { - moduleToGenTypes(contextModule, context); - } - for (final Module contextModule : contextModules) { - allAugmentsToGenTypes(contextModule); - } - - final List filteredGenTypes = new ArrayList<>(); - for (final Module m : modules) { - final ModuleContext ctx = checkNotNull(genCtx.get(m), "Module context not found for module %s", m); - filteredGenTypes.addAll(ctx.getGeneratedTypes()); - final Set 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 - * Type objects. - * - * @param module - * module from which is obtained set of type definitions - * @throws IllegalArgumentException - *
      - *
    • if module is null
      • - *
    • if name of module is null
      • - *
    - * @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> typeDefinitions = it.allTypedefs(); - checkState(typeDefinitions != null, "Type Definitions for module «module.name» cannot be NULL."); - - for (final 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()); - annotateDeprecatedIfNecessary(node.getStatus(), genType); - 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, node.getStatus()); - 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), node.getStatus()); - - final List 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 (final 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 (final UsesNode usesNode : node.getUses()) { - for (final AugmentationSchema augment : usesNode.getAugmentations()) { - usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node); - processUsesAugments(augment, module); - } - } - } - - /** - * Converts all augmentation of the module to the list - * Type objects. - * - * @param module - * module from which is obtained list of all augmentation objects - * to iterate over them - * @throws IllegalArgumentException - *
      - *
    • if the module is null
      • - *
    • if the name of module is null
      • - *
    - * @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 augmentations = resolveAugmentations(module); - for (final AugmentationSchema augment : augmentations) { - augmentationToGenTypes(basePackageName, augment, module); - } - } - - /** - * Returns list of AugmentationSchema 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 AugmentationSchema objects obtained - * from module - * @throws IllegalArgumentException - * if module is null - * @throws IllegalStateException - * if set of module augmentations is null - */ - private static List resolveAugmentations(final Module module) { - checkArgument(module != null, "Module reference cannot be NULL."); - checkState(module.getAugmentations() != null, "Augmentations Set cannot be NULL."); - - final Set augmentations = module.getAugmentations(); - final List sortedAugmentations = new ArrayList<>(augmentations); - sortedAugmentations.sort(AUGMENT_COMP); - - return sortedAugmentations; - } - - /** - * Create GeneratedTypeBuilder object from module argument. - * - * @param module - * Module object from which builder will be created - * @return GeneratedTypeBuilder 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 rpcs inputs and outputs substatements of the module - * to the list of Type 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 - *
      - *
    • if the module is null
      • - *
    • if the name of module is null
      • - *
    - * @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 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())); - - for (final RpcDefinition rpc : rpcDefinitions) { - if (rpc != null) { - final String rpcName = BindingMapping.getClassName(rpc.getQName()); - final String rpcMethodName = BindingMapping.getPropertyName(rpcName); - final String rpcComment = encodeAngleBrackets(rpc.getDescription()); - final MethodSignatureBuilder method = interfaceBuilder.addMethod(rpcMethodName); - final ContainerSchemaNode input = rpc.getInput(); - final ContainerSchemaNode output = rpc.getOutput(); - - // Do not refer to annotation class, as it may not be available at runtime - method.addAnnotation("javax.annotation", "CheckReturnValue"); - - //in case of implicit RPC input (StatementSource.CONTEXT), - // stay compatible (no input argument generated) - if (input != null && isExplicitStatement(input)) { - final GeneratedTypeBuilder inType = addRawInterfaceDefinition(basePackageName, input, rpcName); - addImplementedInterfaceFromUses(input, inType); - inType.addImplementsType(DATA_OBJECT); - inType.addImplementsType(augmentable(inType)); - annotateDeprecatedIfNecessary(rpc.getStatus(), 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; - //in case of implicit RPC output (StatementSource.CONTEXT), - //stay compatible (Future> return type generated) - if (output != null && isExplicitStatement(output)) { - final GeneratedTypeBuilder outType = addRawInterfaceDefinition(basePackageName, output, rpcName); - addImplementedInterfaceFromUses(output, outType); - outType.addImplementsType(DATA_OBJECT); - outType.addImplementsType(augmentable(outType)); - annotateDeprecatedIfNecessary(rpc.getStatus(), 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); - } - - private static boolean isExplicitStatement(final ContainerSchemaNode node) { - return node instanceof EffectiveStatement - && ((EffectiveStatement) node).getDeclared().getStatementSource() == StatementSource.DECLARATION; - } - - /** - * Converts all notifications of the module to the list of - * Type 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 - *
      - *
    • if the module equals null
      • - *
    • if the name of module equals null
      • - *
    - * @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 notifications = module.getNotifications(); - if (notifications.isEmpty()) { - return; - } - - final GeneratedTypeBuilder listenerInterface = moduleTypeBuilder(module, "Listener"); - listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER); - final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule()); - - - - for (final NotificationDefinition notification : notifications) { - if (notification != null) { - processUsesAugments(notification, module); - - final GeneratedTypeBuilder notificationInterface = addDefaultInterfaceDefinition(basePackageName, - notification, null, module); - annotateDeprecatedIfNecessary(notification.getStatus(), notificationInterface); - 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(encodeAngleBrackets(notification.getDescription())).setReturnType(Types.VOID); + final Map renames = new IdentityHashMap<>(); + for (;;) { + try { + return new CodegenTypeGenerator(context, renames).toTypes(modules); + } catch (RenameMappingException e) { + rename(renames, e); } } - listenerInterface.setDescription(createDescription(notifications, module.getName())); - - genCtx.get(module).addTopLevelNodeType(listenerInterface); } - /** - * Converts all identities of the module to the list of - * Type 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 BindingGeneratorImpl#identityToGenType} - * - */ - private void allIdentitiesToGenTypes(final Module module, final SchemaContext context) { - final Set schemaIdentities = module.getIdentities(); - final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule()); + @Override + public BindingRuntimeTypes generateTypeMapping(final SchemaContext context) { + checkContext(context); - if (schemaIdentities != null && !schemaIdentities.isEmpty()) { - for (final IdentitySchemaNode identity : schemaIdentities) { - identityToGenType(module, basePackageName, identity, context); + final Map renames = new IdentityHashMap<>(); + for (;;) { + try { + return new RuntimeTypeGenerator(context, renames).toTypeMapping(); + } catch (RenameMappingException e) { + rename(renames, e); } } } - /** - * Converts the identity 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.IdentitySchemaNode - * 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) { - return toBuilder.addConstant(typeForClass(QName.class), constantName, name); - } - - /** - * Converts all groupings of the module to the list of - * Type 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 ModuleContext#groupings allGroupings} - * - * @param module - * current module - * @param groupings - * collection of groupings from which types will be generated - * - */ - private void groupingsToGenTypes(final Module module, final Collection groupings) { - final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule()); - final List groupingsSortedByDependencies = new GroupingDefinitionDependencySort() - .sort(groupings); - for (final 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 - */ - 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); - annotateDeprecatedIfNecessary(grouping.getStatus(), genType); - 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 enumTypeDef to - * typeBuilder. - * - * Each enumTypeDef 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 - * @param module - * Module in which type should be generated - * @return enumeration builder which contains data from - * enumTypeDef - */ - private EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName, - final GeneratedTypeBuilder typeBuilder, final Module module) { - if (enumTypeDef != null && typeBuilder != null && enumTypeDef.getQName().getLocalName() != null) { - final String enumerationName = BindingMapping.getClassName(enumName); - final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName); - final String enumTypedefDescription = encodeAngleBrackets(enumTypeDef.getDescription()); - enumBuilder.setDescription(enumTypedefDescription); - enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef); - ModuleContext ctx = genCtx.get(module); - ctx.addInnerTypedefType(enumTypeDef.getPath(), enumBuilder); - return enumBuilder; - } - return null; - } - - /** - * Generates type builder for module. - * - * @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 - * module. - * @throws IllegalArgumentException - * if module 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 augSchema to list of Type which - * contains generated type for augmentation. In addition there are also - * generated types for all containers, list and choices which are child of - * augSchema 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 - * @throws IllegalArgumentException - *
      - *
    • if augmentPackageName equals null
      • - *
    • if augSchema equals null
      • - *
    - * @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)) { - final Type targetType = new ReferencedTypeImpl(targetTypeBuilder.getPackageName(), - targetTypeBuilder.getName()); - addRawAugmentGenTypeDefinition(module, augmentPackageName, augmentPackageName, targetType, augSchema); - - } else { - generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(), - (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), null); - } + private static void checkContext(final SchemaContext context) { + checkArgument(context != null, "Schema Context reference cannot be NULL."); + checkState(context.getModules() != null, "Schema Context does not contain defined modules."); } - 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(); - final 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); + private static void rename(final Map renames, final RenameMappingException ex) { + final JavaTypeName name = ex.getName(); + final SchemaNode def = ex.getDefinition(); + final JavaTypeName existing = renames.get(def); + if (existing != null) { + throw new IllegalStateException("Attempted to relocate " + def + " to " + name + ", already remapped to " + + existing, ex); } - if (!(targetSchemaNode instanceof ChoiceSchemaNode)) { - String packageName = augmentPackageName; - if (usesNodeParent instanceof SchemaNode) { - packageName = packageNameForAugmentedGeneratedType(augmentPackageName, ((SchemaNode) usesNodeParent).getPath()); - } - addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName, targetTypeBuilder.toInstance(), - augSchema); + final String suffix; + if (def instanceof IdentitySchemaNode) { + suffix = "$I"; + } else if (def instanceof GroupingDefinition) { + suffix = "$G"; + } else if (def instanceof TypeDefinition) { + suffix = "$T"; } else { - generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance(), - (ChoiceSchemaNode) targetSchemaNode, augSchema.getChildNodes(), usesNodeParent); - } - } - - /** - * 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) { - final SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.getGroupingPath() - .getPathFromRoot()); - if (!(targetGrouping instanceof GroupingDefinition)) { - throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode); - } - - SchemaNode result = targetGrouping; - for (final QName node : targetPath.getPathFromRoot()) { - if (result instanceof DataNodeContainer) { - final QName resultNode = QName.create(result.getQName().getModule(), node.getLocalName()); - result = ((DataNodeContainer) result).getDataChildByName(resultNode); - } else if (result instanceof ChoiceSchemaNode) { - result = ((ChoiceSchemaNode) result).getCaseNodeByName(node.getLocalName()); - } - } - if (result == null) { - return null; - } - - if (result instanceof DerivableSchemaNode) { - DerivableSchemaNode castedResult = (DerivableSchemaNode) result; - Optional originalNode = castedResult - .getOriginal(); - if (castedResult.isAddedByUses() && originalNode.isPresent()) { - result = originalNode.get(); - } - } - - if (result instanceof DataSchemaNode) { - DataSchemaNode resultDataSchemaNode = (DataSchemaNode) result; - if (resultDataSchemaNode.isAddedByUses()) { - // The original node is required, but we have only the copy of - // the original node. - // Maybe this indicates a bug in Yang parser. - throw new IllegalStateException("Failed to generate code for augment in " + parentUsesNode); - } - - return resultDataSchemaNode; - } - - throw new IllegalStateException( - "Target node of uses-augment statement must be DataSchemaNode. Failed to generate code for augment in " - + parentUsesNode); - } - - /** - * 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 augmentBuilders = genTypeBuilders.get(augmentPackageName); - if (augmentBuilders == null) { - augmentBuilders = new HashMap<>(); - genTypeBuilders.put(augmentPackageName, augmentBuilders); + throw new IllegalStateException("Unhandled remapping of " + def + " at " + name, ex); } - 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)); - annotateDeprecatedIfNecessary(augSchema.getStatus(), augTypeBuilder); - addImplementedInterfaceFromUses(augSchema, augTypeBuilder); - - augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.getChildNodes()); - augmentBuilders.put(augTypeName, augTypeBuilder); - - if (!augSchema.getChildNodes().isEmpty()) { - genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema); - - } - genCtx.get(module).addAugmentType(augTypeBuilder); - return augTypeBuilder; - } - - /** - * - * @param unknownSchemaNodes - * @return nodeParameter of UnknownSchemaNode - */ - private static String getAugmentIdentifier(final List unknownSchemaNodes) { - for (final 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 static String augGenTypeName(final Map 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 typeBuilder which represent subnodes of - * node for which typeBuilder 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 typeBuilder 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 typeBuilder 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 schemaNodes) { - if (schemaNodes != null && parent != null) { - for (final DataSchemaNode schemaNode : schemaNodes) { - if (!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) { - addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module); - } - } - } - return parent; - } - - /** - * Adds the methods to typeBuilder what represents subnodes of - * node for which typeBuilder 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 typeBuilder 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 typeBuilder was created - * @return generated type builder which is the same object as the input - * parameter typeBuilder. 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 schemaNodes) { - if (schemaNodes != null && typeBuilder != null) { - for (final DataSchemaNode schemaNode : schemaNodes) { - if (!schemaNode.isAugmenting()) { - addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module); - } - } - } - return typeBuilder; - } - - /** - * Adds to typeBuilder a method which is derived from - * schemaNode. - * - * @param basePackageName - * string with the module package name - * @param node - * data schema node which is added to typeBuilder as - * a method - * @param typeBuilder - * generated type builder to which is schemaNode - * 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, module); - } else if (node instanceof LeafListSchemaNode) { - resolveLeafListSchemaNode(typeBuilder, (LeafListSchemaNode) node,module); - } 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 choiceNode 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 (basePackageName) 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 - *
      - *
    • if basePackageName is null
      • - *
    • if choiceNode is null
      • - *
    - */ - 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, choiceNode.getStatus()); - choiceTypeBuilder.addImplementsType(typeForClass(DataContainer.class)); - annotateDeprecatedIfNecessary(choiceNode.getStatus(), choiceTypeBuilder); - genCtx.get(module).addChildNodeType(choiceNode, choiceTypeBuilder); - generateTypesFromChoiceCases(module, basePackageName, choiceTypeBuilder.toInstance(), choiceNode); - } - } - - /** - * Converts caseNodes set to list of corresponding generated - * types. - * - * For every case which isn't added through augment or uses is - * created generated type builder. The package names for the builder is - * created as concatenation of the module package ( - * basePackageName) and names of all parents nodes of the - * concrete case. There is also relation "implements type" - * between every case builder and choice type - * - * @param module - * current module - * @param basePackageName - * string with the module package name - * @param refChoiceType - * type which represents superior case - * @param choiceNode - * choice case node which is mapped to generated type - * @throws IllegalArgumentException - *
      - *
    • if basePackageName equals null
      • - *
    • if refChoiceType equals null
      • - *
    • if caseNodes equals null
      • - *
    - */ - 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 caseNodes = choiceNode.getCases(); - if (caseNodes == null) { - return; - } - - for (final 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); - annotateDeprecatedIfNecessary(caseNode.getStatus(), caseTypeBuilder); - genCtx.get(module).addCaseType(caseNode.getPath(), caseTypeBuilder); - genCtx.get(module).addChoiceToCaseMapping(refChoiceType, caseTypeBuilder, caseNode); - final Iterable caseChildNodes = caseNode.getChildNodes(); - if (caseChildNodes != null) { - final SchemaPath choiceNodeParentPath = choiceNode.getPath().getParent(); - - if (!Iterables.isEmpty(choiceNodeParentPath.getPathFromRoot())) { - SchemaNode parent = findDataSchemaNode(schemaContext, choiceNodeParentPath); - - if (parent instanceof AugmentationSchema) { - final AugmentationSchema augSchema = (AugmentationSchema) parent; - 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; - } - - Preconditions.checkState(parent != null, "Could not find Choice node parent %s", - choiceNodeParentPath); - GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.getPath()); - if (childOfType == null) { - childOfType = findGroupingByPath(parent.getPath()); - } - resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes); - } else { - resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, moduleToDataType(module), - 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 - * @throws IllegalArgumentException - *
      - *
    • if basePackageName is null
      • - *
    • if targetType is null
      • - *
    • if augmentedNodes is null
      • - *
    - */ - private void generateTypesFromAugmentedChoiceCases(final Module module, final String basePackageName, - final Type targetType, final ChoiceSchemaNode targetNode, final Iterable augmentedNodes, - final DataNodeContainer usesNodeParent) { - 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 (final 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; - 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; - final String caseLocalName = caseNode.getQName().getLocalName(); - if (caseNode instanceof ChoiceCaseNode) { - node = (ChoiceCaseNode) caseNode; - } else if (targetNode.getCaseNodeByName(caseLocalName) == null) { - final String targetNodeLocalName = targetNode.getQName().getLocalName(); - for (DataSchemaNode dataSchemaNode : usesNodeParent.getChildNodes()) { - if (dataSchemaNode instanceof ChoiceSchemaNode && targetNodeLocalName.equals(dataSchemaNode.getQName - ().getLocalName())) { - node = ((ChoiceSchemaNode) dataSchemaNode).getCaseNodeByName(caseLocalName); - break; - } - } - } else { - node = targetNode.getCaseNodeByName(caseLocalName); - } - final Iterable 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); - } - } - } - - private static boolean isInnerType(final LeafSchemaNode leaf, final TypeDefinition type) { - // New parser with encapsulated type - if (leaf.getPath().equals(type.getPath())) { - return true; - } - - // Embedded type definition with new parser. Also takes care of the old parser with bits - if (leaf.getPath().equals(type.getPath().getParent())) { - return true; - } - - return false; - } - - /** - * Converts leaf to the getter method which is added to - * typeBuilder. - * - * @param typeBuilder - * generated type builder to which is added getter method as - * leaf mapping - * @param leaf - * leaf schema node which is mapped as getter method which is - * added to typeBuilder - * @param module - * Module in which type was defined - * @return boolean value - *
      - *
    • false - if leaf or typeBuilder are - * null
      • - *
    • true - in other cases
      • - *
    - */ - private Type resolveLeafSchemaNodeAsMethod(final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf, final Module module) { - if (leaf == null || typeBuilder == null || leaf.isAddedByUses()) { - return null; - } - - final String leafName = leaf.getQName().getLocalName(); - if (leafName == null) { - return null; - } - - final Module parentModule = findParentModule(schemaContext, leaf); - Type returnType = null; - - final TypeDefinition typeDef = CompatUtils.compatLeafType(leaf); - if (isInnerType(leaf, typeDef)) { - if (typeDef instanceof EnumTypeDefinition) { - returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf); - final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef; - final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.getQName(), - typeBuilder, module); - if (enumBuilder != null) { - returnType = enumBuilder.toInstance(typeBuilder); - } - ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType); - } else if (typeDef instanceof UnionTypeDefinition) { - GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule); - if (genTOBuilder != null) { - returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule); - } - } else if (typeDef instanceof BitsTypeDefinition) { - GeneratedTOBuilder genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule); - if (genTOBuilder != null) { - returnType = genTOBuilder.toInstance(); - } - } else { - // It is constrained version of already declared type (inner declared type exists, - // onlyfor special cases (Enum, Union, Bits), which were already checked. - // In order to get proper class we need to look up closest derived type - // and apply restrictions from leaf type - final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef); - returnType = typeProvider.javaTypeForSchemaDefinitionType(getBaseOrDeclaredType(typeDef), leaf, - restrictions); - } - } else { - final Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef); - returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions); - } - - if (returnType == null) { - return null; - } - - if (typeDef instanceof EnumTypeDefinition) { - ((TypeProviderImpl) typeProvider).putReferencedType(leaf.getPath(), returnType); - } - - String leafDesc = leaf.getDescription(); - if (leafDesc == null) { - leafDesc = ""; - } - - final MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType, leaf.getStatus()); - processContextRefExtension(leaf, getter, parentModule); - return returnType; - } - - private static TypeDefinition getBaseOrDeclaredType(final TypeDefinition typeDef) { - // Returns DerivedType in case of new parser. - final TypeDefinition baseType = typeDef.getBaseType(); - return baseType != null && baseType.getBaseType() != null ? baseType : typeDef; - } - - private void processContextRefExtension(final LeafSchemaNode leaf, final MethodSignatureBuilder getter, - final Module module) { - for (final 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 splittedElement = COLON_SPLITTER.split(nodeParam); - final Iterator 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) { - final 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 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 static IdentitySchemaNode findIdentityByName(final Set identities, final String name) { - for (final IdentitySchemaNode id : identities) { - if (id.getQName().getLocalName().equals(name)) { - return id; - } - } - return null; - } - - private Module findModuleFromImports(final Set imports, final String prefix) { - for (final 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) { - Type returnType; - final TypeDefinition typeDef = CompatUtils.compatLeafType(leaf); - if (typeDef instanceof UnionTypeDefinition) { - // GeneratedType for this type definition should be already - // created - final QName qname = typeDef.getQName(); - final Module unionModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(), - qname.getRevision()); - final ModuleContext mc = genCtx.get(unionModule); - returnType = mc.getTypedefs().get(typeDef.getPath()); - } else if (typeDef instanceof EnumTypeDefinition && typeDef.getBaseType() == null) { - // Annonymous enumeration (already generated, since it is inherited via uses). - LeafSchemaNode originalLeaf = (LeafSchemaNode) SchemaNodeUtils.getRootOriginalIfPossible(leaf); - QName qname = originalLeaf.getQName(); - final Module enumModule = schemaContext.findModuleByNamespaceAndRevision(qname.getNamespace(), - qname.getRevision()); - returnType = genCtx.get(enumModule).getInnerType(originalLeaf.getType().getPath()); - } else { - returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf); - } - return resolveLeafSchemaNodeAsProperty(toBuilder, leaf, returnType, isReadOnly); - } - return false; - } - - /** - * Converts leaf schema node to property of generated TO - * builder. - * - * @param toBuilder - * generated TO builder to which is leaf added as - * property - * @param leaf - * leaf schema node which is added to toBuilder as - * property - * @param returnType - * property type - * @param isReadOnly - * boolean value which says if leaf property is|isn't read only - * @return boolean value - *
      - *
    • false - if leaf, toBuilder or leaf - * name equals null or if leaf is added by uses.
      • - *
    • true - other cases
      • - *
    - */ - private static 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 = encodeAngleBrackets(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 node leaf list schema node to getter method of - * typeBuilder. - * - * @param typeBuilder - * generated type builder to which is node added as - * getter method - * @param node - * leaf list schema node which is added to - * typeBuilder as getter method - * @param module module - * @return boolean value - *
      - *
    • true - if node, typeBuilder, - * nodeName equal null or node is added by uses
      • - *
    • false - other cases
      • - *
    - */ - private boolean resolveLeafListSchemaNode(final GeneratedTypeBuilder typeBuilder, final LeafListSchemaNode node, final Module module) { - if (node == null || typeBuilder == null || node.isAddedByUses()) { - return false; - } - - final QName nodeName = node.getQName(); - - final TypeDefinition typeDef = node.getType(); - final Module parentModule = findParentModule(schemaContext, node); - - Type returnType = null; - if (typeDef.getBaseType() == null) { - if (typeDef instanceof EnumTypeDefinition) { - returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node); - final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) typeDef; - final EnumBuilder enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, - typeBuilder,module); - returnType = new ReferencedTypeImpl(enumBuilder.getPackageName(), enumBuilder.getName()); - ((TypeProviderImpl) typeProvider).putReferencedType(node.getPath(), returnType); - } else if (typeDef instanceof UnionTypeDefinition) { - 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); - } - } 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, node.getStatus()); - return true; - } - - private Type createReturnTypeForUnion(final GeneratedTOBuilder genTOBuilder, final TypeDefinition typeDef, - final GeneratedTypeBuilder typeBuilder, final Module parentModule) { - final GeneratedTOBuilderImpl returnType = new GeneratedTOBuilderImpl(genTOBuilder.getPackageName(), - genTOBuilder.getName()); - final String typedefDescription = encodeAngleBrackets(typeDef.getDescription()); - - returnType.setDescription(typedefDescription); - returnType.setReference(typeDef.getReference()); - returnType.setSchemaPath(typeDef.getPath().getPathFromRoot()); - returnType.setModuleName(parentModule.getName()); - - genTOBuilder.setTypedef(true); - genTOBuilder.setIsUnion(true); - TypeProviderImpl.addUnitsToGenTO(genTOBuilder, typeDef.getUnits()); - - - - final GeneratedTOBuilder unionBuilder = createUnionBuilder(genTOBuilder,typeBuilder); - - - final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance"); - method.setReturnType(returnType); - method.addParameter(Types.STRING, "defaultValue"); - method.setAccessModifier(AccessModifier.PUBLIC); - method.setStatic(true); - - final Set types = ((TypeProviderImpl) typeProvider).getAdditionalTypes().get(parentModule); - if (types == null) { - ((TypeProviderImpl) typeProvider).getAdditionalTypes().put(parentModule, - Sets.newHashSet(unionBuilder.toInstance())); - } else { - types.add(unionBuilder.toInstance()); - } - return returnType.toInstance(); - } - - private static GeneratedTOBuilder createUnionBuilder(final GeneratedTOBuilder genTOBuilder, final GeneratedTypeBuilder typeBuilder) { - final String outerCls = Types.getOuterClassName(genTOBuilder); - final StringBuilder name; - if (outerCls != null) { - name = new StringBuilder(outerCls); - } else { - name = new StringBuilder(); - } - name.append(genTOBuilder.getName()); - name.append("Builder"); - final GeneratedTOBuilderImpl unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),name.toString()); - unionBuilder.setIsUnionBuilder(true); - return unionBuilder; - } - - private GeneratedTypeBuilder addDefaultInterfaceDefinition(final String packageName, final SchemaNode schemaNode, - final Module module) { - return addDefaultInterfaceDefinition(packageName, schemaNode, null, module); - } - - /** - * Instantiates generated type builder with packageName and - * schemaNode. - * - * The new builder always implements - * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.
    - * If schemaNode is instance of GroupingDefinition it also - * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable - * Augmentable}.
    - * If schemaNode is instance of - * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer - * DataNodeContainer} it can also implement nodes which are specified in - * uses. - * - * @param packageName - * string with the name of the package to which - * schemaNode belongs. - * @param schemaNode - * schema node for which is created generated type builder - * @param parent - * parent type (can be null) - * @return generated type builder schemaNode - */ - 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 schemaNode - */ - private GeneratedTypeBuilder addRawInterfaceDefinition(final String packageName, final SchemaNode schemaNode) { - return addRawInterfaceDefinition(packageName, schemaNode, ""); - } - - /** - * Returns reference to generated type builder for specified - * schemaNode with packageName. - * - * Firstly the generated type builder is searched in - * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't - * found it is created and added to genTypeBuilders. - * - * @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 schemaNode - * @throws IllegalArgumentException - *
      - *
    • if schemaNode is null
      • - *
    • if packageName is null
      • - *
    • if QName of schema node is null
      • - *
    • if schemaNode name is null
      • - *
    - * - */ - 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 builders = new HashMap<>(); - builders.put(genTypeName, newType); - genTypeBuilders.put(packageName, builders); - } else { - final Map builders = genTypeBuilders.get(packageName); - if (!builders.containsKey(genTypeName)) { - builders.put(genTypeName, newType); - } - } - return newType; - } - - /** - * Creates the name of the getter method name from localName. - * - * @param localName - * string with the name of the getter method - * @param returnType - * return type - * @return string with the name of the getter method for - * methodName 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"); - } - final String name = BindingMapping.toFirstUpper(BindingMapping.getPropertyName(localName)); - method.append(name); - return method.toString(); - } - - /** - * Created a method signature builder as part of - * interfaceBuilder. - * - * The method signature builder is created for the getter method of - * schemaNodeName. Also comment and - * returnType 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 - * @param status - * status from yang file, for deprecated annotation - * @return method signature builder which represents the getter method of - * interfaceBuilder - */ - private static MethodSignatureBuilder constructGetter(final GeneratedTypeBuilder interfaceBuilder, - final String schemaNodeName, final String comment, final Type returnType, final Status status) { - final MethodSignatureBuilder getMethod = interfaceBuilder - .addMethod(getterMethodName(schemaNodeName, returnType)); - if (status == Status.DEPRECATED) { - getMethod.addAnnotation("", "Deprecated"); - } - getMethod.setComment(encodeAngleBrackets(comment)); - getMethod.setReturnType(returnType); - return getMethod; - } - - /** - * Adds schemaNode to typeBuilder as getter method - * or to genTOBuilder as property. - * - * @param basePackageName - * string contains the module package name - * @param schemaNode - * data schema node which should be added as getter method to - * typeBuilder or as a property to - * genTOBuilder 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 - *
      - *
    • if schemaNode equals null
      • - *
    • if typeBuilder equals null
      • - *
    - */ - private void addSchemaNodeToListBuilders(final String basePackageName, final DataSchemaNode schemaNode, - final GeneratedTypeBuilder typeBuilder, final GeneratedTOBuilder genTOBuilder, final List 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,module); - 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, module); - } 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) { - final GeneratedTransferObject genTO = genTOBuilder.toInstance(); - constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO, Status.CURRENT); - genCtx.get(module).addGeneratedTOBuilder(genTOBuilder); - } - } - - /** - * Selects the names of the list keys from list 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 - * list contains no keys then the empty list is - * returned. - */ - private static List listKeys(final ListSchemaNode list) { - final List listKeys = new ArrayList<>(); - - final List keyDefinition = list.getKeyDefinition(); - if (keyDefinition != null) { - for (final QName keyDef : keyDefinition) { - listKeys.add(keyDef.getLocalName()); - } - } - return listKeys; - } - - /** - * Generates for the list 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 - * list or null if list is null or list of - * key definitions is null or empty. - */ - private static 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 typeDef of type - * {@link UnionTypeDefinition} or {@link BitsTypeDefinition} which are - * also added to typeBuilder 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 typeBuilder as - * enclosing transfer objects. - * - * @param typeDef - * type definition which can be of type UnionType or - * BitsTypeDefinition - * @param typeBuilder - * generated type builder to which is added generated TO created - * from typeDef - * @param leaf - * string with name for generated TO builder - * @param parentModule - * parent module - * @return generated TO builder for typeDef - */ - private GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition typeDef, - final GeneratedTypeBuilder typeBuilder, final DataSchemaNode leaf, final Module parentModule) { - final String classNameFromLeaf = BindingMapping.getClassName(leaf.getQName()); - final List genTOBuilders = new ArrayList<>(); - final String packageName = typeBuilder.getFullyQualifiedName(); - if (typeDef instanceof UnionTypeDefinition) { - final List types = ((TypeProviderImpl) typeProvider) - .provideGeneratedTOBuildersForUnionTypeDef(packageName, (UnionTypeDefinition) typeDef, - classNameFromLeaf, leaf); - genTOBuilders.addAll(types); - - GeneratedTOBuilder resultTOBuilder; - if (types.isEmpty()) { - throw new IllegalStateException("No GeneratedTOBuilder objects generated from union " + typeDef); - } - resultTOBuilder = types.remove(0); - for (final 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.isEmpty()) { - for (final 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 uses in - * {@code dataNodeContainer}. For every use is obtained corresponding - * generated type from {@link ModuleContext#groupings - * allGroupings} which is added as implements type to - * builder - * - * @param dataNodeContainer - * element which contains the list of used YANG groupings - * @param builder - * builder to which are added implemented types according to - * dataNodeContainer - * @return generated type builder with all implemented types - */ - private GeneratedTypeBuilder addImplementedInterfaceFromUses(final DataNodeContainer dataNodeContainer, - final GeneratedTypeBuilder builder) { - for (final UsesNode usesNode : dataNodeContainer.getUses()) { - 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); - } - return builder; - } - - private static boolean isNullOrEmpty(final Collection list) { - return list == null || list.isEmpty(); - } - - private String createDescription(final Set schemaNodes, final String moduleName) { - 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 " + moduleName + ""); - } else if (node instanceof NotificationDefinition) { - sb.append("Interface for receiving the following YANG notifications defined in module " + moduleName + ""); - } - } - sb.append(NEW_LINE); - - if (verboseClassComments) { - sb.append("
    ");
-            sb.append(NEW_LINE);
-            sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNodes)));
-            sb.append("
    "); - sb.append(NEW_LINE); - } - - return replaceAllIllegalChars(sb); - } - - private String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName) { - final StringBuilder sb = new StringBuilder(); - final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription()); - final String formattedDescription = YangTextTemplate.formatToParagraph(nodeDescription, 0); - - if (!Strings.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); - final String className = namespace[namespace.length - 1]; - - if (hasBuilderClass(schemaNode)) { - linkToBuilderClass.append(className); - linkToBuilderClass.append("Builder"); - } - - sb.append("

    "); - sb.append("This class represents the following YANG schema fragment defined in module "); - sb.append(module.getName()); - sb.append(""); - sb.append(NEW_LINE); - sb.append("

    ");
-            sb.append(NEW_LINE);
-            sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(schemaNode)));
-            sb.append("
    "); - sb.append(NEW_LINE); - sb.append("The schema path to identify an instance is"); - sb.append(NEW_LINE); - sb.append(""); - sb.append(YangTextTemplate.formatSchemaPath(module.getName(), schemaNode.getPath().getPathFromRoot())); - sb.append(""); - sb.append(NEW_LINE); - - if (hasBuilderClass(schemaNode)) { - sb.append(NEW_LINE); - sb.append("

    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 keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition(); - if (keyDef != null && !keyDef.isEmpty()) { - sb.append("@see "); - sb.append(className); - sb.append("Key"); - } - sb.append(NEW_LINE); - } - } - } - - return replaceAllIllegalChars(sb); - } - - private static boolean hasBuilderClass(final SchemaNode schemaNode) { - if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode || - schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) { - return true; - } - return false; - } - - private String createDescription(final Module module) { - final StringBuilder sb = new StringBuilder(); - final String moduleDescription = encodeAngleBrackets(module.getDescription()); - final String formattedDescription = YangTextTemplate.formatToParagraph(moduleDescription, 0); - - if (!Strings.isNullOrEmpty(formattedDescription)) { - sb.append(formattedDescription); - sb.append(NEW_LINE); - } - - if (verboseClassComments) { - sb.append("

    "); - sb.append("This class represents the following YANG schema fragment defined in module "); - sb.append(module.getName()); - sb.append(""); - sb.append(NEW_LINE); - sb.append("

    ");
-            sb.append(NEW_LINE);
-            sb.append(encodeAngleBrackets(YangTemplate.generateYangSnipet(module)));
-            sb.append("
    "); - } - - return replaceAllIllegalChars(sb); - } - - private GeneratedTypeBuilder findChildNodeByPath(final SchemaPath path) { - for (final ModuleContext ctx : genCtx.values()) { - final GeneratedTypeBuilder result = ctx.getChildNode(path); - if (result != null) { - return result; - } - } - return null; - } - - private GeneratedTypeBuilder findGroupingByPath(final SchemaPath path) { - for (final ModuleContext ctx : genCtx.values()) { - final GeneratedTypeBuilder result = ctx.getGrouping(path); - if (result != null) { - return result; - } - } - return null; - } - - private GeneratedTypeBuilder findCaseByPath(final SchemaPath path) { - for (final ModuleContext ctx : genCtx.values()) { - final GeneratedTypeBuilder result = ctx.getCase(path); - if (result != null) { - return result; - } - } - return null; - } - - public Map getModuleContexts() { - return genCtx; - } - - @VisibleForTesting - static String replaceAllIllegalChars(final StringBuilder stringBuilder){ - final String ret = UNICODE_CHAR_PATTERN.matcher(stringBuilder).replaceAll("\\\\\\\\u"); - return ret.isEmpty() ? "" : ret; - } - - private static void annotateDeprecatedIfNecessary(final Status status, final GeneratedTypeBuilder builder) { - if (status == Status.DEPRECATED) { - builder.addAnnotation("", "Deprecated"); - } + final JavaTypeName newName = name.createSibling(name.simpleName() + suffix); + renames.put(def, newName); + LOG.debug("Restarting code generation after remapping {} to {}", name, newName); } }