import static com.google.common.base.Preconditions.checkArgument;
import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.encodeAngleBrackets;
+import static org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil.replacePackageTopNamespace;
import static org.opendaylight.mdsal.binding.javav2.generator.util.Types.BOOLEAN;
import com.google.common.annotations.Beta;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
+import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
import org.opendaylight.mdsal.binding.javav2.generator.impl.txt.yangTemplateForModule;
import org.opendaylight.mdsal.binding.javav2.generator.impl.txt.yangTemplateForNode;
import org.opendaylight.mdsal.binding.javav2.generator.impl.txt.yangTemplateForNodes;
import org.opendaylight.mdsal.binding.javav2.generator.impl.util.YangTextTemplate;
import org.opendaylight.mdsal.binding.javav2.generator.spi.TypeProvider;
+import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
import org.opendaylight.mdsal.binding.javav2.generator.util.Types;
import org.opendaylight.mdsal.binding.javav2.generator.util.YangSnippetCleaner;
import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
+import org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
import org.opendaylight.mdsal.binding.javav2.generator.yang.types.TypeProviderImpl;
import org.opendaylight.mdsal.binding.javav2.model.api.Constant;
import org.opendaylight.mdsal.binding.javav2.model.api.Type;
import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilderBase;
import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
+import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
@Beta
final class AuxiliaryGenUtils {
- private static final Splitter BSDOT_SPLITTER = Splitter.on("\\.");
+ private static final Splitter BSDOT_SPLITTER = Splitter.on(".");
private static final char NEW_LINE = '\n';
private static final Pattern UNICODE_CHAR_PATTERN = Pattern.compile("\\\\+u");
}
}
- private static boolean hasBuilderClass(final SchemaNode schemaNode) {
- if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode ||
- schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition) {
- return true;
- }
- return false;
+ public static boolean hasBuilderClass(final SchemaNode schemaNode, final BindingNamespaceType namespaceType) {
+ return (namespaceType.equals(BindingNamespaceType.Data)
+ && (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode
+ || schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition
+ || schemaNode instanceof ChoiceCaseNode));
}
static Constant qNameConstant(final GeneratedTypeBuilderBase<?> toBuilder, final String constantName,
}
static String createDescription(final SchemaNode schemaNode, final String fullyQualifiedName,
- final SchemaContext schemaContext, final boolean verboseClassComments) {
+ final SchemaContext schemaContext, final boolean verboseClassComments,
+ final BindingNamespaceType namespaceType) {
final StringBuilder sb = new StringBuilder();
final String nodeDescription = encodeAngleBrackets(schemaNode.getDescription());
final String formattedDescription = YangTextTemplate.formatToParagraph(nodeDescription, 0);
sb.append(NEW_LINE);
}
+ final Module module = SchemaContextUtil.findParentModule(schemaContext, schemaNode);
if (verboseClassComments) {
- final Module module = SchemaContextUtil.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("<p>");
sb.append("This class represents the following YANG schema fragment defined in module <b>");
sb.append(module.getName());
sb.append("</i>");
sb.append(NEW_LINE);
- if (hasBuilderClass(schemaNode) && !(schemaNode instanceof OperationDefinition)) {
+ if (hasBuilderClass(schemaNode, namespaceType) && !(schemaNode instanceof OperationDefinition)) {
+ final StringBuilder linkToBuilderClass = new StringBuilder();
+ final String basePackageName = BindingMapping.getRootPackageName(module);
+
+ linkToBuilderClass
+ .append(replacePackageTopNamespace(basePackageName, fullyQualifiedName,
+ namespaceType, BindingNamespaceType.Builder))
+ .append("Builder");
sb.append(NEW_LINE);
sb.append("<p>To create instances of this class use " + "{@link " + linkToBuilderClass + "}.");
sb.append(NEW_LINE);
sb.append(linkToBuilderClass);
sb.append(NEW_LINE);
if (schemaNode instanceof ListSchemaNode) {
+ final StringBuilder linkToKeyClass = new StringBuilder();
+
+ final String[] namespace = Iterables.toArray(BSDOT_SPLITTER.split(fullyQualifiedName), String.class);
+ final String className = namespace[namespace.length - 1];
+
+ linkToKeyClass.append(BindingGeneratorUtil.packageNameForSubGeneratedType(basePackageName, schemaNode,
+ BindingNamespaceType.Key))
+ .append('.')
+ .append(className)
+ .append("Key");
+
final List<QName> keyDef = ((ListSchemaNode)schemaNode).getKeyDefinition();
if (keyDef != null && !keyDef.isEmpty()) {
sb.append("@see ");
- sb.append(className);
- sb.append("Key");
+ sb.append(linkToKeyClass);
}
sb.append(NEW_LINE);
}
* <code>enumTypeDef</code>
*/
static EnumBuilder resolveInnerEnumFromTypeDefinition(final EnumTypeDefinition enumTypeDef, final QName enumName,
- final Map<Module, ModuleContext> genCtx, final GeneratedTypeBuilder typeBuilder, final Module module) {
+ final Map<Module, ModuleContext> genCtx, final GeneratedTypeBuilder typeBuilder, final Module module) {
if (enumTypeDef != null && typeBuilder != null && enumTypeDef.getQName().getLocalName() != null) {
- final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumName.getLocalName());
+ final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumName.getLocalName(), genCtx.get(module));
final String enumTypedefDescription = encodeAngleBrackets(enumTypeDef.getDescription());
enumBuilder.setDescription(enumTypedefDescription);
enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
*/
static GeneratedTOBuilder addTOToTypeBuilder(final TypeDefinition<?> typeDef, final GeneratedTypeBuilder
typeBuilder, final DataSchemaNode leaf, final Module parentModule, final TypeProvider typeProvider,
- final SchemaContext schemaContext) {
+ final SchemaContext schemaContext, ModuleContext context) {
final String classNameFromLeaf = leaf.getQName().getLocalName();
GeneratedTOBuilder genTOBuilder = null;
final String packageName = typeBuilder.getFullyQualifiedName();
genTOBuilder = ((TypeProviderImpl) typeProvider)
.provideGeneratedTOBuilderForUnionTypeDef(packageName, ((UnionTypeDefinition) typeDef),
classNameFromLeaf, leaf, schemaContext,
- ((TypeProviderImpl) typeProvider).getGenTypeDefsContextMap());
+ ((TypeProviderImpl) typeProvider).getGenTypeDefsContextMap(), context);
} else if (typeDef instanceof BitsTypeDefinition) {
genTOBuilder = (((TypeProviderImpl) typeProvider)).provideGeneratedTOBuilderForBitsTypeDefinition(
- packageName, typeDef, classNameFromLeaf, parentModule.getName());
+ packageName, typeDef, classNameFromLeaf, parentModule.getName(), context);
}
if (genTOBuilder != null) {
typeBuilder.addEnclosingTransferObject(genTOBuilder);
}
static boolean isInnerType(final LeafSchemaNode leaf, final TypeDefinition<?> type) {
- if (leaf.getPath().equals(type.getPath())) {
- return true;
- }
- if (leaf.getPath().equals(type.getPath().getParent())) {
- return true;
- }
+ return leaf.getPath().equals(type.getPath()) || leaf.getPath().equals(type.getPath().getParent());
- return false;
}
/**
* <code>list</code> or empty TO builder if <code>list</code> is null or list of
* key definitions is null or empty.
*/
- static GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list) {
+ static GeneratedTOBuilder resolveListKeyTOBuilder(final String packageName, final ListSchemaNode list,
+ ModuleContext context) {
GeneratedTOBuilder genTOBuilder = null;
if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
// underscore used as separator for distinction of class name parts
final String genTOName =
new StringBuilder(list.getQName().getLocalName()).append('_').append(BindingNamespaceType.Key)
.toString();
- genTOBuilder =
- new GeneratedTOBuilderImpl(new StringBuilder(packageName).toString(), genTOName);
+ genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName, context);
}
return genTOBuilder;
}
+ static GeneratedTypeBuilder resolveListKeyTypeBuilder(final String packageName, final ListSchemaNode list,
+ ModuleContext context) {
+ GeneratedTypeBuilder genTypeBuilder = null;
+ if ((list.getKeyDefinition() != null) && (!list.getKeyDefinition().isEmpty())) {
+ // underscore used as separator for distinction of class name parts
+ final String genTOName =
+ new StringBuilder(list.getQName().getLocalName()).append('_').append(BindingNamespaceType.Key)
+ .toString();
+ genTypeBuilder = new GeneratedTypeBuilderImpl(packageName, genTOName, context);
+ }
+ return genTypeBuilder;
+ }
+
/**
* Converts <code>leaf</code> schema node to property of generated TO
* builder.
* <li>true - other cases</li>
* </ul>
*/
- static boolean resolveLeafSchemaNodeAsProperty(final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf,
+ static boolean resolveLeafSchemaNodeAsProperty(final String nodeName, 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 leafGetterName;
+
+ if ("key".equals(leafName.toLowerCase())) {
+ StringBuilder sb = new StringBuilder(leafName)
+ .append('_').append("RESERVED_WORD");
+ leafGetterName = sb.toString();
+ } else {
+ leafGetterName = leafName;
+ }
+
final String leafDesc = encodeAngleBrackets(leaf.getDescription());
final GeneratedPropertyBuilder propBuilder =
- toBuilder.addProperty(JavaIdentifierNormalizer.normalizeSpecificIdentifier(leafName, JavaIdentifier.METHOD));
+ toBuilder.addProperty(JavaIdentifierNormalizer.normalizeSpecificIdentifier(leafGetterName, JavaIdentifier.METHOD));
propBuilder.setReadOnly(isReadOnly);
propBuilder.setReturnType(returnType);
propBuilder.setComment(leafDesc);