From: lsedlak Date: Tue, 16 Apr 2013 12:01:13 +0000 (+0200) Subject: Fixed bug in generating of package names in BindingGeneratorImpl; X-Git-Tag: releasepom-0.1.0~549 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=bf58a4829b6dee61b9da7eddf66712cbb4c19cce Fixed bug in generating of package names in BindingGeneratorImpl; Added test files into src/test/resources/leafref-test-models for testing of resolution of leafrefs in yang models; Change-Id: I910da64133715efda02023781ba829ae4d12ad02 Signed-off-by: Lukas Sedlak --- diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/BindingGeneratorImpl.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/BindingGeneratorImpl.java index 3a9398a13a..f959865212 100644 --- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/BindingGeneratorImpl.java +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/BindingGeneratorImpl.java @@ -1,516 +1,551 @@ -/* - * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ -package org.opendaylight.controller.sal.binding.generator.impl; - -import java.net.URI; -import java.util.ArrayList; -import java.util.Calendar; -import java.util.GregorianCalendar; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; - -import org.opendaylight.controller.binding.generator.util.CodeGeneratorHelper; -import org.opendaylight.controller.binding.generator.util.Types; -import org.opendaylight.controller.sal.binding.generator.api.BindingGenerator; -import org.opendaylight.controller.sal.binding.generator.spi.TypeProvider; -import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject; -import org.opendaylight.controller.sal.binding.model.api.GeneratedType; -import org.opendaylight.controller.sal.binding.model.api.Type; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedPropertyBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTOBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTypeBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.MethodSignatureBuilder; -import org.opendaylight.controller.sal.binding.yang.types.TypeProviderImpl; -import org.opendaylight.controller.yang.common.QName; -import org.opendaylight.controller.yang.model.api.ContainerSchemaNode; -import org.opendaylight.controller.yang.model.api.DataNodeContainer; -import org.opendaylight.controller.yang.model.api.DataSchemaNode; -import org.opendaylight.controller.yang.model.api.LeafListSchemaNode; -import org.opendaylight.controller.yang.model.api.LeafSchemaNode; -import org.opendaylight.controller.yang.model.api.ListSchemaNode; -import org.opendaylight.controller.yang.model.api.Module; -import org.opendaylight.controller.yang.model.api.SchemaContext; -import org.opendaylight.controller.yang.model.api.SchemaPath; -import org.opendaylight.controller.yang.model.api.TypeDefinition; - -public class BindingGeneratorImpl implements BindingGenerator { - - private static Calendar calendar = new GregorianCalendar(); - private Map> genTypeBuilders; - private List schemaContainers; - private List schemaLists; - private TypeProvider typeProvider; - private String basePackageName; - - public BindingGeneratorImpl() { - super(); - } - - @Override - public List generateTypes(final SchemaContext context) { - final List genTypes = new ArrayList(); - - typeProvider = new TypeProviderImpl(context); - if (context != null) { - final Set modules = context.getModules(); - - if (modules != null) { - for (final Module module : modules) { - genTypeBuilders = new HashMap>(); - schemaContainers = new ArrayList(); - schemaLists = new ArrayList(); - - basePackageName = resolveBasePackageName(module.getNamespace(), - module.getYangVersion()); - - traverseModule(module); - if (schemaContainers.size() > 0) { - for (final ContainerSchemaNode container : schemaContainers) { - genTypes.add(containerToGenType(container)); - } - } - - if (schemaLists.size() > 0) { - for (final ListSchemaNode list : schemaLists) { - genTypes.addAll(listToGenType(list)); - } - } - } - } - } - - return genTypes; - } - - private String resolveGeneratedTypePackageName(final SchemaPath schemaPath) { - final StringBuilder builder = new StringBuilder(); - builder.append(basePackageName); - if ((schemaPath != null) && (schemaPath.getPath() != null)) { - final List pathToNode = schemaPath.getPath(); - final int traversalSteps = (pathToNode.size() - 1); - for (int i = 0; i < traversalSteps; ++i) { - builder.append("."); - String nodeLocalName = pathToNode.get(i).getLocalName(); - - // TODO: create method - nodeLocalName = nodeLocalName.replace(":", "."); - nodeLocalName = nodeLocalName.replace("-", "."); - builder.append(nodeLocalName); - } - return builder.toString(); - } - return null; - } - - private GeneratedType containerToGenType(ContainerSchemaNode container) { - if (container == null) { - return null; - } - final Set schemaNodes = container.getChildNodes(); - final GeneratedTypeBuilder typeBuilder = addRawInterfaceDefinition(container); - - for (final DataSchemaNode node : schemaNodes) { - if (node instanceof LeafSchemaNode) { - resolveLeafSchemaNodeAsMethod(typeBuilder, - (LeafSchemaNode) node); - } else if (node instanceof LeafListSchemaNode) { - resolveLeafListSchemaNode(typeBuilder, - (LeafListSchemaNode) node); - - } else if (node instanceof ContainerSchemaNode) { - resolveContainerSchemaNode(typeBuilder, - (ContainerSchemaNode) node); - } else if (node instanceof ListSchemaNode) { - resolveListSchemaNode(typeBuilder, (ListSchemaNode) node); - } - } - return typeBuilder.toInstance(); - } - - private boolean resolveLeafSchemaNodeAsMethod( - final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) { - if ((leaf != null) && (typeBuilder != null)) { - final String leafName = leaf.getQName().getLocalName(); - String leafDesc = leaf.getDescription(); - if (leafDesc == null) { - leafDesc = ""; - } - - if (leafName != null) { - final TypeDefinition typeDef = leaf.getType(); - final Type javaType = typeProvider - .javaTypeForSchemaDefinitionType(typeDef); - - constructGetter(typeBuilder, leafName, leafDesc, javaType); - if (!leaf.isConfiguration()) { - constructSetter(typeBuilder, leafName, leafDesc, javaType); - } - return true; - } - } - return false; - } - - private boolean resolveLeafSchemaNodeAsProperty( - final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf, - boolean isReadOnly) { - if ((leaf != null) && (toBuilder != null)) { - final String leafName = leaf.getQName().getLocalName(); - String leafDesc = leaf.getDescription(); - if (leafDesc == null) { - leafDesc = ""; - } - - if (leafName != null) { - final TypeDefinition typeDef = leaf.getType(); - - //TODO: properly resolve enum types - final Type javaType = typeProvider - .javaTypeForSchemaDefinitionType(typeDef); - - final GeneratedPropertyBuilder propBuilder = toBuilder - .addProperty(CodeGeneratorHelper - .parseToClassName(leafName)); - - propBuilder.setReadOnly(isReadOnly); - propBuilder.addReturnType(javaType); - propBuilder.addComment(leafDesc); - - toBuilder.addEqualsIdentity(propBuilder); - toBuilder.addHashIdentity(propBuilder); - toBuilder.addToStringProperty(propBuilder); - - return true; - } - } - return false; - } - - private boolean resolveLeafListSchemaNode( - final GeneratedTypeBuilder typeBuilder, - final LeafListSchemaNode node) { - if ((node != null) && (typeBuilder != null)) { - final String nodeName = node.getQName().getLocalName(); - String nodeDesc = node.getDescription(); - if (nodeDesc == null) { - nodeDesc = ""; - } - - if (nodeName != null) { - final TypeDefinition type = node.getType(); - final Type listType = Types.listTypeFor(typeProvider - .javaTypeForSchemaDefinitionType(type)); - - constructGetter(typeBuilder, nodeName, nodeDesc, listType); - if (!node.isConfiguration()) { - constructSetter(typeBuilder, nodeName, nodeDesc, listType); - } - return true; - } - } - return false; - } - - private boolean resolveContainerSchemaNode( - final GeneratedTypeBuilder typeBuilder, - final ContainerSchemaNode node) { - if ((node != null) && (typeBuilder != null)) { - final String nodeName = node.getQName().getLocalName(); - - if (nodeName != null) { - final GeneratedTypeBuilder rawGenType = addRawInterfaceDefinition(node); - constructGetter(typeBuilder, nodeName, "", rawGenType); - - return true; - } - } - return false; - } - - private boolean resolveListSchemaNode( - final GeneratedTypeBuilder typeBuilder, final ListSchemaNode node) { - if ((node != null) && (typeBuilder != null)) { - final String nodeName = node.getQName().getLocalName(); - - if (nodeName != null) { - final GeneratedTypeBuilder rawGenType = addRawInterfaceDefinition(node); - constructGetter(typeBuilder, nodeName, "", - Types.listTypeFor(rawGenType)); - if (!node.isConfiguration()) { - constructSetter(typeBuilder, nodeName, "", - Types.listTypeFor(rawGenType)); - } - return true; - } - } - return false; - } - - private GeneratedTypeBuilder addRawInterfaceDefinition( - final DataSchemaNode schemaNode) { - if (schemaNode == null) { - return null; - } - - final String packageName = resolveGeneratedTypePackageName(schemaNode - .getPath()); - final String schemaNodeName = schemaNode.getQName().getLocalName(); - - if ((packageName != null) && (schemaNode != null) - && (schemaNodeName != null)) { - final String genTypeName = CodeGeneratorHelper - .parseToClassName(schemaNodeName); - final GeneratedTypeBuilder newType = new GeneratedTypeBuilderImpl( - packageName, genTypeName); - - 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; - } - return null; - } - - private String getterMethodName(final String methodName) { - final StringBuilder method = new StringBuilder(); - method.append("get"); - method.append(CodeGeneratorHelper.parseToClassName(methodName)); - return method.toString(); - } - - private String setterMethodName(final String methodName) { - final StringBuilder method = new StringBuilder(); - method.append("set"); - method.append(CodeGeneratorHelper.parseToClassName(methodName)); - return method.toString(); - } - - private MethodSignatureBuilder constructGetter( - final GeneratedTypeBuilder interfaceBuilder, - final String schemaNodeName, final String comment, - final Type returnType) { - final MethodSignatureBuilder getMethod = interfaceBuilder - .addMethod(getterMethodName(schemaNodeName)); - - getMethod.addComment(comment); - getMethod.addReturnType(returnType); - - return getMethod; - } - - private MethodSignatureBuilder constructSetter( - final GeneratedTypeBuilder interfaceBuilder, - final String schemaNodeName, final String comment, - final Type parameterType) { - final MethodSignatureBuilder setMethod = interfaceBuilder - .addMethod(setterMethodName(schemaNodeName)); - - setMethod.addComment(comment); - setMethod.addParameter(parameterType, - CodeGeneratorHelper.parseToParamName(schemaNodeName)); - setMethod.addReturnType(Types.voidType()); - - return setMethod; - } - - private String resolveBasePackageName(final URI moduleNamespace, - final String yangVersion) { - final StringBuilder packageNameBuilder = new StringBuilder(); - - packageNameBuilder.append("org.opendaylight.yang.gen.v"); - packageNameBuilder.append(yangVersion); - packageNameBuilder.append(".rev"); - packageNameBuilder.append(calendar.get(Calendar.YEAR)); - packageNameBuilder.append((calendar.get(Calendar.MONTH) + 1)); - packageNameBuilder.append(calendar.get(Calendar.DAY_OF_MONTH)); - packageNameBuilder.append("."); - - String namespace = moduleNamespace.toString(); - namespace = namespace.replace(":", "."); - namespace = namespace.replace("-", "."); - - packageNameBuilder.append(namespace); - - return packageNameBuilder.toString(); - } - - private List listToGenType(final ListSchemaNode list) { - if (list == null) { - return null; - } - final GeneratedTypeBuilder typeBuilder = resolveListTypeBuilder(list); - final List listKeys = listKeys(list); - GeneratedTOBuilder genTOBuilder = null; - if (listKeys.size() > 0) { - genTOBuilder = resolveListKey(list); - } - - final Set schemaNodes = list.getChildNodes(); - for (final DataSchemaNode node : schemaNodes) { - - if (node instanceof LeafSchemaNode) { - final LeafSchemaNode leaf = (LeafSchemaNode) node; - if (!isPartOfListKey(leaf, listKeys)) { - resolveLeafSchemaNodeAsMethod(typeBuilder, leaf); - } else { - resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true); - } - } else if (node instanceof LeafListSchemaNode) { - resolveLeafListSchemaNode(typeBuilder, - (LeafListSchemaNode) node); - } else if (node instanceof ContainerSchemaNode) { - resolveContainerSchemaNode(typeBuilder, - (ContainerSchemaNode) node); - } else if (node instanceof ListSchemaNode) { - resolveListSchemaNode(typeBuilder, (ListSchemaNode) node); - } - } - - final List genTypes = new ArrayList(); - if (genTOBuilder != null) { - final GeneratedTransferObject genTO = genTOBuilder.toInstance(); - constructGetter(typeBuilder, genTO.getName(), "Returns Primary Key of Yang List Type", genTO); - genTypes.add(genTO); - } - genTypes.add(typeBuilder.toInstance()); - return genTypes; - } - - /** - * @param list - * @return - */ - private GeneratedTOBuilder resolveListKey(final ListSchemaNode list) { - final String packageName = resolveGeneratedTypePackageName(list - .getPath()); - final String listName = list.getQName().getLocalName() + "Key"; - - if ((packageName != null) && (list != null) && (listName != null)) { - final String genTOName = CodeGeneratorHelper - .parseToClassName(listName); - final GeneratedTOBuilder newType = new GeneratedTOBuilderImpl( - packageName, genTOName); - - return newType; - } - return null; - } - - private boolean isPartOfListKey(final LeafSchemaNode leaf, - final List keys) { - if ((leaf != null) && (keys != null) && (leaf.getQName() != null)) { - final String leafName = leaf.getQName().getLocalName(); - if (keys.contains(leafName)) { - return true; - } - } - return false; - } - - private List listKeys(final ListSchemaNode list) { - final List listKeys = new ArrayList(); - - if (list.getKeyDefinition() != null) { - final List keyDefinitions = list.getKeyDefinition(); - - for (final QName keyDefinition : keyDefinitions) { - listKeys.add(keyDefinition.getLocalName()); - } - } - return listKeys; - } - - private GeneratedTypeBuilder resolveListTypeBuilder( - final ListSchemaNode list) { - final String packageName = resolveGeneratedTypePackageName(list - .getPath()); - final String schemaNodeName = list.getQName().getLocalName(); - final String genTypeName = CodeGeneratorHelper - .parseToClassName(schemaNodeName); - - GeneratedTypeBuilder typeBuilder = null; - if (genTypeBuilders.containsKey(packageName)) { - final Map builders = new HashMap(); - typeBuilder = builders.get(genTypeName); - - if (null == typeBuilder) { - typeBuilder = addRawInterfaceDefinition(list); - } - } - return typeBuilder; - } - - private void traverseModule(final Module module) { - final Set schemaNodes = module.getChildNodes(); - - for (DataSchemaNode node : schemaNodes) { - if (node instanceof ContainerSchemaNode) { - schemaContainers.add((ContainerSchemaNode) node); - traverse((ContainerSchemaNode) node); - } - } - } - - private void traverse(final DataNodeContainer dataNode) { - if (!containChildDataNodeContainer(dataNode)) { - return; - } - - final Set childs = dataNode.getChildNodes(); - if (childs != null) { - for (DataSchemaNode childNode : childs) { - if (childNode instanceof ContainerSchemaNode) { - final ContainerSchemaNode container = (ContainerSchemaNode) childNode; - schemaContainers.add(container); - traverse(container); - } - - if (childNode instanceof ListSchemaNode) { - final ListSchemaNode list = (ListSchemaNode) childNode; - schemaLists.add(list); - traverse(list); - } - } - } - } - - /** - * Returns true if and only if the child node contain at least - * one child container schema node or child list schema node, otherwise will - * always returns false - * - * @param container - * @return true if and only if the child node contain at least - * one child container schema node or child list schema node, - * otherwise will always returns false - */ - private boolean containChildDataNodeContainer( - final DataNodeContainer container) { - if (container != null) { - final Set childs = container.getChildNodes(); - if ((childs != null) && (childs.size() > 0)) { - for (final DataSchemaNode childNode : childs) { - if (childNode instanceof DataNodeContainer) { - return true; - } - } - } - } - return false; - } -} +/* + * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.controller.sal.binding.generator.impl; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Calendar; +import java.util.GregorianCalendar; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.opendaylight.controller.binding.generator.util.CodeGeneratorHelper; +import org.opendaylight.controller.binding.generator.util.Types; +import org.opendaylight.controller.sal.binding.generator.api.BindingGenerator; +import org.opendaylight.controller.sal.binding.generator.spi.TypeProvider; +import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject; +import org.opendaylight.controller.sal.binding.model.api.GeneratedType; +import org.opendaylight.controller.sal.binding.model.api.Type; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedPropertyBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTOBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTypeBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.MethodSignatureBuilder; +import org.opendaylight.controller.sal.binding.yang.types.TypeProviderImpl; +import org.opendaylight.controller.yang.common.QName; +import org.opendaylight.controller.yang.model.api.ContainerSchemaNode; +import org.opendaylight.controller.yang.model.api.DataNodeContainer; +import org.opendaylight.controller.yang.model.api.DataSchemaNode; +import org.opendaylight.controller.yang.model.api.LeafListSchemaNode; +import org.opendaylight.controller.yang.model.api.LeafSchemaNode; +import org.opendaylight.controller.yang.model.api.ListSchemaNode; +import org.opendaylight.controller.yang.model.api.Module; +import org.opendaylight.controller.yang.model.api.SchemaContext; +import org.opendaylight.controller.yang.model.api.SchemaPath; +import org.opendaylight.controller.yang.model.api.TypeDefinition; + +public class BindingGeneratorImpl implements BindingGenerator { + + private static final String[] SET_VALUES = new String[] { "abstract", + "assert", "boolean", "break", "byte", "case", "catch", "char", + "class", "const", "continue", "default", "double", "do", "else", + "enum", "extends", "false", "final", "finally", "float", "for", + "goto", "if", "implements", "import", "instanceof", "int", + "interface", "long", "native", "new", "null", "package", "private", + "protected", "public", "return", "short", "static", "strictfp", + "super", "switch", "synchronized", "this", "throw", "throws", + "transient", "true", "try", "void", "volatile", "while" }; + + public static final Set JAVA_RESERVED_WORDS = new HashSet( + Arrays.asList(SET_VALUES)); + + private static Calendar calendar = new GregorianCalendar(); + private Map> genTypeBuilders; + private List schemaContainers; + private List schemaLists; + private TypeProvider typeProvider; + private String basePackageName; + + public BindingGeneratorImpl() { + super(); + } + + private static String validatePackage(final String packageName) { + if (packageName != null) { + final String[] packNameParts = packageName.split("\\."); + if (packNameParts != null) { + final StringBuilder builder = new StringBuilder(); + for (int i = 0; i < packNameParts.length; ++i) { + if (JAVA_RESERVED_WORDS.contains(packNameParts[i])) { + packNameParts[i] = "_" + packNameParts[i]; + } + if (i > 0) { + builder.append("."); + } + builder.append(packNameParts[i]); + } + return builder.toString(); + } + } + return packageName; + } + + @Override + public List generateTypes(final SchemaContext context) { + final List genTypes = new ArrayList(); + + typeProvider = new TypeProviderImpl(context); + if (context != null) { + final Set modules = context.getModules(); + + if (modules != null) { + for (final Module module : modules) { + genTypeBuilders = new HashMap>(); + schemaContainers = new ArrayList(); + schemaLists = new ArrayList(); + + basePackageName = resolveBasePackageName(module.getNamespace(), + module.getYangVersion()); + + traverseModule(module); + if (schemaContainers.size() > 0) { + for (final ContainerSchemaNode container : schemaContainers) { + genTypes.add(containerToGenType(container)); + } + } + + if (schemaLists.size() > 0) { + for (final ListSchemaNode list : schemaLists) { + genTypes.addAll(listToGenType(list)); + } + } + } + } + } + + return genTypes; + } + + private String resolveGeneratedTypePackageName(final SchemaPath schemaPath) { + final StringBuilder builder = new StringBuilder(); + builder.append(basePackageName); + if ((schemaPath != null) && (schemaPath.getPath() != null)) { + final List pathToNode = schemaPath.getPath(); + final int traversalSteps = (pathToNode.size() - 1); + for (int i = 0; i < traversalSteps; ++i) { + builder.append("."); + String nodeLocalName = pathToNode.get(i).getLocalName(); + + // TODO: create method + nodeLocalName = nodeLocalName.replace(":", "."); + nodeLocalName = nodeLocalName.replace("-", "."); + builder.append(nodeLocalName); + } + return validatePackage(builder.toString()); + } + return null; + } + + private GeneratedType containerToGenType(ContainerSchemaNode container) { + if (container == null) { + return null; + } + final Set schemaNodes = container.getChildNodes(); + final GeneratedTypeBuilder typeBuilder = addRawInterfaceDefinition(container); + + for (final DataSchemaNode node : schemaNodes) { + if (node instanceof LeafSchemaNode) { + resolveLeafSchemaNodeAsMethod(typeBuilder, + (LeafSchemaNode) node); + } else if (node instanceof LeafListSchemaNode) { + resolveLeafListSchemaNode(typeBuilder, + (LeafListSchemaNode) node); + + } else if (node instanceof ContainerSchemaNode) { + resolveContainerSchemaNode(typeBuilder, + (ContainerSchemaNode) node); + } else if (node instanceof ListSchemaNode) { + resolveListSchemaNode(typeBuilder, (ListSchemaNode) node); + } + } + return typeBuilder.toInstance(); + } + + private boolean resolveLeafSchemaNodeAsMethod( + final GeneratedTypeBuilder typeBuilder, final LeafSchemaNode leaf) { + if ((leaf != null) && (typeBuilder != null)) { + final String leafName = leaf.getQName().getLocalName(); + String leafDesc = leaf.getDescription(); + if (leafDesc == null) { + leafDesc = ""; + } + + if (leafName != null) { + final TypeDefinition typeDef = leaf.getType(); + final Type javaType = typeProvider + .javaTypeForSchemaDefinitionType(typeDef); + + constructGetter(typeBuilder, leafName, leafDesc, javaType); + if (!leaf.isConfiguration()) { + constructSetter(typeBuilder, leafName, leafDesc, javaType); + } + return true; + } + } + return false; + } + + private boolean resolveLeafSchemaNodeAsProperty( + final GeneratedTOBuilder toBuilder, final LeafSchemaNode leaf, + boolean isReadOnly) { + if ((leaf != null) && (toBuilder != null)) { + final String leafName = leaf.getQName().getLocalName(); + String leafDesc = leaf.getDescription(); + if (leafDesc == null) { + leafDesc = ""; + } + + if (leafName != null) { + final TypeDefinition typeDef = leaf.getType(); + + //TODO: properly resolve enum types + final Type javaType = typeProvider + .javaTypeForSchemaDefinitionType(typeDef); + + final GeneratedPropertyBuilder propBuilder = toBuilder + .addProperty(CodeGeneratorHelper + .parseToClassName(leafName)); + + propBuilder.setReadOnly(isReadOnly); + propBuilder.addReturnType(javaType); + propBuilder.addComment(leafDesc); + + toBuilder.addEqualsIdentity(propBuilder); + toBuilder.addHashIdentity(propBuilder); + toBuilder.addToStringProperty(propBuilder); + + return true; + } + } + return false; + } + + private boolean resolveLeafListSchemaNode( + final GeneratedTypeBuilder typeBuilder, + final LeafListSchemaNode node) { + if ((node != null) && (typeBuilder != null)) { + final String nodeName = node.getQName().getLocalName(); + String nodeDesc = node.getDescription(); + if (nodeDesc == null) { + nodeDesc = ""; + } + + if (nodeName != null) { + final TypeDefinition type = node.getType(); + final Type listType = Types.listTypeFor(typeProvider + .javaTypeForSchemaDefinitionType(type)); + + constructGetter(typeBuilder, nodeName, nodeDesc, listType); + if (!node.isConfiguration()) { + constructSetter(typeBuilder, nodeName, nodeDesc, listType); + } + return true; + } + } + return false; + } + + private boolean resolveContainerSchemaNode( + final GeneratedTypeBuilder typeBuilder, + final ContainerSchemaNode node) { + if ((node != null) && (typeBuilder != null)) { + final String nodeName = node.getQName().getLocalName(); + + if (nodeName != null) { + final GeneratedTypeBuilder rawGenType = addRawInterfaceDefinition(node); + constructGetter(typeBuilder, nodeName, "", rawGenType); + + return true; + } + } + return false; + } + + private boolean resolveListSchemaNode( + final GeneratedTypeBuilder typeBuilder, final ListSchemaNode node) { + if ((node != null) && (typeBuilder != null)) { + final String nodeName = node.getQName().getLocalName(); + + if (nodeName != null) { + final GeneratedTypeBuilder rawGenType = addRawInterfaceDefinition(node); + constructGetter(typeBuilder, nodeName, "", + Types.listTypeFor(rawGenType)); + if (!node.isConfiguration()) { + constructSetter(typeBuilder, nodeName, "", + Types.listTypeFor(rawGenType)); + } + return true; + } + } + return false; + } + + private GeneratedTypeBuilder addRawInterfaceDefinition( + final DataSchemaNode schemaNode) { + if (schemaNode == null) { + return null; + } + + final String packageName = resolveGeneratedTypePackageName(schemaNode + .getPath()); + final String schemaNodeName = schemaNode.getQName().getLocalName(); + + if ((packageName != null) && (schemaNode != null) + && (schemaNodeName != null)) { + final String genTypeName = CodeGeneratorHelper + .parseToClassName(schemaNodeName); + final GeneratedTypeBuilder newType = new GeneratedTypeBuilderImpl( + packageName, genTypeName); + + 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; + } + return null; + } + + private String getterMethodName(final String methodName) { + final StringBuilder method = new StringBuilder(); + method.append("get"); + method.append(CodeGeneratorHelper.parseToClassName(methodName)); + return method.toString(); + } + + private String setterMethodName(final String methodName) { + final StringBuilder method = new StringBuilder(); + method.append("set"); + method.append(CodeGeneratorHelper.parseToClassName(methodName)); + return method.toString(); + } + + private MethodSignatureBuilder constructGetter( + final GeneratedTypeBuilder interfaceBuilder, + final String schemaNodeName, final String comment, + final Type returnType) { + final MethodSignatureBuilder getMethod = interfaceBuilder + .addMethod(getterMethodName(schemaNodeName)); + + getMethod.addComment(comment); + getMethod.addReturnType(returnType); + + return getMethod; + } + + private MethodSignatureBuilder constructSetter( + final GeneratedTypeBuilder interfaceBuilder, + final String schemaNodeName, final String comment, + final Type parameterType) { + final MethodSignatureBuilder setMethod = interfaceBuilder + .addMethod(setterMethodName(schemaNodeName)); + + setMethod.addComment(comment); + setMethod.addParameter(parameterType, + CodeGeneratorHelper.parseToParamName(schemaNodeName)); + setMethod.addReturnType(Types.voidType()); + + return setMethod; + } + + private String resolveBasePackageName(final URI moduleNamespace, + final String yangVersion) { + final StringBuilder packageNameBuilder = new StringBuilder(); + + packageNameBuilder.append("org.opendaylight.yang.gen.v"); + packageNameBuilder.append(yangVersion); + packageNameBuilder.append(".rev"); + packageNameBuilder.append(calendar.get(Calendar.YEAR)); + packageNameBuilder.append((calendar.get(Calendar.MONTH) + 1)); + packageNameBuilder.append(calendar.get(Calendar.DAY_OF_MONTH)); + packageNameBuilder.append("."); + + String namespace = moduleNamespace.toString(); + namespace = namespace.replace(":", "."); + namespace = namespace.replace("-", "."); + + packageNameBuilder.append(namespace); + + return packageNameBuilder.toString(); + } + + private List listToGenType(final ListSchemaNode list) { + if (list == null) { + return null; + } + final GeneratedTypeBuilder typeBuilder = resolveListTypeBuilder(list); + final List listKeys = listKeys(list); + GeneratedTOBuilder genTOBuilder = null; + if (listKeys.size() > 0) { + genTOBuilder = resolveListKey(list); + } + + final Set schemaNodes = list.getChildNodes(); + for (final DataSchemaNode node : schemaNodes) { + + if (node instanceof LeafSchemaNode) { + final LeafSchemaNode leaf = (LeafSchemaNode) node; + if (!isPartOfListKey(leaf, listKeys)) { + resolveLeafSchemaNodeAsMethod(typeBuilder, leaf); + } else { + resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true); + } + } else if (node instanceof LeafListSchemaNode) { + resolveLeafListSchemaNode(typeBuilder, + (LeafListSchemaNode) node); + } else if (node instanceof ContainerSchemaNode) { + resolveContainerSchemaNode(typeBuilder, + (ContainerSchemaNode) node); + } else if (node instanceof ListSchemaNode) { + resolveListSchemaNode(typeBuilder, (ListSchemaNode) node); + } + } + + final List genTypes = new ArrayList(); + if (genTOBuilder != null) { + final GeneratedTransferObject genTO = genTOBuilder.toInstance(); + constructGetter(typeBuilder, genTO.getName(), "Returns Primary Key of Yang List Type", genTO); + genTypes.add(genTO); + } + genTypes.add(typeBuilder.toInstance()); + return genTypes; + } + + /** + * @param list + * @return + */ + private GeneratedTOBuilder resolveListKey(final ListSchemaNode list) { + final String packageName = resolveGeneratedTypePackageName(list + .getPath()); + final String listName = list.getQName().getLocalName() + "Key"; + + if ((packageName != null) && (list != null) && (listName != null)) { + final String genTOName = CodeGeneratorHelper + .parseToClassName(listName); + final GeneratedTOBuilder newType = new GeneratedTOBuilderImpl( + packageName, genTOName); + + return newType; + } + return null; + } + + private boolean isPartOfListKey(final LeafSchemaNode leaf, + final List keys) { + if ((leaf != null) && (keys != null) && (leaf.getQName() != null)) { + final String leafName = leaf.getQName().getLocalName(); + if (keys.contains(leafName)) { + return true; + } + } + return false; + } + + private List listKeys(final ListSchemaNode list) { + final List listKeys = new ArrayList(); + + if (list.getKeyDefinition() != null) { + final List keyDefinitions = list.getKeyDefinition(); + + for (final QName keyDefinition : keyDefinitions) { + listKeys.add(keyDefinition.getLocalName()); + } + } + return listKeys; + } + + private GeneratedTypeBuilder resolveListTypeBuilder( + final ListSchemaNode list) { + final String packageName = resolveGeneratedTypePackageName(list + .getPath()); + final String schemaNodeName = list.getQName().getLocalName(); + final String genTypeName = CodeGeneratorHelper + .parseToClassName(schemaNodeName); + + GeneratedTypeBuilder typeBuilder = null; + if (genTypeBuilders.containsKey(packageName)) { + final Map builders = new HashMap(); + typeBuilder = builders.get(genTypeName); + + if (null == typeBuilder) { + typeBuilder = addRawInterfaceDefinition(list); + } + } + return typeBuilder; + } + + private void traverseModule(final Module module) { + final Set schemaNodes = module.getChildNodes(); + + for (DataSchemaNode node : schemaNodes) { + if (node instanceof ContainerSchemaNode) { + schemaContainers.add((ContainerSchemaNode) node); + traverse((ContainerSchemaNode) node); + } + } + } + + private void traverse(final DataNodeContainer dataNode) { + if (!containChildDataNodeContainer(dataNode)) { + return; + } + + final Set childs = dataNode.getChildNodes(); + if (childs != null) { + for (DataSchemaNode childNode : childs) { + if (childNode instanceof ContainerSchemaNode) { + final ContainerSchemaNode container = (ContainerSchemaNode) childNode; + schemaContainers.add(container); + traverse(container); + } + + if (childNode instanceof ListSchemaNode) { + final ListSchemaNode list = (ListSchemaNode) childNode; + schemaLists.add(list); + traverse(list); + } + } + } + } + + /** + * Returns true if and only if the child node contain at least + * one child container schema node or child list schema node, otherwise will + * always returns false + * + * @param container + * @return true if and only if the child node contain at least + * one child container schema node or child list schema node, + * otherwise will always returns false + */ + private boolean containChildDataNodeContainer( + final DataNodeContainer container) { + if (container != null) { + final Set childs = container.getChildNodes(); + if ((childs != null) && (childs.size() > 0)) { + for (final DataSchemaNode childNode : childs) { + if (childNode instanceof DataNodeContainer) { + return true; + } + } + } + } + return false; + } +} diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/EnumerationBuilderImpl.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/EnumerationBuilderImpl.java index 31ced79d07..e58a0adeaa 100644 --- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/EnumerationBuilderImpl.java +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/EnumerationBuilderImpl.java @@ -1,365 +1,365 @@ -/* - * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ -package org.opendaylight.controller.sal.binding.generator.impl; - -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; - -import org.opendaylight.controller.sal.binding.model.api.Enumeration; -import org.opendaylight.controller.sal.binding.model.api.Type; -import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; - -final class EnumerationBuilderImpl implements EnumBuilder { - private final String packageName; - private final String name; - private final List values; - - public EnumerationBuilderImpl(final String packageName, final String name) { - super(); - this.packageName = GeneratedTypeBuilderImpl.validatePackage(packageName); - this.name = name; - values = new ArrayList(); - } - - @Override - public void addValue(final String name, final Integer value) { - values.add(new EnumPairImpl(name, value)); - } - - @Override - public Enumeration toInstance(final Type definingType) { - return new EnumerationImpl(definingType, packageName, name, values); - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((packageName == null) ? 0 : packageName.hashCode()); - return result; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) - */ - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - EnumerationBuilderImpl other = (EnumerationBuilderImpl) obj; - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (packageName == null) { - if (other.packageName != null) { - return false; - } - } else if (!packageName.equals(other.packageName)) { - return false; - } - return true; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("EnumerationBuilderImpl [packageName="); - builder.append(packageName); - builder.append(", name="); - builder.append(name); - builder.append(", values="); - builder.append(values); - builder.append("]"); - return builder.toString(); - } - - private static final class EnumPairImpl implements Enumeration.Pair { - - private final String name; - private final Integer value; - - public EnumPairImpl(String name, Integer value) { - super(); - this.name = name; - this.value = value; - } - - @Override - public String getName() { - return name; - } - - @Override - public Integer getValue() { - return value; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result + ((value == null) ? 0 : value.hashCode()); - return result; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) - */ - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - EnumPairImpl other = (EnumPairImpl) obj; - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (value == null) { - if (other.value != null) { - return false; - } - } else if (!value.equals(other.value)) { - return false; - } - return true; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("EnumPairImpl [name="); - builder.append(name); - builder.append(", value="); - builder.append(value); - builder.append("]"); - return builder.toString(); - } - } - - private static final class EnumerationImpl implements Enumeration { - - private final Type definingType; - private final String packageName; - private final String name; - private final List values; - - public EnumerationImpl(final Type definingType, - final String packageName, final String name, - final List values) { - super(); - this.definingType = definingType; - this.packageName = packageName; - this.name = name; - this.values = Collections.unmodifiableList(values); - } - - @Override - public Type getDefiningType() { - return definingType; - } - - @Override - public String getPackageName() { - return packageName; - } - - @Override - public String getName() { - return name; - } - - @Override - public List getValues() { - return values; - } - - @Override - public String toFormattedString() { - StringBuilder builder = new StringBuilder(); - builder.append("public enum"); - builder.append(" "); - builder.append(name); - builder.append(" {"); - builder.append("\n"); - - int i = 0; - for (final Enumeration.Pair valPair : values) { - builder.append("\t"); - builder.append(" "); - builder.append(valPair.getName()); - builder.append(" ("); - builder.append(valPair.getValue()); - - if (i == (values.size() - 1)) { - builder.append(" );"); - } else { - builder.append(" ),"); - } - ++i; - } - return builder.toString(); - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((packageName == null) ? 0 : packageName.hashCode()); - result = prime * result - + ((values == null) ? 0 : values.hashCode()); - - if (definingType != null) { - result = prime - * result - + ((definingType.getPackageName() == null) ? 0 - : definingType.getPackageName().hashCode()); - result = prime - * result - + ((definingType.getName() == null) ? 0 : definingType - .getName().hashCode()); - } - - return result; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) - */ - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - EnumerationImpl other = (EnumerationImpl) obj; - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (packageName == null) { - if (other.packageName != null) { - return false; - } - } else if (!packageName.equals(other.packageName)) { - return false; - } - if (values == null) { - if (other.values != null) { - return false; - } - } else if (!values.equals(other.values)) { - return false; - } - if (definingType == null) { - if (other.definingType != null) { - return false; - } - } else if ((definingType != null) && (other.definingType != null)) { - if (!definingType.getPackageName().equals( - other.definingType.getPackageName()) - && !definingType.getName().equals( - other.definingType.getName())) { - return false; - } - } - return true; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("EnumerationImpl [packageName="); - builder.append(packageName); - if (definingType != null) { - builder.append(", definingType="); - builder.append(definingType.getPackageName()); - builder.append("."); - builder.append(definingType.getName()); - } else { - builder.append(", definingType= null"); - } - builder.append(", name="); - builder.append(name); - builder.append(", values="); - builder.append(values); - builder.append("]"); - return builder.toString(); - } - } -} +/* + * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.controller.sal.binding.generator.impl; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.opendaylight.controller.sal.binding.model.api.Enumeration; +import org.opendaylight.controller.sal.binding.model.api.Type; +import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; + +final class EnumerationBuilderImpl implements EnumBuilder { + private final String packageName; + private final String name; + private final List values; + + public EnumerationBuilderImpl(final String packageName, final String name) { + super(); + this.packageName = packageName; + this.name = name; + values = new ArrayList(); + } + + @Override + public void addValue(final String name, final Integer value) { + values.add(new EnumPairImpl(name, value)); + } + + @Override + public Enumeration toInstance(final Type definingType) { + return new EnumerationImpl(definingType, packageName, name, values); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((packageName == null) ? 0 : packageName.hashCode()); + return result; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + EnumerationBuilderImpl other = (EnumerationBuilderImpl) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (packageName == null) { + if (other.packageName != null) { + return false; + } + } else if (!packageName.equals(other.packageName)) { + return false; + } + return true; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("EnumerationBuilderImpl [packageName="); + builder.append(packageName); + builder.append(", name="); + builder.append(name); + builder.append(", values="); + builder.append(values); + builder.append("]"); + return builder.toString(); + } + + private static final class EnumPairImpl implements Enumeration.Pair { + + private final String name; + private final Integer value; + + public EnumPairImpl(String name, Integer value) { + super(); + this.name = name; + this.value = value; + } + + @Override + public String getName() { + return name; + } + + @Override + public Integer getValue() { + return value; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + ((value == null) ? 0 : value.hashCode()); + return result; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + EnumPairImpl other = (EnumPairImpl) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (value == null) { + if (other.value != null) { + return false; + } + } else if (!value.equals(other.value)) { + return false; + } + return true; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("EnumPairImpl [name="); + builder.append(name); + builder.append(", value="); + builder.append(value); + builder.append("]"); + return builder.toString(); + } + } + + private static final class EnumerationImpl implements Enumeration { + + private final Type definingType; + private final String packageName; + private final String name; + private final List values; + + public EnumerationImpl(final Type definingType, + final String packageName, final String name, + final List values) { + super(); + this.definingType = definingType; + this.packageName = packageName; + this.name = name; + this.values = Collections.unmodifiableList(values); + } + + @Override + public Type getDefiningType() { + return definingType; + } + + @Override + public String getPackageName() { + return packageName; + } + + @Override + public String getName() { + return name; + } + + @Override + public List getValues() { + return values; + } + + @Override + public String toFormattedString() { + StringBuilder builder = new StringBuilder(); + builder.append("public enum"); + builder.append(" "); + builder.append(name); + builder.append(" {"); + builder.append("\n"); + + int i = 0; + for (final Enumeration.Pair valPair : values) { + builder.append("\t"); + builder.append(" "); + builder.append(valPair.getName()); + builder.append(" ("); + builder.append(valPair.getValue()); + + if (i == (values.size() - 1)) { + builder.append(" );"); + } else { + builder.append(" ),"); + } + ++i; + } + return builder.toString(); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((packageName == null) ? 0 : packageName.hashCode()); + result = prime * result + + ((values == null) ? 0 : values.hashCode()); + + if (definingType != null) { + result = prime + * result + + ((definingType.getPackageName() == null) ? 0 + : definingType.getPackageName().hashCode()); + result = prime + * result + + ((definingType.getName() == null) ? 0 : definingType + .getName().hashCode()); + } + + return result; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + EnumerationImpl other = (EnumerationImpl) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (packageName == null) { + if (other.packageName != null) { + return false; + } + } else if (!packageName.equals(other.packageName)) { + return false; + } + if (values == null) { + if (other.values != null) { + return false; + } + } else if (!values.equals(other.values)) { + return false; + } + if (definingType == null) { + if (other.definingType != null) { + return false; + } + } else if ((definingType != null) && (other.definingType != null)) { + if (!definingType.getPackageName().equals( + other.definingType.getPackageName()) + && !definingType.getName().equals( + other.definingType.getName())) { + return false; + } + } + return true; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("EnumerationImpl [packageName="); + builder.append(packageName); + if (definingType != null) { + builder.append(", definingType="); + builder.append(definingType.getPackageName()); + builder.append("."); + builder.append(definingType.getName()); + } else { + builder.append(", definingType= null"); + } + builder.append(", name="); + builder.append(name); + builder.append(", values="); + builder.append(values); + builder.append("]"); + return builder.toString(); + } + } +} diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTOBuilderImpl.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTOBuilderImpl.java index e39889b8ef..ff232f7763 100644 --- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTOBuilderImpl.java +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTOBuilderImpl.java @@ -1,577 +1,559 @@ -/* - * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ -package org.opendaylight.controller.sal.binding.generator.impl; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashSet; -import java.util.List; -import java.util.Set; - -import org.opendaylight.controller.sal.binding.model.api.AccessModifier; -import org.opendaylight.controller.sal.binding.model.api.Constant; -import org.opendaylight.controller.sal.binding.model.api.Enumeration; -import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty; -import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject; -import org.opendaylight.controller.sal.binding.model.api.MethodSignature; -import org.opendaylight.controller.sal.binding.model.api.Type; -import org.opendaylight.controller.sal.binding.model.api.type.builder.ConstantBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedPropertyBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTOBuilder; - -final class GeneratedTOBuilderImpl implements GeneratedTOBuilder { - - private static final String[] SET_VALUES = new String[] { "abstract", - "assert", "boolean", "break", "byte", "case", "catch", "char", - "class", "const", "continue", "default", "double", "do", "else", - "enum", "extends", "false", "final", "finally", "float", "for", - "goto", "if", "implements", "import", "instanceof", "int", - "interface", "long", "native", "new", "null", "package", "private", - "protected", "public", "return", "short", "static", "strictfp", - "super", "switch", "synchronized", "this", "throw", "throws", - "transient", "true", "try", "void", "volatile", "while" }; - - public static final Set JAVA_RESERVED_WORDS = new HashSet( - Arrays.asList(SET_VALUES)); - - private String packageName; - private final String name; - - private final List enumerations = new ArrayList(); - private final List properties = new ArrayList(); - private final List equalsProperties = new ArrayList(); - private final List hashProperties = new ArrayList(); - private final List toStringProperties = new ArrayList(); - - public GeneratedTOBuilderImpl(String packageName, String name) { - super(); - this.packageName = GeneratedTypeBuilderImpl.validatePackage(packageName); - this.name = name; - } - - @Override - public String getPackageName() { - return packageName; - } - - @Override - public String getName() { - return name; - } - - @Override - public EnumBuilder addEnumeration(String name) { - final EnumBuilder builder = new EnumerationBuilderImpl(packageName, - name); - enumerations.add(builder); - return builder; - } - - @Override - public GeneratedPropertyBuilder addProperty(String name) { - final GeneratedPropertyBuilder builder = new GeneratedPropertyBuilderImpl( - name); - properties.add(builder); - return builder; - } - - @Override - public boolean addEqualsIdentity(GeneratedPropertyBuilder property) { - return equalsProperties.add(property); - } - - @Override - public boolean addHashIdentity(GeneratedPropertyBuilder property) { - return hashProperties.add(property); - } - - @Override - public boolean addToStringProperty(GeneratedPropertyBuilder property) { - return toStringProperties.add(property); - } - - @Override - public GeneratedTransferObject toInstance() { - - return new GeneratedTransferObjectImpl(packageName, name, enumerations, - properties, equalsProperties, hashProperties, - toStringProperties); - } - - private static final class GeneratedPropertyBuilderImpl implements - GeneratedPropertyBuilder { - - private final String name; - private Type returnType; - private final List parameters; - private String comment = ""; - private AccessModifier accessModifier; - private boolean isFinal; - private boolean isReadOnly; - - public GeneratedPropertyBuilderImpl(final String name) { - super(); - this.name = name; - parameters = new ArrayList(); - isFinal = true; - this.isReadOnly = true; - accessModifier = AccessModifier.PUBLIC; - } - - public String getName() { - return name; - } - - @Override - public boolean addReturnType(Type returnType) { - if (returnType != null) { - this.returnType = returnType; - this.parameters.add(new MethodParameterImpl(name, returnType)); - return true; - } - return false; - } - - @Override - public void accessorModifier(final AccessModifier modifier) { - accessModifier = modifier; - } - - @Override - public void addComment(String comment) { - if (comment != null) { - this.comment = comment; - } - } - - @Override - public void setFinal(boolean isFinal) { - this.isFinal = isFinal; - } - - @Override - public void setReadOnly(boolean isReadOnly) { - this.isReadOnly = isReadOnly; - } - - @Override - public GeneratedProperty toInstance(final Type definingType) { - return new GeneratedPropertyImpl(name, comment, definingType, - returnType, isFinal, isReadOnly, parameters, accessModifier); - } - } - - private static final class GeneratedPropertyImpl implements - GeneratedProperty { - - private final String name; - private final String comment; - private final Type parent; - private final Type returnType; - private final boolean isFinal; - private final boolean isReadOnly; - private final List parameters; - private final AccessModifier modifier; - - public GeneratedPropertyImpl(final String name, final String comment, - final Type parent, final Type returnType, - final boolean isFinal, final boolean isReadOnly, - final List parameters, final AccessModifier modifier) { - super(); - this.name = name; - this.comment = comment; - this.parent = parent; - this.returnType = returnType; - this.isFinal = isFinal; - this.isReadOnly = isReadOnly; - this.parameters = Collections.unmodifiableList(parameters); - this.modifier = modifier; - } - - @Override - public String getName() { - return name; - } - - @Override - public String getComment() { - return comment; - } - - @Override - public Type getDefiningType() { - return parent; - } - - @Override - public Type getReturnType() { - return returnType; - } - - @Override - public List getParameters() { - return parameters; - } - - @Override - public AccessModifier getAccessModifier() { - return modifier; - } - - @Override - public boolean isReadOnly() { - return isReadOnly; - } - - @Override - public boolean isFinal() { - return isFinal; - } - - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result - + ((comment == null) ? 0 : comment.hashCode()); - result = prime * result + (isFinal ? 1231 : 1237); - result = prime * result + (isReadOnly ? 1231 : 1237); - result = prime * result - + ((modifier == null) ? 0 : modifier.hashCode()); - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((parameters == null) ? 0 : parameters.hashCode()); - - if (parent != null) { - result = prime - * result - + ((parent.getPackageName() == null) ? 0 : parent - .getPackageName().hashCode()); - result = prime - * result - + ((parent.getName() == null) ? 0 : parent.getName() - .hashCode()); - } - - result = prime * result - + ((returnType == null) ? 0 : returnType.hashCode()); - return result; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - GeneratedPropertyImpl other = (GeneratedPropertyImpl) obj; - if (comment == null) { - if (other.comment != null) { - return false; - } - } else if (!comment.equals(other.comment)) { - return false; - } - if (isFinal != other.isFinal) { - return false; - } - if (isReadOnly != other.isReadOnly) { - return false; - } - if (modifier != other.modifier) { - return false; - } - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (parameters == null) { - if (other.parameters != null) { - return false; - } - } else if (!parameters.equals(other.parameters)) { - return false; - } - if (parent == null) { - if (other.parent != null) { - return false; - } - } else if ((parent != null) && (other.parent != null)) { - if (!parent.getPackageName().equals( - other.parent.getPackageName()) - && !parent.getName().equals(other.parent.getName())) { - return false; - } - } - if (returnType == null) { - if (other.returnType != null) { - return false; - } - } else if (!returnType.equals(other.returnType)) { - return false; - } - return true; - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("GeneratedPropertyImpl [name="); - builder.append(name); - builder.append(", comment="); - builder.append(comment); - if (parent != null) { - builder.append(", parent="); - builder.append(parent.getPackageName()); - builder.append("."); - builder.append(parent.getName()); - } else { - builder.append(", parent= null"); - } - builder.append(", returnType="); - builder.append(returnType); - builder.append(", isFinal="); - builder.append(isFinal); - builder.append(", isReadOnly="); - builder.append(isReadOnly); - builder.append(", parameters="); - builder.append(parameters); - builder.append(", modifier="); - builder.append(modifier); - builder.append("]"); - return builder.toString(); - } - } - - private static final class GeneratedTransferObjectImpl implements - GeneratedTransferObject { - - private final String packageName; - private final String name; - // private final List constants; - private final List enumerations; - private final List properties; - private final List equalsProperties; - private final List hashCodeProperties; - private final List stringProperties; - - private List toUnmodifiableEnumerations( - final List enumBuilders) { - final List enumerations = new ArrayList(); - for (final EnumBuilder builder : enumBuilders) { - enumerations.add(builder.toInstance(this)); - } - return Collections.unmodifiableList(enumerations); - } - - private List toUnmodifiableConstant( - final List constBuilders) { - final List constants = new ArrayList(); - for (final ConstantBuilder builder : constBuilders) { - constants.add(builder.toInstance(this)); - } - return Collections.unmodifiableList(constants); - } - - private List toUnmodifiableProperties( - final List propBuilders) { - final List constants = new ArrayList(); - for (final GeneratedPropertyBuilder builder : propBuilders) { - constants.add(builder.toInstance(this)); - } - return Collections.unmodifiableList(constants); - } - - public GeneratedTransferObjectImpl(String packageName, String name, - List enumBuilders, - List propBuilers, - List equalsBuilers, - List hashCodeBuilers, - List stringBuilers) { - super(); - this.packageName = packageName; - this.name = name; - this.enumerations = toUnmodifiableEnumerations(enumBuilders); - this.properties = toUnmodifiableProperties(propBuilers); - this.equalsProperties = toUnmodifiableProperties(equalsBuilers); - this.hashCodeProperties = toUnmodifiableProperties(hashCodeBuilers); - this.stringProperties = toUnmodifiableProperties(stringBuilers); - } - - @Override - public String getPackageName() { - return packageName; - } - - @Override - public String getName() { - return name; - } - - @Override - public List getEnumDefintions() { - return enumerations; - } - - @Override - public List getProperties() { - return properties; - } - - @Override - public List getEqualsIdentifiers() { - return equalsProperties; - } - - @Override - public List getHashCodeIdentifiers() { - return hashCodeProperties; - } - - @Override - public List getToStringIdentifiers() { - return stringProperties; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result - + ((enumerations == null) ? 0 : enumerations.hashCode()); - result = prime - * result - + ((equalsProperties == null) ? 0 : equalsProperties - .hashCode()); - result = prime - * result - + ((hashCodeProperties == null) ? 0 : hashCodeProperties - .hashCode()); - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((packageName == null) ? 0 : packageName.hashCode()); - result = prime * result - + ((properties == null) ? 0 : properties.hashCode()); - result = prime - * result - + ((stringProperties == null) ? 0 : stringProperties - .hashCode()); - return result; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) - */ - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - GeneratedTransferObjectImpl other = (GeneratedTransferObjectImpl) obj; - if (enumerations == null) { - if (other.enumerations != null) { - return false; - } - } else if (!enumerations.equals(other.enumerations)) { - return false; - } - if (equalsProperties == null) { - if (other.equalsProperties != null) { - return false; - } - } else if (!equalsProperties.equals(other.equalsProperties)) { - return false; - } - if (hashCodeProperties == null) { - if (other.hashCodeProperties != null) { - return false; - } - } else if (!hashCodeProperties.equals(other.hashCodeProperties)) { - return false; - } - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (packageName == null) { - if (other.packageName != null) { - return false; - } - } else if (!packageName.equals(other.packageName)) { - return false; - } - if (properties == null) { - if (other.properties != null) { - return false; - } - } else if (!properties.equals(other.properties)) { - return false; - } - if (stringProperties == null) { - if (other.stringProperties != null) { - return false; - } - } else if (!stringProperties.equals(other.stringProperties)) { - return false; - } - return true; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("GeneratedTransferObjectImpl [packageName="); - builder.append(packageName); - builder.append(", name="); - builder.append(name); - builder.append(", enumerations="); - builder.append(enumerations); - builder.append(", properties="); - builder.append(properties); - builder.append(", equalsProperties="); - builder.append(equalsProperties); - builder.append(", hashCodeProperties="); - builder.append(hashCodeProperties); - builder.append(", stringProperties="); - builder.append(stringProperties); - builder.append("]"); - return builder.toString(); - } - } -} +/* + * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.controller.sal.binding.generator.impl; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.opendaylight.controller.sal.binding.model.api.AccessModifier; +import org.opendaylight.controller.sal.binding.model.api.Constant; +import org.opendaylight.controller.sal.binding.model.api.Enumeration; +import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty; +import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject; +import org.opendaylight.controller.sal.binding.model.api.MethodSignature; +import org.opendaylight.controller.sal.binding.model.api.Type; +import org.opendaylight.controller.sal.binding.model.api.type.builder.ConstantBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedPropertyBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTOBuilder; + +final class GeneratedTOBuilderImpl implements GeneratedTOBuilder { + private String packageName; + private final String name; + + private final List enumerations = new ArrayList(); + private final List properties = new ArrayList(); + private final List equalsProperties = new ArrayList(); + private final List hashProperties = new ArrayList(); + private final List toStringProperties = new ArrayList(); + + public GeneratedTOBuilderImpl(String packageName, String name) { + super(); + this.packageName = packageName; + this.name = name; + } + + @Override + public String getPackageName() { + return packageName; + } + + @Override + public String getName() { + return name; + } + + @Override + public EnumBuilder addEnumeration(String name) { + final EnumBuilder builder = new EnumerationBuilderImpl(packageName, + name); + enumerations.add(builder); + return builder; + } + + @Override + public GeneratedPropertyBuilder addProperty(String name) { + final GeneratedPropertyBuilder builder = new GeneratedPropertyBuilderImpl( + name); + properties.add(builder); + return builder; + } + + @Override + public boolean addEqualsIdentity(GeneratedPropertyBuilder property) { + return equalsProperties.add(property); + } + + @Override + public boolean addHashIdentity(GeneratedPropertyBuilder property) { + return hashProperties.add(property); + } + + @Override + public boolean addToStringProperty(GeneratedPropertyBuilder property) { + return toStringProperties.add(property); + } + + @Override + public GeneratedTransferObject toInstance() { + return new GeneratedTransferObjectImpl(packageName, name, enumerations, + properties, equalsProperties, hashProperties, + toStringProperties); + } + + private static final class GeneratedPropertyBuilderImpl implements + GeneratedPropertyBuilder { + + private final String name; + private Type returnType; + private final List parameters; + private String comment = ""; + private AccessModifier accessModifier; + private boolean isFinal; + private boolean isReadOnly; + + public GeneratedPropertyBuilderImpl(final String name) { + super(); + this.name = name; + parameters = new ArrayList(); + isFinal = true; + this.isReadOnly = true; + accessModifier = AccessModifier.PUBLIC; + } + + public String getName() { + return name; + } + + @Override + public boolean addReturnType(Type returnType) { + if (returnType != null) { + this.returnType = returnType; + this.parameters.add(new MethodParameterImpl(name, returnType)); + return true; + } + return false; + } + + @Override + public void accessorModifier(final AccessModifier modifier) { + accessModifier = modifier; + } + + @Override + public void addComment(String comment) { + if (comment != null) { + this.comment = comment; + } + } + + @Override + public void setFinal(boolean isFinal) { + this.isFinal = isFinal; + } + + @Override + public void setReadOnly(boolean isReadOnly) { + this.isReadOnly = isReadOnly; + } + + @Override + public GeneratedProperty toInstance(final Type definingType) { + return new GeneratedPropertyImpl(name, comment, definingType, + returnType, isFinal, isReadOnly, parameters, accessModifier); + } + } + + private static final class GeneratedPropertyImpl implements + GeneratedProperty { + + private final String name; + private final String comment; + private final Type parent; + private final Type returnType; + private final boolean isFinal; + private final boolean isReadOnly; + private final List parameters; + private final AccessModifier modifier; + + public GeneratedPropertyImpl(final String name, final String comment, + final Type parent, final Type returnType, + final boolean isFinal, final boolean isReadOnly, + final List parameters, final AccessModifier modifier) { + super(); + this.name = name; + this.comment = comment; + this.parent = parent; + this.returnType = returnType; + this.isFinal = isFinal; + this.isReadOnly = isReadOnly; + this.parameters = Collections.unmodifiableList(parameters); + this.modifier = modifier; + } + + @Override + public String getName() { + return name; + } + + @Override + public String getComment() { + return comment; + } + + @Override + public Type getDefiningType() { + return parent; + } + + @Override + public Type getReturnType() { + return returnType; + } + + @Override + public List getParameters() { + return parameters; + } + + @Override + public AccessModifier getAccessModifier() { + return modifier; + } + + @Override + public boolean isReadOnly() { + return isReadOnly; + } + + @Override + public boolean isFinal() { + return isFinal; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + + ((comment == null) ? 0 : comment.hashCode()); + result = prime * result + (isFinal ? 1231 : 1237); + result = prime * result + (isReadOnly ? 1231 : 1237); + result = prime * result + + ((modifier == null) ? 0 : modifier.hashCode()); + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((parameters == null) ? 0 : parameters.hashCode()); + + if (parent != null) { + result = prime + * result + + ((parent.getPackageName() == null) ? 0 : parent + .getPackageName().hashCode()); + result = prime + * result + + ((parent.getName() == null) ? 0 : parent.getName() + .hashCode()); + } + + result = prime * result + + ((returnType == null) ? 0 : returnType.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + GeneratedPropertyImpl other = (GeneratedPropertyImpl) obj; + if (comment == null) { + if (other.comment != null) { + return false; + } + } else if (!comment.equals(other.comment)) { + return false; + } + if (isFinal != other.isFinal) { + return false; + } + if (isReadOnly != other.isReadOnly) { + return false; + } + if (modifier != other.modifier) { + return false; + } + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (parameters == null) { + if (other.parameters != null) { + return false; + } + } else if (!parameters.equals(other.parameters)) { + return false; + } + if (parent == null) { + if (other.parent != null) { + return false; + } + } else if ((parent != null) && (other.parent != null)) { + if (!parent.getPackageName().equals( + other.parent.getPackageName()) + && !parent.getName().equals(other.parent.getName())) { + return false; + } + } + if (returnType == null) { + if (other.returnType != null) { + return false; + } + } else if (!returnType.equals(other.returnType)) { + return false; + } + return true; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("GeneratedPropertyImpl [name="); + builder.append(name); + builder.append(", comment="); + builder.append(comment); + if (parent != null) { + builder.append(", parent="); + builder.append(parent.getPackageName()); + builder.append("."); + builder.append(parent.getName()); + } else { + builder.append(", parent= null"); + } + builder.append(", returnType="); + builder.append(returnType); + builder.append(", isFinal="); + builder.append(isFinal); + builder.append(", isReadOnly="); + builder.append(isReadOnly); + builder.append(", parameters="); + builder.append(parameters); + builder.append(", modifier="); + builder.append(modifier); + builder.append("]"); + return builder.toString(); + } + } + + private static final class GeneratedTransferObjectImpl implements + GeneratedTransferObject { + + private final String packageName; + private final String name; + // private final List constants; + private final List enumerations; + private final List properties; + private final List equalsProperties; + private final List hashCodeProperties; + private final List stringProperties; + + private List toUnmodifiableEnumerations( + final List enumBuilders) { + final List enumerations = new ArrayList(); + for (final EnumBuilder builder : enumBuilders) { + enumerations.add(builder.toInstance(this)); + } + return Collections.unmodifiableList(enumerations); + } + + private List toUnmodifiableConstant( + final List constBuilders) { + final List constants = new ArrayList(); + for (final ConstantBuilder builder : constBuilders) { + constants.add(builder.toInstance(this)); + } + return Collections.unmodifiableList(constants); + } + + private List toUnmodifiableProperties( + final List propBuilders) { + final List constants = new ArrayList(); + for (final GeneratedPropertyBuilder builder : propBuilders) { + constants.add(builder.toInstance(this)); + } + return Collections.unmodifiableList(constants); + } + + public GeneratedTransferObjectImpl(String packageName, String name, + List enumBuilders, + List propBuilers, + List equalsBuilers, + List hashCodeBuilers, + List stringBuilers) { + super(); + this.packageName = packageName; + this.name = name; + this.enumerations = toUnmodifiableEnumerations(enumBuilders); + this.properties = toUnmodifiableProperties(propBuilers); + this.equalsProperties = toUnmodifiableProperties(equalsBuilers); + this.hashCodeProperties = toUnmodifiableProperties(hashCodeBuilers); + this.stringProperties = toUnmodifiableProperties(stringBuilers); + } + + @Override + public String getPackageName() { + return packageName; + } + + @Override + public String getName() { + return name; + } + + @Override + public List getEnumDefintions() { + return enumerations; + } + + @Override + public List getProperties() { + return properties; + } + + @Override + public List getEqualsIdentifiers() { + return equalsProperties; + } + + @Override + public List getHashCodeIdentifiers() { + return hashCodeProperties; + } + + @Override + public List getToStringIdentifiers() { + return stringProperties; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + + ((enumerations == null) ? 0 : enumerations.hashCode()); + result = prime + * result + + ((equalsProperties == null) ? 0 : equalsProperties + .hashCode()); + result = prime + * result + + ((hashCodeProperties == null) ? 0 : hashCodeProperties + .hashCode()); + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((packageName == null) ? 0 : packageName.hashCode()); + result = prime * result + + ((properties == null) ? 0 : properties.hashCode()); + result = prime + * result + + ((stringProperties == null) ? 0 : stringProperties + .hashCode()); + return result; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + GeneratedTransferObjectImpl other = (GeneratedTransferObjectImpl) obj; + if (enumerations == null) { + if (other.enumerations != null) { + return false; + } + } else if (!enumerations.equals(other.enumerations)) { + return false; + } + if (equalsProperties == null) { + if (other.equalsProperties != null) { + return false; + } + } else if (!equalsProperties.equals(other.equalsProperties)) { + return false; + } + if (hashCodeProperties == null) { + if (other.hashCodeProperties != null) { + return false; + } + } else if (!hashCodeProperties.equals(other.hashCodeProperties)) { + return false; + } + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (packageName == null) { + if (other.packageName != null) { + return false; + } + } else if (!packageName.equals(other.packageName)) { + return false; + } + if (properties == null) { + if (other.properties != null) { + return false; + } + } else if (!properties.equals(other.properties)) { + return false; + } + if (stringProperties == null) { + if (other.stringProperties != null) { + return false; + } + } else if (!stringProperties.equals(other.stringProperties)) { + return false; + } + return true; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("GeneratedTransferObjectImpl [packageName="); + builder.append(packageName); + builder.append(", name="); + builder.append(name); + builder.append(", enumerations="); + builder.append(enumerations); + builder.append(", properties="); + builder.append(properties); + builder.append(", equalsProperties="); + builder.append(equalsProperties); + builder.append(", hashCodeProperties="); + builder.append(hashCodeProperties); + builder.append(", stringProperties="); + builder.append(stringProperties); + builder.append("]"); + return builder.toString(); + } + } +} diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTypeBuilderImpl.java b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTypeBuilderImpl.java index f6ed8f2d35..2de2aaa332 100644 --- a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTypeBuilderImpl.java +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/main/java/org/opendaylight/controller/sal/binding/generator/impl/GeneratedTypeBuilderImpl.java @@ -1,543 +1,504 @@ -/* - * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ -package org.opendaylight.controller.sal.binding.generator.impl; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashSet; -import java.util.List; -import java.util.Set; - -import org.opendaylight.controller.sal.binding.model.api.AccessModifier; -import org.opendaylight.controller.sal.binding.model.api.Constant; -import org.opendaylight.controller.sal.binding.model.api.Enumeration; -import org.opendaylight.controller.sal.binding.model.api.GeneratedType; -import org.opendaylight.controller.sal.binding.model.api.MethodSignature; -import org.opendaylight.controller.sal.binding.model.api.Type; -import org.opendaylight.controller.sal.binding.model.api.type.builder.ConstantBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTypeBuilder; -import org.opendaylight.controller.sal.binding.model.api.type.builder.MethodSignatureBuilder; - -public final class GeneratedTypeBuilderImpl implements GeneratedTypeBuilder { - - private static final String[] SET_VALUES = new String[] { "abstract", - "assert", "boolean", "break", "byte", "case", "catch", "char", - "class", "const", "continue", "default", "double", "do", "else", - "enum", "extends", "false", "final", "finally", "float", "for", - "goto", "if", "implements", "import", "instanceof", "int", - "interface", "long", "native", "new", "null", "package", "private", - "protected", "public", "return", "short", "static", "strictfp", - "super", "switch", "synchronized", "this", "throw", "throws", - "transient", "true", "try", "void", "volatile", "while" }; - - public static final Set JAVA_RESERVED_WORDS = new HashSet( - Arrays.asList(SET_VALUES)); - - private String packageName; - private String comment; - private final String name; - private final List enumDefinitions = new ArrayList(); - private final List constantDefintions = new ArrayList(); - private final List methodDefinitions = new ArrayList(); - - public GeneratedTypeBuilderImpl(final String packageName, final String name) { - this.packageName = validatePackage(packageName); - this.name = name; - } - - public static String validatePackage(final String packageName) { - if (packageName != null) { - final String[] packNameParts = packageName.split("\\."); - if (packNameParts != null) { - final StringBuilder builder = new StringBuilder(); - for (int i = 0; i < packNameParts.length; ++i) { - if (JAVA_RESERVED_WORDS.contains(packNameParts[i])) { - packNameParts[i] = "_" + packNameParts[i]; - } - if (i > 0) { - builder.append("."); - } - - builder.append(packNameParts[i]); - } - return builder.toString(); - } - } - return packageName; - } - - @Override - public Type getParentType() { - return this; - } - - @Override - public String getPackageName() { - return packageName; - } - - @Override - public String getName() { - return name; - } - - @Override - public void addComment(String comment) { - this.comment = comment; - } - - @Override - public ConstantBuilder addConstant(Type type, String name, Object value) { - final ConstantBuilder builder = new ConstantBuilderImpl(type, name, - value); - constantDefintions.add(builder); - - return builder; - } - - @Override - public EnumBuilder addEnumeration(final String name) { - final EnumBuilder builder = new EnumerationBuilderImpl(packageName, - name); - enumDefinitions.add(builder); - return builder; - } - - @Override - public MethodSignatureBuilder addMethod(final String name) { - final MethodSignatureBuilder builder = new MethodSignatureBuilderImpl( - this, name); - methodDefinitions.add(builder); - return builder; - } - - @Override - public GeneratedType toInstance() { - packageName = (packageName); - - return new GeneratedTypeImpl(this, packageName, name, enumDefinitions, - constantDefintions, methodDefinitions); - } - - private static final class MethodSignatureBuilderImpl implements - MethodSignatureBuilder { - private final String name; - private Type returnType; - private final List parameters; - private String comment = ""; - private final Type parent; - - public MethodSignatureBuilderImpl(final Type parent, final String name) { - super(); - this.name = name; - this.parent = parent; - parameters = new ArrayList(); - // TODO: move implementation elsewhere! - - } - - @Override - public void addReturnType(Type returnType) { - if (returnType != null) { - this.returnType = returnType; - } - } - - @Override - public void addParameter(Type type, String name) { - parameters.add(new MethodParameterImpl(name, type)); - } - - @Override - public void addComment(String comment) { - this.comment = comment; - } - - @Override - public MethodSignature toInstance(Type definingType) { - return new MethodSignatureImpl(definingType, name, comment, - returnType, parameters); - } - - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result + ((name == null) ? 0 : name.hashCode()); - return result; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - MethodSignatureBuilderImpl other = (MethodSignatureBuilderImpl) obj; - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - return true; - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("MethodBuilderImpl [name="); - builder.append(name); - builder.append(", returnType="); - builder.append(returnType); - builder.append(", parameters="); - builder.append(parameters); - builder.append(", comment="); - builder.append(comment); - builder.append(", parent="); - builder.append(parent.getName()); - builder.append("]"); - return builder.toString(); - } - - } - - private static final class MethodSignatureImpl implements MethodSignature { - - private final String name; - private final String comment; - private final Type definingType; - private final Type returnType; - private final List params; - - public MethodSignatureImpl(final Type definingType, final String name, - final String comment, final Type returnType, - final List params) { - super(); - this.name = name; - this.comment = comment; - this.definingType = definingType; - this.returnType = returnType; - this.params = Collections.unmodifiableList(params); - } - - @Override - public String getName() { - return name; - } - - @Override - public String getComment() { - return comment; - } - - @Override - public Type getDefiningType() { - return definingType; - } - - @Override - public Type getReturnType() { - return returnType; - } - - @Override - public List getParameters() { - return params; - } - - @Override - public AccessModifier getAccessModifier() { - return AccessModifier.PUBLIC; - } - - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime * result - + ((comment == null) ? 0 : comment.hashCode()); - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((params == null) ? 0 : params.hashCode()); - result = prime * result - + ((returnType == null) ? 0 : returnType.hashCode()); - - if (definingType != null) { - result = prime - * result - + ((definingType.getPackageName() == null) ? 0 - : definingType.getPackageName().hashCode()); - result = prime - * result - + ((definingType.getName() == null) ? 0 : definingType - .getName().hashCode()); - } - - return result; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - MethodSignatureImpl other = (MethodSignatureImpl) obj; - if (comment == null) { - if (other.comment != null) { - return false; - } - } else if (!comment.equals(other.comment)) { - return false; - } - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (params == null) { - if (other.params != null) { - return false; - } - } else if (!params.equals(other.params)) { - return false; - } - if (definingType == null) { - if (other.definingType != null) { - return false; - } - } else if ((definingType != null) && (other.definingType != null)) { - if (!definingType.getPackageName().equals( - other.definingType.getPackageName()) - && !definingType.getName().equals( - other.definingType.getName())) { - return false; - } - } - if (returnType == null) { - if (other.returnType != null) { - return false; - } - } else if (!returnType.equals(other.returnType)) { - return false; - } - return true; - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("MethodImpl [name="); - builder.append(name); - builder.append(", comment="); - builder.append(comment); - if (definingType != null) { - builder.append(", definingType="); - builder.append(definingType.getPackageName()); - builder.append("."); - builder.append(definingType.getName()); - } else { - builder.append(", definingType= null"); - } - builder.append(", returnType="); - builder.append(returnType); - builder.append(", params="); - builder.append(params); - builder.append("]"); - return builder.toString(); - } - } - - private static final class GeneratedTypeImpl implements GeneratedType { - - private final Type parent; - private final String packageName; - private final String name; - private final List enumDefinitions; - private final List constantDefintions; - private final List methodDefinitions; - - public GeneratedTypeImpl(final Type parent, final String packageName, - final String name, final List enumBuilders, - final List constantBuilders, - final List methodBuilders) { - super(); - this.parent = parent; - this.packageName = packageName; - this.name = name; - - this.constantDefintions = toUnmodifiableConstants(constantBuilders); - this.enumDefinitions = toUnmodifiableEnums(enumBuilders); - this.methodDefinitions = toUnmodifiableMethods(methodBuilders); - } - - private List toUnmodifiableMethods( - List methodBuilders) { - final List methods = new ArrayList(); - for (final MethodSignatureBuilder methodBuilder : methodBuilders) { - methods.add(methodBuilder.toInstance(this)); - } - return Collections.unmodifiableList(methods); - } - - private List toUnmodifiableEnums( - List enumBuilders) { - final List enums = new ArrayList(); - for (final EnumBuilder enumBuilder : enumBuilders) { - enums.add(enumBuilder.toInstance(this)); - } - return Collections.unmodifiableList(enums); - } - - private List toUnmodifiableConstants( - List constantBuilders) { - final List constants = new ArrayList(); - for (final ConstantBuilder enumBuilder : constantBuilders) { - constants.add(enumBuilder.toInstance(this)); - } - return Collections.unmodifiableList(constants); - } - - @Override - public String getPackageName() { - return packageName; - } - - @Override - public String getName() { - return name; - } - - @Override - public Type getParentType() { - return parent; - } - - @Override - public List getEnumDefintions() { - return enumDefinitions; - } - - @Override - public List getConstantDefinitions() { - return constantDefintions; - } - - @Override - public List getMethodDefinitions() { - return methodDefinitions; - } - - @Override - public int hashCode() { - final int prime = 31; - int result = 1; - result = prime - * result - + ((constantDefintions == null) ? 0 : constantDefintions - .hashCode()); - result = prime - * result - + ((enumDefinitions == null) ? 0 : enumDefinitions - .hashCode()); - result = prime - * result - + ((methodDefinitions == null) ? 0 : methodDefinitions - .hashCode()); - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result - + ((packageName == null) ? 0 : packageName.hashCode()); - return result; - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - GeneratedTypeImpl other = (GeneratedTypeImpl) obj; - if (constantDefintions == null) { - if (other.constantDefintions != null) { - return false; - } - } else if (!constantDefintions.equals(other.constantDefintions)) { - return false; - } - if (enumDefinitions == null) { - if (other.enumDefinitions != null) { - return false; - } - } else if (!enumDefinitions.equals(other.enumDefinitions)) { - return false; - } - if (methodDefinitions == null) { - if (other.methodDefinitions != null) { - return false; - } - } else if (!methodDefinitions.equals(other.methodDefinitions)) { - return false; - } - if (name == null) { - if (other.name != null) { - return false; - } - } else if (!name.equals(other.name)) { - return false; - } - if (packageName == null) { - if (other.packageName != null) { - return false; - } - } else if (!packageName.equals(other.packageName)) { - return false; - } - return true; - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("GeneratedTypeImpl [parent="); - builder.append(parent.getName()); - builder.append(", packageName="); - builder.append(packageName); - builder.append(", name="); - builder.append(name); - builder.append(", enumDefinitions="); - builder.append(enumDefinitions); - builder.append(", constantDefintions="); - builder.append(constantDefintions); - builder.append(", methodDefinitions="); - builder.append(methodDefinitions); - builder.append("]"); - return builder.toString(); - } - } -} +/* + * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ +package org.opendaylight.controller.sal.binding.generator.impl; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.opendaylight.controller.sal.binding.model.api.AccessModifier; +import org.opendaylight.controller.sal.binding.model.api.Constant; +import org.opendaylight.controller.sal.binding.model.api.Enumeration; +import org.opendaylight.controller.sal.binding.model.api.GeneratedType; +import org.opendaylight.controller.sal.binding.model.api.MethodSignature; +import org.opendaylight.controller.sal.binding.model.api.Type; +import org.opendaylight.controller.sal.binding.model.api.type.builder.ConstantBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.EnumBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.GeneratedTypeBuilder; +import org.opendaylight.controller.sal.binding.model.api.type.builder.MethodSignatureBuilder; + +public final class GeneratedTypeBuilderImpl implements GeneratedTypeBuilder { + + private final String packageName; + private String comment; + private final String name; + private final List enumDefinitions = new ArrayList(); + private final List constantDefintions = new ArrayList(); + private final List methodDefinitions = new ArrayList(); + + public GeneratedTypeBuilderImpl(final String packageName, final String name) { + this.packageName = packageName; + this.name = name; + } + + @Override + public Type getParentType() { + return this; + } + + @Override + public String getPackageName() { + return packageName; + } + + @Override + public String getName() { + return name; + } + + @Override + public void addComment(String comment) { + this.comment = comment; + } + + @Override + public ConstantBuilder addConstant(Type type, String name, Object value) { + final ConstantBuilder builder = new ConstantBuilderImpl(type, name, + value); + constantDefintions.add(builder); + + return builder; + } + + @Override + public EnumBuilder addEnumeration(final String name) { + final EnumBuilder builder = new EnumerationBuilderImpl(packageName, + name); + enumDefinitions.add(builder); + return builder; + } + + @Override + public MethodSignatureBuilder addMethod(final String name) { + final MethodSignatureBuilder builder = new MethodSignatureBuilderImpl( + this, name); + methodDefinitions.add(builder); + return builder; + } + + @Override + public GeneratedType toInstance() { + return new GeneratedTypeImpl(this, packageName, name, enumDefinitions, + constantDefintions, methodDefinitions); + } + + private static final class MethodSignatureBuilderImpl implements + MethodSignatureBuilder { + private final String name; + private Type returnType; + private final List parameters; + private String comment = ""; + private final Type parent; + + public MethodSignatureBuilderImpl(final Type parent, final String name) { + super(); + this.name = name; + this.parent = parent; + parameters = new ArrayList(); + //TODO: move implementation elsewhere! + + } + + @Override + public void addReturnType(Type returnType) { + if (returnType != null) { + this.returnType = returnType; + } + } + + @Override + public void addParameter(Type type, String name) { + parameters.add(new MethodParameterImpl(name, type)); + } + + @Override + public void addComment(String comment) { + this.comment = comment; + } + + @Override + public MethodSignature toInstance(Type definingType) { + return new MethodSignatureImpl(definingType, name, comment, + returnType, parameters); + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((name == null) ? 0 : name.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + MethodSignatureBuilderImpl other = (MethodSignatureBuilderImpl) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + return true; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("MethodBuilderImpl [name="); + builder.append(name); + builder.append(", returnType="); + builder.append(returnType); + builder.append(", parameters="); + builder.append(parameters); + builder.append(", comment="); + builder.append(comment); + builder.append(", parent="); + builder.append(parent.getName()); + builder.append("]"); + return builder.toString(); + } + + } + + private static final class MethodSignatureImpl implements MethodSignature { + + private final String name; + private final String comment; + private final Type definingType; + private final Type returnType; + private final List params; + + public MethodSignatureImpl(final Type definingType, final String name, + final String comment, final Type returnType, + final List params) { + super(); + this.name = name; + this.comment = comment; + this.definingType = definingType; + this.returnType = returnType; + this.params = Collections.unmodifiableList(params); + } + + @Override + public String getName() { + return name; + } + + @Override + public String getComment() { + return comment; + } + + @Override + public Type getDefiningType() { + return definingType; + } + + @Override + public Type getReturnType() { + return returnType; + } + + @Override + public List getParameters() { + return params; + } + + @Override + public AccessModifier getAccessModifier() { + return AccessModifier.PUBLIC; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + + ((comment == null) ? 0 : comment.hashCode()); + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((params == null) ? 0 : params.hashCode()); + result = prime * result + + ((returnType == null) ? 0 : returnType.hashCode()); + + if (definingType != null) { + result = prime + * result + + ((definingType.getPackageName() == null) ? 0 + : definingType.getPackageName().hashCode()); + result = prime + * result + + ((definingType.getName() == null) ? 0 : definingType + .getName().hashCode()); + } + + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + MethodSignatureImpl other = (MethodSignatureImpl) obj; + if (comment == null) { + if (other.comment != null) { + return false; + } + } else if (!comment.equals(other.comment)) { + return false; + } + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (params == null) { + if (other.params != null) { + return false; + } + } else if (!params.equals(other.params)) { + return false; + } + if (definingType == null) { + if (other.definingType != null) { + return false; + } + } else if ((definingType != null) && (other.definingType != null)) { + if (!definingType.getPackageName().equals( + other.definingType.getPackageName()) + && !definingType.getName().equals( + other.definingType.getName())) { + return false; + } + } + if (returnType == null) { + if (other.returnType != null) { + return false; + } + } else if (!returnType.equals(other.returnType)) { + return false; + } + return true; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("MethodImpl [name="); + builder.append(name); + builder.append(", comment="); + builder.append(comment); + if (definingType != null) { + builder.append(", definingType="); + builder.append(definingType.getPackageName()); + builder.append("."); + builder.append(definingType.getName()); + } else { + builder.append(", definingType= null"); + } + builder.append(", returnType="); + builder.append(returnType); + builder.append(", params="); + builder.append(params); + builder.append("]"); + return builder.toString(); + } + } + + private static final class GeneratedTypeImpl implements GeneratedType { + + private final Type parent; + private final String packageName; + private final String name; + private final List enumDefinitions; + private final List constantDefintions; + private final List methodDefinitions; + + public GeneratedTypeImpl(final Type parent, final String packageName, + final String name, final List enumBuilders, + final List constantBuilders, + final List methodBuilders) { + super(); + this.parent = parent; + this.packageName = packageName; + this.name = name; + + this.constantDefintions = toUnmodifiableConstants(constantBuilders); + this.enumDefinitions = toUnmodifiableEnums(enumBuilders); + this.methodDefinitions = toUnmodifiableMethods(methodBuilders); + } + + private List toUnmodifiableMethods( + List methodBuilders) { + final List methods = new ArrayList(); + for (final MethodSignatureBuilder methodBuilder : methodBuilders) { + methods.add(methodBuilder.toInstance(this)); + } + return Collections.unmodifiableList(methods); + } + + private List toUnmodifiableEnums( + List enumBuilders) { + final List enums = new ArrayList(); + for (final EnumBuilder enumBuilder : enumBuilders) { + enums.add(enumBuilder.toInstance(this)); + } + return Collections.unmodifiableList(enums); + } + + private List toUnmodifiableConstants( + List constantBuilders) { + final List constants = new ArrayList(); + for (final ConstantBuilder enumBuilder : constantBuilders) { + constants.add(enumBuilder.toInstance(this)); + } + return Collections.unmodifiableList(constants); + } + + @Override + public String getPackageName() { + return packageName; + } + + @Override + public String getName() { + return name; + } + + @Override + public Type getParentType() { + return parent; + } + + @Override + public List getEnumDefintions() { + return enumDefinitions; + } + + @Override + public List getConstantDefinitions() { + return constantDefintions; + } + + @Override + public List getMethodDefinitions() { + return methodDefinitions; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime + * result + + ((constantDefintions == null) ? 0 : constantDefintions + .hashCode()); + result = prime + * result + + ((enumDefinitions == null) ? 0 : enumDefinitions + .hashCode()); + result = prime + * result + + ((methodDefinitions == null) ? 0 : methodDefinitions + .hashCode()); + result = prime * result + ((name == null) ? 0 : name.hashCode()); + result = prime * result + + ((packageName == null) ? 0 : packageName.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + GeneratedTypeImpl other = (GeneratedTypeImpl) obj; + if (constantDefintions == null) { + if (other.constantDefintions != null) { + return false; + } + } else if (!constantDefintions.equals(other.constantDefintions)) { + return false; + } + if (enumDefinitions == null) { + if (other.enumDefinitions != null) { + return false; + } + } else if (!enumDefinitions.equals(other.enumDefinitions)) { + return false; + } + if (methodDefinitions == null) { + if (other.methodDefinitions != null) { + return false; + } + } else if (!methodDefinitions.equals(other.methodDefinitions)) { + return false; + } + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (packageName == null) { + if (other.packageName != null) { + return false; + } + } else if (!packageName.equals(other.packageName)) { + return false; + } + return true; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("GeneratedTypeImpl [parent="); + builder.append(parent.getName()); + builder.append(", packageName="); + builder.append(packageName); + builder.append(", name="); + builder.append(name); + builder.append(", enumDefinitions="); + builder.append(enumDefinitions); + builder.append(", constantDefintions="); + builder.append(constantDefintions); + builder.append(", methodDefinitions="); + builder.append(methodDefinitions); + builder.append("]"); + return builder.toString(); + } + } +} diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/abstract-topology@2013-02-08.yang b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/abstract-topology@2013-02-08.yang new file mode 100644 index 0000000000..7ed1f99503 --- /dev/null +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/abstract-topology@2013-02-08.yang @@ -0,0 +1,141 @@ +module abstract-topology { + yang-version 1; + namespace "urn:model:abstract:topology"; + prefix "tp"; + + import ietf-inet-types { + prefix "inet"; + revision-date 2010-09-24; + } + + import ietf-interfaces { + prefix "if"; + revision-date 2012-11-15; + } + + organization "Cisco"; + contact "WILL-BE-DEFINED-LATER"; + + description + "This module contains the definitions of elements that creates network + topology i.e. definition of network nodes and links. This module is not designed to be used solely for network representation. This module SHOULD be used as base module in defining the network topology."; + + revision "2013-02-08" { + reference "~~~ WILL BE DEFINED LATER"; + } + + revision "2013-01-01" { + reference "~~~ WILL BE DEFINED LATER"; + } + + typedef node-id-ref { + type leafref { + path "/tp:topology/tp:network-nodes/tp:network-node/tp:node-id"; + } + description "This type is used for leafs that reference network node instance."; + } + + typedef link-id-ref { + type leafref { + path "/tp:topology/tp:network-links/tp:network-link/tp:link-id"; + } + description "This type is used for leafs that reference network link instance."; + } + + typedef interface-id-ref { + type leafref { + path "/tp:topology/tp:interfaces/tp:interface/tp:interface-id"; + } + } + + container topology { + description "This is the model of abstract topology which contains only Network Nodes and Network Links. Each topology MUST be identified by unique topology-id for reason that the store could contain many topologies."; + + leaf topology-id { + type inet:uri; + description "It is presumed that datastore will contain many topologies. To distinguish between topologies it is vital to have + UNIQUE topology identifier."; + } + + container network-nodes { + list network-node { + key "node-id"; + + leaf node-id { + type inet:uri; + description "The Topology identifier of network-node."; + } + + container attributes { + description "Aditional attributes that can Network Node contains."; + } + description "The list of network nodes defined for topology."; + } + } + + container interfaces { + list interface { + key "interface-id"; + + leaf interface-id { + type leafref { + path "/if:interfaces/if:interface/if:name"; + } + } + + leaf-list higher-layer-if { + type leafref { + path "/if:interfaces/if:interface/if:higher-layer-if"; + } + } + } + } + + container network-links { + list network-link { + key "link-id"; + + leaf link-id { + type inet:uri; + description ""; + } + + container source-node { + leaf id { + type node-id-ref; + description "Source node identifier."; + } + } + + container destination-node { + leaf id { + type node-id-ref; + description "Destination node identifier."; + } + } + + container tunnels { + list tunnel { + key "tunnel-id"; + + leaf tunnel-id { + type leafref { + path "../../../link-id"; + } + } + } + } + + leaf interface { + type interface-id-ref; + } + + container attributes { + description "Aditional attributes that can Network Link contains."; + } + description "The Network Link which is defined by Local (Source) and Remote (Destination) Network Nodes. Every link MUST be defined either by identifier and + his local and remote Network Nodes (In real applications it is common that many links are originated from one node and end up in same remote node). To ensure that we would always know to distinguish between links, every link SHOULD have identifier."; + } + } + } +} \ No newline at end of file diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/iana-if-type@2012-06-05.yang b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/iana-if-type@2012-06-05.yang new file mode 100644 index 0000000000..a7fa137a7e --- /dev/null +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/iana-if-type@2012-06-05.yang @@ -0,0 +1,1516 @@ +module iana-if-type { + namespace "urn:ietf:params:xml:ns:yang:iana-if-type"; + prefix ianaift; + + organization "IANA"; + contact + " Internet Assigned Numbers Authority + + Postal: ICANN + 4676 Admiralty Way, Suite 330 + Marina del Rey, CA 90292 + + Tel: +1 310 823 9358 + E-Mail: iana&iana.org"; + description + "This YANG module defines the iana-if-type typedef, which + contains YANG definitions for IANA-registered interface types. + + This YANG module is maintained by IANA, and reflects the + 'ifType definitions' registry. + + The latest revision of this YANG module can be obtained from + the IANA web site. + + Copyright (c) 2011 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject + to the license terms contained in, the Simplified BSD License + set forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC XXXX; see + the RFC itself for full legal notices."; + // RFC Ed.: replace XXXX with actual RFC number and remove this + // note. + + // RFC Ed.: update the date below with the date of RFC publication + // and remove this note. + revision 2012-06-05 { + description + "Initial revision."; + reference + "RFC XXXX: TITLE"; + } + + typedef iana-if-type { + type enumeration { + enum "other" { + value 1; + description + "None of the following"; + } + enum "regular1822" { + value 2; + } + enum "hdh1822" { + value 3; + } + enum "ddnX25" { + value 4; + } + enum "rfc877x25" { + value 5; + reference + "RFC 1382 - SNMP MIB Extension for the X.25 Packet Layer"; + } + enum "ethernetCsmacd" { + value 6; + description + "For all ethernet-like interfaces, regardless of speed, + as per RFC3635."; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "iso88023Csmacd" { + value 7; + status deprecated; + description + "Deprecated via RFC3635. + Use ethernetCsmacd(6) instead."; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "iso88024TokenBus" { + value 8; + } + enum "iso88025TokenRing" { + value 9; + } + enum "iso88026Man" { + value 10; + } + enum "starLan" { + value 11; + status deprecated; + description + "Deprecated via RFC3635. + Use ethernetCsmacd(6) instead."; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "proteon10Mbit" { + value 12; + } + enum "proteon80Mbit" { + value 13; + } + enum "hyperchannel" { + value 14; + } + enum "fddi" { + value 15; + reference + "RFC 1512 - FDDI Management Information Base"; + } + enum "lapb" { + value 16; + reference + "RFC 1381 - SNMP MIB Extension for X.25 LAPB"; + } + enum "sdlc" { + value 17; + } + enum "ds1" { + value 18; + description + "DS1-MIB"; + reference + "RFC 4805 - Definitions of Managed Objects for the + DS1, J1, E1, DS2, and E2 Interface Types"; + } + enum "e1" { + value 19; + status obsolete; + description + "Obsolete see DS1-MIB"; + reference + "RFC 4805 - Definitions of Managed Objects for the + DS1, J1, E1, DS2, and E2 Interface Types"; + } + enum "basicISDN" { + value 20; + description + "see also RFC2127"; + } + enum "primaryISDN" { + value 21; + } + enum "propPointToPointSerial" { + value 22; + description + "proprietary serial"; + } + enum "ppp" { + value 23; + } + enum "softwareLoopback" { + value 24; + } + enum "eon" { + value 25; + description + "CLNP over IP"; + } + enum "ethernet3Mbit" { + value 26; + } + enum "nsip" { + value 27; + description + "XNS over IP"; + } + enum "slip" { + value 28; + description + "generic SLIP"; + } + enum "ultra" { + value 29; + description + "ULTRA technologies"; + } + enum "ds3" { + value 30; + description + "DS3-MIB"; + reference + "RFC 3896 - Definitions of Managed Objects for the + DS3/E3 Interface Type"; + } + enum "sip" { + value 31; + description + "SMDS, coffee"; + reference + "RFC 1694 - Definitions of Managed Objects for SMDS + Interfaces using SMIv2"; + } + enum "frameRelay" { + value 32; + description + "DTE only."; + reference + "RFC 2115 - Management Information Base for Frame Relay + DTEs Using SMIv2"; + } + enum "rs232" { + value 33; + reference + "RFC 1659 - Definitions of Managed Objects for RS-232-like + Hardware Devices using SMIv2"; + } + enum "para" { + value 34; + description + "parallel-port"; + reference + "RFC 1660 - Definitions of Managed Objects for + Parallel-printer-like Hardware Devices using + SMIv2"; + } + enum "arcnet" { + value 35; + description + "arcnet"; + } + enum "arcnetPlus" { + value 36; + description + "arcnet plus"; + } + enum "atm" { + value 37; + description + "ATM cells"; + } + enum "miox25" { + value 38; + reference + "RFC 1461 - SNMP MIB extension for Multiprotocol + Interconnect over X.25"; + } + enum "sonet" { + value 39; + description + "SONET or SDH"; + } + enum "x25ple" { + value 40; + reference + "RFC 2127 - ISDN Management Information Base using SMIv2"; + } + enum "iso88022llc" { + value 41; + } + enum "localTalk" { + value 42; + } + enum "smdsDxi" { + value 43; + } + enum "frameRelayService" { + value 44; + description + "FRNETSERV-MIB"; + reference + "RFC 2954 - Definitions of Managed Objects for Frame + Relay Service"; + } + enum "v35" { + value 45; + } + enum "hssi" { + value 46; + } + enum "hippi" { + value 47; + } + enum "modem" { + value 48; + description + "Generic modem"; + } + enum "aal5" { + value 49; + description + "AAL5 over ATM"; + } + enum "sonetPath" { + value 50; + } + enum "sonetVT" { + value 51; + } + enum "smdsIcip" { + value 52; + description + "SMDS InterCarrier Interface"; + } + enum "propVirtual" { + value 53; + description + "proprietary virtual/internal"; + reference + "RFC 2863 - The Interfaces Group MIB"; + } + enum "propMultiplexor" { + value 54; + description + "proprietary multiplexing"; + reference + "RFC 2863 - The Interfaces Group MIB"; + } + enum "ieee80212" { + value 55; + description + "100BaseVG"; + } + enum "fibreChannel" { + value 56; + description + "Fibre Channel"; + } + enum "hippiInterface" { + value 57; + description + "HIPPI interfaces"; + } + enum "frameRelayInterconnect" { + value 58; + status obsolete; + description + "Obsolete use either + frameRelay(32) or frameRelayService(44)."; + } + enum "aflane8023" { + value 59; + description + "ATM Emulated LAN for 802.3"; + } + enum "aflane8025" { + value 60; + description + "ATM Emulated LAN for 802.5"; + } + enum "cctEmul" { + value 61; + description + "ATM Emulated circuit"; + } + enum "fastEther" { + value 62; + status deprecated; + description + "Obsoleted via RFC3635. + ethernetCsmacd(6) should be used instead"; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "isdn" { + value 63; + description + "ISDN and X.25"; + reference + "RFC 1356 - Multiprotocol Interconnect on X.25 and ISDN + in the Packet Mode"; + } + enum "v11" { + value 64; + description + "CCITT V.11/X.21"; + } + enum "v36" { + value 65; + description + "CCITT V.36"; + } + enum "g703at64k" { + value 66; + description + "CCITT G703 at 64Kbps"; + } + enum "g703at2mb" { + value 67; + status obsolete; + description + "Obsolete see DS1-MIB"; + } + enum "qllc" { + value 68; + description + "SNA QLLC"; + } + enum "fastEtherFX" { + value 69; + status deprecated; + description + "Obsoleted via RFC3635 + ethernetCsmacd(6) should be used instead"; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "channel" { + value 70; + description + "channel"; + } + enum "ieee80211" { + value 71; + description + "radio spread spectrum"; + } + enum "ibm370parChan" { + value 72; + description + "IBM System 360/370 OEMI Channel"; + } + enum "escon" { + value 73; + description + "IBM Enterprise Systems Connection"; + } + enum "dlsw" { + value 74; + description + "Data Link Switching"; + } + enum "isdns" { + value 75; + description + "ISDN S/T interface"; + } + enum "isdnu" { + value 76; + description + "ISDN U interface"; + } + enum "lapd" { + value 77; + description + "Link Access Protocol D"; + } + enum "ipSwitch" { + value 78; + description + "IP Switching Objects"; + } + enum "rsrb" { + value 79; + description + "Remote Source Route Bridging"; + } + enum "atmLogical" { + value 80; + description + "ATM Logical Port"; + reference + "RFC 3606 - Definitions of Supplemental Managed Objects + for ATM Interface"; + } + enum "ds0" { + value 81; + description + "Digital Signal Level 0"; + reference + "RFC 2494 - Definitions of Managed Objects for the DS0 + and DS0 Bundle Interface Type"; + } + enum "ds0Bundle" { + value 82; + description + "group of ds0s on the same ds1"; + reference + "RFC 2494 - Definitions of Managed Objects for the DS0 + and DS0 Bundle Interface Type"; + } + enum "bsc" { + value 83; + description + "Bisynchronous Protocol"; + } + enum "async" { + value 84; + description + "Asynchronous Protocol"; + } + enum "cnr" { + value 85; + description + "Combat Net Radio"; + } + enum "iso88025Dtr" { + value 86; + description + "ISO 802.5r DTR"; + } + enum "eplrs" { + value 87; + description + "Ext Pos Loc Report Sys"; + } + enum "arap" { + value 88; + description + "Appletalk Remote Access Protocol"; + } + enum "propCnls" { + value 89; + description + "Proprietary Connectionless Protocol"; + } + enum "hostPad" { + value 90; + description + "CCITT-ITU X.29 PAD Protocol"; + } + enum "termPad" { + value 91; + description + "CCITT-ITU X.3 PAD Facility"; + } + enum "frameRelayMPI" { + value 92; + description + "Multiproto Interconnect over FR"; + } + enum "x213" { + value 93; + description + "CCITT-ITU X213"; + } + enum "adsl" { + value 94; + description + "Asymmetric Digital Subscriber Loop"; + } + enum "radsl" { + value 95; + description + "Rate-Adapt. Digital Subscriber Loop"; + } + enum "sdsl" { + value 96; + description + "Symmetric Digital Subscriber Loop"; + } + enum "vdsl" { + value 97; + description + "Very H-Speed Digital Subscrib. Loop"; + } + enum "iso88025CRFPInt" { + value 98; + description + "ISO 802.5 CRFP"; + } + enum "myrinet" { + value 99; + description + "Myricom Myrinet"; + } + enum "voiceEM" { + value 100; + description + "voice recEive and transMit"; + } + enum "voiceFXO" { + value 101; + description + "voice Foreign Exchange Office"; + } + enum "voiceFXS" { + value 102; + description + "voice Foreign Exchange Station"; + } + enum "voiceEncap" { + value 103; + description + "voice encapsulation"; + } + enum "voiceOverIp" { + value 104; + description + "voice over IP encapsulation"; + } + enum "atmDxi" { + value 105; + description + "ATM DXI"; + } + enum "atmFuni" { + value 106; + description + "ATM FUNI"; + } + enum "atmIma" { + value 107; + description + "ATM IMA"; + } + enum "pppMultilinkBundle" { + value 108; + description + "PPP Multilink Bundle"; + } + enum "ipOverCdlc" { + value 109; + description + "IBM ipOverCdlc"; + } + enum "ipOverClaw" { + value 110; + description + "IBM Common Link Access to Workstn"; + } + enum "stackToStack" { + value 111; + description + "IBM stackToStack"; + } + enum "virtualIpAddress" { + value 112; + description + "IBM VIPA"; + } + enum "mpc" { + value 113; + description + "IBM multi-protocol channel support"; + } + enum "ipOverAtm" { + value 114; + description + "IBM ipOverAtm"; + reference + "RFC 2320 - Definitions of Managed Objects for Classical IP + and ARP Over ATM Using SMIv2 (IPOA-MIB)"; + } + enum "iso88025Fiber" { + value 115; + description + "ISO 802.5j Fiber Token Ring"; + } + enum "tdlc" { + value 116; + description + "IBM twinaxial data link control"; + } + enum "gigabitEthernet" { + value 117; + status deprecated; + description + "Obsoleted via RFC3635 + ethernetCsmacd(6) should be used instead"; + reference + "RFC 3635 - Definitions of Managed Objects for the + Ethernet-like Interface Types."; + } + enum "hdlc" { + value 118; + description + "HDLC"; + } + enum "lapf" { + value 119; + description + "LAP F"; + } + enum "v37" { + value 120; + description + "V.37"; + } + enum "x25mlp" { + value 121; + description + "Multi-Link Protocol"; + } + enum "x25huntGroup" { + value 122; + description + "X25 Hunt Group"; + } + enum "transpHdlc" { + value 123; + description + "Transp HDLC"; + } + enum "interleave" { + value 124; + description + "Interleave channel"; + } + enum "fast" { + value 125; + description + "Fast channel"; + } + enum "ip" { + value 126; + description + "IP (for APPN HPR in IP networks)"; + } + enum "docsCableMaclayer" { + value 127; + description + "CATV Mac Layer"; + } + enum "docsCableDownstream" { + value 128; + description + "CATV Downstream interface"; + } + enum "docsCableUpstream" { + value 129; + description + "CATV Upstream interface"; + } + enum "a12MppSwitch" { + value 130; + description + "Avalon Parallel Processor"; + } + enum "tunnel" { + value 131; + description + "Encapsulation interface"; + } + enum "coffee" { + value 132; + description + "coffee pot"; + reference + "RFC 2325 - Coffee MIB"; + } + enum "ces" { + value 133; + description + "Circuit Emulation Service"; + } + enum "atmSubInterface" { + value 134; + description + "ATM Sub Interface"; + } + enum "l2vlan" { + value 135; + description + "Layer 2 Virtual LAN using 802.1Q"; + } + enum "l3ipvlan" { + value 136; + description + "Layer 3 Virtual LAN using IP"; + } + enum "l3ipxvlan" { + value 137; + description + "Layer 3 Virtual LAN using IPX"; + } + enum "digitalPowerline" { + value 138; + description + "IP over Power Lines"; + } + enum "mediaMailOverIp" { + value 139; + description + "Multimedia Mail over IP"; + } + enum "dtm" { + value 140; + description + "Dynamic syncronous Transfer Mode"; + } + enum "dcn" { + value 141; + description + "Data Communications Network"; + } + enum "ipForward" { + value 142; + description + "IP Forwarding Interface"; + } + enum "msdsl" { + value 143; + description + "Multi-rate Symmetric DSL"; + } + enum "ieee1394" { + value 144; + description + "IEEE1394 High Performance Serial Bus"; + } + enum "if-gsn" { + value 145; + description + "HIPPI-6400"; + } + enum "dvbRccMacLayer" { + value 146; + description + "DVB-RCC MAC Layer"; + } + enum "dvbRccDownstream" { + value 147; + description + "DVB-RCC Downstream Channel"; + } + enum "dvbRccUpstream" { + value 148; + description + "DVB-RCC Upstream Channel"; + } + enum "atmVirtual" { + value 149; + description + "ATM Virtual Interface"; + } + enum "mplsTunnel" { + value 150; + description + "MPLS Tunnel Virtual Interface"; + } + enum "srp" { + value 151; + description + "Spatial Reuse Protocol "; + } + enum "voiceOverAtm" { + value 152; + description + "Voice Over ATM"; + } + enum "voiceOverFrameRelay" { + value 153; + description + "Voice Over Frame Relay"; + } + enum "idsl" { + value 154; + description + "Digital Subscriber Loop over ISDN"; + } + enum "compositeLink" { + value 155; + description + "Avici Composite Link Interface"; + } + enum "ss7SigLink" { + value 156; + description + "SS7 Signaling Link"; + } + enum "propWirelessP2P" { + value 157; + description + "Prop. P2P wireless interface"; + } + enum "frForward" { + value 158; + description + "Frame Forward Interface"; + } + enum "rfc1483" { + value 159; + description + "Multiprotocol over ATM AAL5"; + reference + "RFC 1483 - Multiprotocol Encapsulation over ATM + Adaptation Layer 5"; + } + enum "usb" { + value 160; + description + "USB Interface"; + } + enum "ieee8023adLag" { + value 161; + description + "IEEE 802.3ad Link Aggregate"; + } + enum "bgppolicyaccounting" { + value 162; + description + "BGP Policy Accounting"; + } + enum "frf16MfrBundle" { + value 163; + description + "FRF .16 Multilink Frame Relay"; + } + enum "h323Gatekeeper" { + value 164; + description + "H323 Gatekeeper"; + } + enum "h323Proxy" { + value 165; + description + "H323 Voice and Video Proxy"; + } + enum "mpls" { + value 166; + description + "MPLS"; + } + enum "mfSigLink" { + value 167; + description + "Multi-frequency signaling link"; + } + enum "hdsl2" { + value 168; + description + "High Bit-Rate DSL - 2nd generation"; + } + enum "shdsl" { + value 169; + description + "Multirate HDSL2"; + } + enum "ds1FDL" { + value 170; + description + "Facility Data Link 4Kbps on a DS1"; + } + enum "pos" { + value 171; + description + "Packet over SONET/SDH Interface"; + } + enum "dvbAsiIn" { + value 172; + description + "DVB-ASI Input"; + } + enum "dvbAsiOut" { + value 173; + description + "DVB-ASI Output"; + } + enum "plc" { + value 174; + description + "Power Line Communtications"; + } + enum "nfas" { + value 175; + description + "Non Facility Associated Signaling"; + } + enum "tr008" { + value 176; + description + "TR008"; + } + enum "gr303RDT" { + value 177; + description + "Remote Digital Terminal"; + } + enum "gr303IDT" { + value 178; + description + "Integrated Digital Terminal"; + } + enum "isup" { + value 179; + description + "ISUP"; + } + enum "propDocsWirelessMaclayer" { + value 180; + description + "Cisco proprietary Maclayer"; + } + enum "propDocsWirelessDownstream" { + value 181; + description + "Cisco proprietary Downstream"; + } + enum "propDocsWirelessUpstream" { + value 182; + description + "Cisco proprietary Upstream"; + } + enum "hiperlan2" { + value 183; + description + "HIPERLAN Type 2 Radio Interface"; + } + enum "propBWAp2Mp" { + value 184; + description + "PropBroadbandWirelessAccesspt2multipt use of this value + for IEEE 802.16 WMAN interfaces as per IEEE Std 802.16f + is deprecated and ieee80216WMAN(237) should be used + instead."; + } + enum "sonetOverheadChannel" { + value 185; + description + "SONET Overhead Channel"; + } + enum "digitalWrapperOverheadChannel" { + value 186; + description + "Digital Wrapper"; + } + enum "aal2" { + value 187; + description + "ATM adaptation layer 2"; + } + enum "radioMAC" { + value 188; + description + "MAC layer over radio links"; + } + enum "atmRadio" { + value 189; + description + "ATM over radio links"; + } + enum "imt" { + value 190; + description + "Inter Machine Trunks"; + } + enum "mvl" { + value 191; + description + "Multiple Virtual Lines DSL"; + } + enum "reachDSL" { + value 192; + description + "Long Reach DSL"; + } + enum "frDlciEndPt" { + value 193; + description + "Frame Relay DLCI End Point"; + } + enum "atmVciEndPt" { + value 194; + description + "ATM VCI End Point"; + } + enum "opticalChannel" { + value 195; + description + "Optical Channel"; + } + enum "opticalTransport" { + value 196; + description + "Optical Transport"; + } + enum "propAtm" { + value 197; + description + "Proprietary ATM"; + } + enum "voiceOverCable" { + value 198; + description + "Voice Over Cable Interface"; + } + enum "infiniband" { + value 199; + description + "Infiniband"; + } + enum "teLink" { + value 200; + description + "TE Link"; + } + enum "q2931" { + value 201; + description + "Q.2931"; + } + enum "virtualTg" { + value 202; + description + "Virtual Trunk Group"; + } + enum "sipTg" { + value 203; + description + "SIP Trunk Group"; + } + enum "sipSig" { + value 204; + description + "SIP Signaling"; + } + enum "docsCableUpstreamChannel" { + value 205; + description + "CATV Upstream Channel"; + } + enum "econet" { + value 206; + description + "Acorn Econet"; + } + enum "pon155" { + value 207; + description + "FSAN 155Mb Symetrical PON interface"; + } + enum "pon622" { + value 208; + description + "FSAN622Mb Symetrical PON interface"; + } + enum "bridge" { + value 209; + description + "Transparent bridge interface"; + } + enum "linegroup" { + value 210; + description + "Interface common to multiple lines"; + } + enum "voiceEMFGD" { + value 211; + description + "voice E&M Feature Group D"; + } + enum "voiceFGDEANA" { + value 212; + description + "voice FGD Exchange Access North American"; + } + enum "voiceDID" { + value 213; + description + "voice Direct Inward Dialing"; + } + enum "mpegTransport" { + value 214; + description + "MPEG transport interface"; + } + enum "sixToFour" { + value 215; + status deprecated; + description + "6to4 interface (DEPRECATED)"; + reference + "RFC 4087 - IP Tunnel MIB"; + } + enum "gtp" { + value 216; + description + "GTP (GPRS Tunneling Protocol)"; + } + enum "pdnEtherLoop1" { + value 217; + description + "Paradyne EtherLoop 1"; + } + enum "pdnEtherLoop2" { + value 218; + description + "Paradyne EtherLoop 2"; + } + enum "opticalChannelGroup" { + value 219; + description + "Optical Channel Group"; + } + enum "homepna" { + value 220; + description + "HomePNA ITU-T G.989"; + } + enum "gfp" { + value 221; + description + "Generic Framing Procedure (GFP)"; + } + enum "ciscoISLvlan" { + value 222; + description + "Layer 2 Virtual LAN using Cisco ISL"; + } + enum "actelisMetaLOOP" { + value 223; + description + "Acteleis proprietary MetaLOOP High Speed Link"; + } + enum "fcipLink" { + value 224; + description + "FCIP Link"; + } + enum "rpr" { + value 225; + description + "Resilient Packet Ring Interface Type"; + } + enum "qam" { + value 226; + description + "RF Qam Interface"; + } + enum "lmp" { + value 227; + description + "Link Management Protocol"; + reference + "RFC 4327 - Link Management Protocol (LMP) Management + Information Base (MIB)"; + } + enum "cblVectaStar" { + value 228; + description + "Cambridge Broadband Networks Limited VectaStar"; + } + enum "docsCableMCmtsDownstream" { + value 229; + description + "CATV Modular CMTS Downstream Interface"; + } + enum "adsl2" { + value 230; + status deprecated; + description + "Asymmetric Digital Subscriber Loop Version 2 + (DEPRECATED/OBSOLETED - please use adsl2plus(238) + instead)"; + reference + "RFC 4706 - Definitions of Managed Objects for Asymmetric + Digital Subscriber Line 2 (ADSL2)"; + } + enum "macSecControlledIF" { + value 231; + description + "MACSecControlled"; + } + enum "macSecUncontrolledIF" { + value 232; + description + "MACSecUncontrolled"; + } + enum "aviciOpticalEther" { + value 233; + description + "Avici Optical Ethernet Aggregate"; + } + enum "atmbond" { + value 234; + description + "atmbond"; + } + enum "voiceFGDOS" { + value 235; + description + "voice FGD Operator Services"; + } + enum "mocaVersion1" { + value 236; + description + "MultiMedia over Coax Alliance (MoCA) Interface + as documented in information provided privately to IANA"; + } + enum "ieee80216WMAN" { + value 237; + description + "IEEE 802.16 WMAN interface"; + } + enum "adsl2plus" { + value 238; + description + "Asymmetric Digital Subscriber Loop Version 2, + Version 2 Plus and all variants"; + } + enum "dvbRcsMacLayer" { + value 239; + description + "DVB-RCS MAC Layer"; + reference + "RFC 5728 - The SatLabs Group DVB-RCS MIB"; + } + enum "dvbTdm" { + value 240; + description + "DVB Satellite TDM"; + reference + "RFC 5728 - The SatLabs Group DVB-RCS MIB"; + } + enum "dvbRcsTdma" { + value 241; + description + "DVB-RCS TDMA"; + reference + "RFC 5728 - The SatLabs Group DVB-RCS MIB"; + } + enum "x86Laps" { + value 242; + description + "LAPS based on ITU-T X.86/Y.1323"; + } + enum "wwanPP" { + value 243; + description + "3GPP WWAN"; + } + enum "wwanPP2" { + value 244; + description + "3GPP2 WWAN"; + } + enum "voiceEBS" { + value 245; + description + "voice P-phone EBS physical interface"; + } + enum "ifPwType" { + value 246; + description + "Pseudowire interface type"; + reference + "RFC 5601 - Pseudowire (PW) Management Information Base"; + } + enum "ilan" { + value 247; + description + "Internal LAN on a bridge per IEEE 802.1ap"; + } + enum "pip" { + value 248; + description + "Provider Instance Port on a bridge per IEEE 802.1ah PBB"; + } + enum "aluELP" { + value 249; + description + "Alcatel-Lucent Ethernet Link Protection"; + } + enum "gpon" { + value 250; + description + "Gigabit-capable passive optical networks (G-PON) as per + ITU-T G.948"; + } + enum "vdsl2" { + value 251; + description + "Very high speed digital subscriber line Version 2 + (as per ITU-T Recommendation G.993.2)"; + reference + "RFC 5650 - Definitions of Managed Objects for Very High + Speed Digital Subscriber Line 2 (VDSL2)"; + } + enum "capwapDot11Profile" { + value 252; + description + "WLAN Profile Interface"; + reference + "RFC 5834 - Control and Provisioning of Wireless Access + Points (CAPWAP) Protocol Binding MIB for + IEEE 802.11"; + } + enum "capwapDot11Bss" { + value 253; + description + "WLAN BSS Interface"; + reference + "RFC 5834 - Control and Provisioning of Wireless Access + Points (CAPWAP) Protocol Binding MIB for + IEEE 802.11"; + } + enum "capwapWtpVirtualRadio" { + value 254; + description + "WTP Virtual Radio Interface"; + reference + "RFC 5833 - Control and Provisioning of Wireless Access + Points (CAPWAP) Protocol Base MIB"; + } + enum "bits" { + value 255; + description + "bitsport"; + } + enum "docsCableUpstreamRfPort" { + value 256; + description + "DOCSIS CATV Upstream RF Port"; + } + enum "cableDownstreamRfPort" { + value 257; + description + "CATV downstream RF port"; + } + enum "vmwareVirtualNic" { + value 258; + description + "VMware Virtual Network Interface"; + } + enum "ieee802154" { + value 259; + description + "IEEE 802.15.4 WPAN interface"; + reference + "IEEE 802.15.4-2006"; + } + enum "otnOdu" { + value 260; + description + "OTN Optical Data Unit"; + } + enum "otnOtu" { + value 261; + description + "OTN Optical channel Transport Unit"; + } + enum "ifVfiType" { + value 262; + description + "VPLS Forwarding Instance Interface Type"; + } + enum "g9981" { + value 263; + description + "G.998.1 bonded interface"; + } + enum "g9982" { + value 264; + description + "G.998.2 bonded interface"; + } + enum "g9983" { + value 265; + description + "G.998.3 bonded interface"; + } + enum "aluEpon" { + value 266; + description + "Ethernet Passive Optical Networks (E-PON)"; + } + enum "aluEponOnu" { + value 267; + description + "EPON Optical Network Unit"; + } + enum "aluEponPhysicalUni" { + value 268; + description + "EPON physical User to Network interface"; + } + enum "aluEponLogicalLink" { + value 269; + description + "The emulation of a point-to-point link over the EPON + layer"; + } + enum "aluGponOnu" { + value 270; + description + "GPON Optical Network Unit"; + reference + "ITU-T G.984.2"; + } + enum "aluGponPhysicalUni" { + value 271; + description + "GPON physical User to Network interface"; + reference + "ITU-T G.984.2"; + } + enum "vmwareNicTeam" { + value 272; + description + "VMware NIC Team"; + } + } + description + "This data type is used as the syntax of the 'type' + leaf in the 'interface' list in the YANG module + ietf-interface. + + The definition of this typedef with the + addition of newly assigned values is published + periodically by the IANA, in either the Assigned + Numbers RFC, or some derivative of it specific to + Internet Network Management number assignments. (The + latest arrangements can be obtained by contacting the + IANA.) + + Requests for new values should be made to IANA via + email (iana&iana.org)."; + reference + "ifType definitions registry. + "; + } +} \ No newline at end of file diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-inet-types@2010-09-24.yang b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-inet-types@2010-09-24.yang new file mode 100644 index 0000000000..6a6c7483ec --- /dev/null +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-inet-types@2010-09-24.yang @@ -0,0 +1,418 @@ + module ietf-inet-types { + + namespace "urn:ietf:params:xml:ns:yang:ietf-inet-types"; + prefix "inet"; + + organization + "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; + + contact + "WG Web: + WG List: + + WG Chair: David Partain + + + WG Chair: David Kessens + + + Editor: Juergen Schoenwaelder + "; + + description + "This module contains a collection of generally useful derived + YANG data types for Internet addresses and related things. + + Copyright (c) 2010 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, is permitted pursuant to, and subject to the license + terms contained in, the Simplified BSD License set forth in Section + 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 6021; see + the RFC itself for full legal notices."; + + revision 2010-09-24 { + description + "Initial revision."; + reference + "RFC 6021: Common YANG Data Types"; + } + + /*** collection of protocol field related types ***/ + + typedef ip-version { + type enumeration { + enum unknown { + value "0"; + description + "An unknown or unspecified version of the Internet protocol."; + } + enum ipv4 { + value "1"; + description + "The IPv4 protocol as defined in RFC 791."; + } + enum ipv6 { + value "2"; + description + "The IPv6 protocol as defined in RFC 2460."; + } + } + description + "This value represents the version of the IP protocol. + + In the value set and its semantics, this type is equivalent + to the InetVersion textual convention of the SMIv2."; + reference + "RFC 791: Internet Protocol + RFC 2460: Internet Protocol, Version 6 (IPv6) Specification + RFC 4001: Textual Conventions for Internet Network Addresses"; + } + + typedef dscp { + type uint8 { + range "0..63"; + } + description + "The dscp type represents a Differentiated Services Code-Point + that may be used for marking packets in a traffic stream. + + In the value set and its semantics, this type is equivalent + to the Dscp textual convention of the SMIv2."; + reference + "RFC 3289: Management Information Base for the Differentiated + Services Architecture + RFC 2474: Definition of the Differentiated Services Field + (DS Field) in the IPv4 and IPv6 Headers + RFC 2780: IANA Allocation Guidelines For Values In + the Internet Protocol and Related Headers"; + } + + typedef ipv6-flow-label { + type uint32 { + range "0..1048575"; + } + description + "The flow-label type represents flow identifier or Flow Label + in an IPv6 packet header that may be used to discriminate + traffic flows. + + In the value set and its semantics, this type is equivalent + to the IPv6FlowLabel textual convention of the SMIv2."; + reference + "RFC 3595: Textual Conventions for IPv6 Flow Label + RFC 2460: Internet Protocol, Version 6 (IPv6) Specification"; + } + + typedef port-number { + type uint16 { + range "0..65535"; + } + description + "The port-number type represents a 16-bit port number of an + Internet transport layer protocol such as UDP, TCP, DCCP, or + SCTP. Port numbers are assigned by IANA. A current list of + all assignments is available from . + + Note that the port number value zero is reserved by IANA. In + situations where the value zero does not make sense, it can + be excluded by subtyping the port-number type. + + In the value set and its semantics, this type is equivalent + to the InetPortNumber textual convention of the SMIv2."; + reference + "RFC 768: User Datagram Protocol + RFC 793: Transmission Control Protocol + RFC 4960: Stream Control Transmission Protocol + RFC 4340: Datagram Congestion Control Protocol (DCCP) + RFC 4001: Textual Conventions for Internet Network Addresses"; + } + + /*** collection of autonomous system related types ***/ + + typedef as-number { + type uint32; + description + "The as-number type represents autonomous system numbers + which identify an Autonomous System (AS). An AS is a set + of routers under a single technical administration, using + an interior gateway protocol and common metrics to route + packets within the AS, and using an exterior gateway + protocol to route packets to other ASs'. IANA maintains + the AS number space and has delegated large parts to the + regional registries. + + Autonomous system numbers were originally limited to 16 + bits. BGP extensions have enlarged the autonomous system + number space to 32 bits. This type therefore uses an uint32 + base type without a range restriction in order to support + a larger autonomous system number space. + + In the value set and its semantics, this type is equivalent + to the InetAutonomousSystemNumber textual convention of + the SMIv2."; + reference + "RFC 1930: Guidelines for creation, selection, and registration + of an Autonomous System (AS) + RFC 4271: A Border Gateway Protocol 4 (BGP-4) + RFC 4893: BGP Support for Four-octet AS Number Space + RFC 4001: Textual Conventions for Internet Network Addresses"; + } + + /*** collection of IP address and hostname related types ***/ + + typedef ip-address { + type union { + type inet:ipv4-address; + type inet:ipv6-address; + } + description + "The ip-address type represents an IP address and is IP + version neutral. The format of the textual representations + implies the IP version."; + } + + typedef ipv4-address { + type string { + pattern + '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])' + + '(%[\p{N}\p{L}]+)?'; + } + description + "The ipv4-address type represents an IPv4 address in + dotted-quad notation. The IPv4 address may include a zone + index, separated by a % sign. + + The zone index is used to disambiguate identical address + values. For link-local addresses, the zone index will + typically be the interface index number or the name of an + interface. If the zone index is not present, the default + zone of the device will be used. + + The canonical format for the zone index is the numerical + format"; + } + + typedef ipv6-address { + type string { + pattern '((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + + '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}' + + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + + '(%[\p{N}\p{L}]+)?'; + pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|' + + '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + + '(%.+)?'; + } + description + "The ipv6-address type represents an IPv6 address in full, + mixed, shortened, and shortened-mixed notation. The IPv6 + address may include a zone index, separated by a % sign. + + The zone index is used to disambiguate identical address + values. For link-local addresses, the zone index will + typically be the interface index number or the name of an + interface. If the zone index is not present, the default + zone of the device will be used. + + The canonical format of IPv6 addresses uses the compressed + format described in RFC 4291, Section 2.2, item 2 with the + following additional rules: the :: substitution must be + applied to the longest sequence of all-zero 16-bit chunks + in an IPv6 address. If there is a tie, the first sequence + of all-zero 16-bit chunks is replaced by ::. Single + all-zero 16-bit chunks are not compressed. The canonical + format uses lowercase characters and leading zeros are + not allowed. The canonical format for the zone index is + the numerical format as described in RFC 4007, Section + 11.2."; + reference + "RFC 4291: IP Version 6 Addressing Architecture + RFC 4007: IPv6 Scoped Address Architecture + RFC 5952: A Recommendation for IPv6 Address Text Representation"; + } + + typedef ip-prefix { + type union { + type inet:ipv4-prefix; + type inet:ipv6-prefix; + } + description + "The ip-prefix type represents an IP prefix and is IP + version neutral. The format of the textual representations + implies the IP version."; + } + + typedef ipv4-prefix { + type string { + pattern + '(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])' + + '/(([0-9])|([1-2][0-9])|(3[0-2]))'; + } + description + "The ipv4-prefix type represents an IPv4 address prefix. + The prefix length is given by the number following the + slash character and must be less than or equal to 32. + + A prefix length value of n corresponds to an IP address + mask that has n contiguous 1-bits from the most + significant bit (MSB) and all other bits set to 0. + + The canonical format of an IPv4 prefix has all bits of + the IPv4 address set to zero that are not part of the + IPv4 prefix."; + } + + typedef ipv6-prefix { + type string { + pattern '((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + + '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}' + + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + + '(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))'; + pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|' + + '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + + '(/.+)'; + } + description + "The ipv6-prefix type represents an IPv6 address prefix. + The prefix length is given by the number following the + slash character and must be less than or equal 128. + + A prefix length value of n corresponds to an IP address + mask that has n contiguous 1-bits from the most + significant bit (MSB) and all other bits set to 0. + + The IPv6 address should have all bits that do not belong + to the prefix set to zero. + + The canonical format of an IPv6 prefix has all bits of + the IPv6 address set to zero that are not part of the + IPv6 prefix. Furthermore, IPv6 address is represented + in the compressed format described in RFC 4291, Section + 2.2, item 2 with the following additional rules: the :: + substitution must be applied to the longest sequence of + all-zero 16-bit chunks in an IPv6 address. If there is + a tie, the first sequence of all-zero 16-bit chunks is + replaced by ::. Single all-zero 16-bit chunks are not + compressed. The canonical format uses lowercase + characters and leading zeros are not allowed."; + reference + "RFC 4291: IP Version 6 Addressing Architecture"; + } + + /*** collection of domain name and URI types ***/ + + typedef domain-name { + type string { + pattern '((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*' + + '([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)' + + '|\.'; + length "1..253"; + } + description + "The domain-name type represents a DNS domain name. The + name SHOULD be fully qualified whenever possible. + + Internet domain names are only loosely specified. Section + 3.5 of RFC 1034 recommends a syntax (modified in Section + 2.1 of RFC 1123). The pattern above is intended to allow + for current practice in domain name use, and some possible + future expansion. It is designed to hold various types of + domain names, including names used for A or AAAA records + (host names) and other records, such as SRV records. Note + that Internet host names have a stricter syntax (described + in RFC 952) than the DNS recommendations in RFCs 1034 and + 1123, and that systems that want to store host names in + schema nodes using the domain-name type are recommended to + adhere to this stricter standard to ensure interoperability. + + The encoding of DNS names in the DNS protocol is limited + to 255 characters. Since the encoding consists of labels + prefixed by a length bytes and there is a trailing NULL + byte, only 253 characters can appear in the textual dotted + notation. + + The description clause of schema nodes using the domain-name + type MUST describe when and how these names are resolved to + IP addresses. Note that the resolution of a domain-name value + may require to query multiple DNS records (e.g., A for IPv4 + and AAAA for IPv6). The order of the resolution process and + which DNS record takes precedence can either be defined + explicitely or it may depend on the configuration of the + resolver. + + Domain-name values use the US-ASCII encoding. Their canonical + format uses lowercase US-ASCII characters. Internationalized + domain names MUST be encoded in punycode as described in RFC + 3492"; + reference + "RFC 952: DoD Internet Host Table Specification + RFC 1034: Domain Names - Concepts and Facilities + RFC 1123: Requirements for Internet Hosts -- Application + and Support + RFC 2782: A DNS RR for specifying the location of services + (DNS SRV) + RFC 3492: Punycode: A Bootstring encoding of Unicode for + Internationalized Domain Names in Applications + (IDNA) + RFC 5891: Internationalizing Domain Names in Applications + (IDNA): Protocol"; + } + + typedef host { + type union { + type inet:ip-address; + type inet:domain-name; + } + description + "The host type represents either an IP address or a DNS + domain name."; + } + + typedef uri { + type string; + description + "The uri type represents a Uniform Resource Identifier + (URI) as defined by STD 66. + + Objects using the uri type MUST be in US-ASCII encoding, + and MUST be normalized as described by RFC 3986 Sections + 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary + percent-encoding is removed, and all case-insensitive + characters are set to lowercase except for hexadecimal + digits, which are normalized to uppercase as described in + Section 6.2.2.1. + + The purpose of this normalization is to help provide + unique URIs. Note that this normalization is not + sufficient to provide uniqueness. Two URIs that are + textually distinct after this normalization may still be + equivalent. + + Objects using the uri type may restrict the schemes that + they permit. For example, 'data:' and 'urn:' schemes + might not be appropriate. + + A zero-length URI is not a valid URI. This can be used to + express 'URI absent' where required. + + In the value set and its semantics, this type is equivalent + to the Uri SMIv2 textual convention defined in RFC 5017."; + reference + "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax + RFC 3305: Report from the Joint W3C/IETF URI Planning Interest + Group: Uniform Resource Identifiers (URIs), URLs, + and Uniform Resource Names (URNs): Clarifications + and Recommendations + RFC 5017: MIB Textual Conventions for Uniform Resource + Identifiers (URIs)"; + } + + } \ No newline at end of file diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-interfaces@2012-11-15.yang b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-interfaces@2012-11-15.yang new file mode 100644 index 0000000000..481a5d2ed1 --- /dev/null +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-interfaces@2012-11-15.yang @@ -0,0 +1,469 @@ +module ietf-interfaces { + + namespace "urn:ietf:params:xml:ns:yang:ietf-interfaces"; + prefix if; + + import ietf-yang-types { + prefix yang; + revision-date 2010-09-24; + } + + organization + "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; + + contact + "WG Web: + WG List: + + WG Chair: David Kessens + + + WG Chair: Juergen Schoenwaelder + + + Editor: Martin Bjorklund + "; + + description + "This module contains a collection of YANG definitions for + managing network interfaces. + + Copyright (c) 2012 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or + without modification, is permitted pursuant to, and subject + to the license terms contained in, the Simplified BSD License + set forth in Section 4.c of the IETF Trust's Legal Provisions + Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC XXXX; see + the RFC itself for full legal notices."; + + // RFC Ed.: replace XXXX with actual RFC number and remove this + // note. + + // RFC Ed.: update the date below with the date of RFC publication + // and remove this note. + revision 2012-11-15 { + description + "Initial revision."; + reference + "RFC XXXX: A YANG Data Model for Interface Management"; + } + + /* Typedefs */ + + typedef interface-ref { + type leafref { + path "/if:interfaces/if:interface/if:name"; + } + description + "This type is used by data models that need to reference + interfaces."; + } + + /* Features */ + + feature arbitrary-names { + description + "This feature indicates that the server allows interfaces to + be named arbitrarily."; + } + + feature if-mib { + description + "This feature indicates that the server implements IF-MIB."; + reference + "RFC 2863: The Interfaces Group MIB"; + } + + /* Data nodes */ + + container interfaces { + description + "Interface parameters."; + + list interface { + key "name"; + unique "type location"; + + description + "The list of interfaces on the device."; + + leaf name { + type string; + description + "The name of the interface. + + A device MAY restrict the allowed values for this leaf, + possibly depending on the type and location. + + If the device allows arbitrarily named interfaces, the + feature 'arbitrary-names' is advertised. + + This leaf MAY be mapped to ifName by an implementation. + Such an implementation MAY restrict the allowed values for + this leaf so that it matches the restrictions of ifName. + If a NETCONF server that implements this restriction is + sent a value that doesn't match the restriction, it MUST + reply with an rpc-error with the error-tag + 'invalid-value'."; + reference + "RFC 2863: The Interfaces Group MIB - ifName"; + } + + leaf description { + type string; + description + "A textual description of the interface. + + This leaf MAY be mapped to ifAlias by an implementation. + Such an implementation MAY restrict the allowed values for + this leaf so that it matches the restrictions of ifAlias. + If a NETCONF server that implements this restriction is + sent a value that doesn't match the restriction, it MUST + reply with an rpc-error with the error-tag + 'invalid-value'."; + reference + "RFC 2863: The Interfaces Group MIB - ifAlias"; + } + + leaf location { + type string; + description + "The device-specific location of the interface of a + particular type. The format of the location string + depends on the interface type and the device. + + If the interface's type represents a physical interface, + this leaf MUST be set. + + When an interface entry is created, a server MAY + initialize the location leaf with a valid value, e.g., if + it is possible to derive the location from the name of + the interface."; + } + + leaf enabled { + type boolean; + default "true"; + description + "The desired state of the interface. + + This leaf contains the configured, desired state of the + interface. Systems that implement the IF-MIB use the + value of this leaf to set IF-MIB.ifAdminStatus to 'up' or + 'down' after an ifEntry has been initialized, as described + in RFC 2863."; + reference + "RFC 2863: The Interfaces Group MIB - ifAdminStatus"; + } + + leaf last-change { + type yang:date-and-time; + config false; + description + "The time the interface entered its current operational + state. If the current state was entered prior to the + last re-initialization of the local network management + subsystem, then this node is not present."; + reference + "RFC 2863: The Interfaces Group MIB - ifLastChange"; + } + + leaf if-index { + if-feature if-mib; + type int32 { + range "1..2147483647"; + } + config false; + description + "The ifIndex value for the ifEntry represented by this + interface. + + Media-specific modules must specify how the type is + mapped to entries in the ifTable."; + reference + "RFC 2863: The Interfaces Group MIB - ifIndex"; + } + + leaf phys-address { + type yang:phys-address; + config false; + description + "The interface's address at its protocol sub-layer. For + example, for an 802.x interface, this object normally + contains a MAC address. The interface's media-specific + modules must define the bit and byte ordering and the + format of the value of this object. For interfaces that do + not have such an address (e.g., a serial line), this node + is not present."; + reference + "RFC 2863: The Interfaces Group MIB - ifPhysAddress"; + } + + leaf-list higher-layer-if { + type interface-ref; + config false; + description + "A list of references to interfaces layered on top of this + interface."; + reference + "RFC 2863: The Interfaces Group MIB - ifStackTable"; + } + + leaf-list lower-layer-if { + type interface-ref; + config false; + description + "A list of references to interfaces layered underneath this + interface."; + reference + "RFC 2863: The Interfaces Group MIB - ifStackTable"; + } + + leaf speed { + type yang:gauge64; + units "bits / second"; + config false; + description + "An estimate of the interface's current bandwidth in bits + per second. For interfaces which do not vary in + bandwidth or for those where no accurate estimation can + be made, this node should contain the nominal bandwidth. + For interfaces that has no concept of bandwidth, this + node is not present."; + reference + "RFC 2863: The Interfaces Group MIB - + ifSpeed, ifHighSpeed"; + } + + container statistics { + config false; + description + "A collection of interface-related statistics objects."; + + leaf discontinuity-time { + type yang:date-and-time; + description + "The time on the most recent occasion at which any one or + more of this interface's counters suffered a + discontinuity. If no such discontinuities have occurred + since the last re-initialization of the local management + subsystem, then this node contains the time the local + management subsystem re-initialized itself."; + } + + leaf in-octets { + type yang:counter64; + description + "The total number of octets received on the interface, + including framing characters. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifHCInOctets"; + } + leaf in-unicast-pkts { + type yang:counter64; + description + "The number of packets, delivered by this sub-layer to a + higher (sub-)layer, which were not addressed to a + multicast or broadcast address at this sub-layer. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifHCInUcastPkts"; + } + leaf in-broadcast-pkts { + type yang:counter64; + description + "The number of packets, delivered by this sub-layer to a + higher (sub-)layer, which were addressed to a broadcast + address at this sub-layer. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - + ifHCInBroadcastPkts"; + } + leaf in-multicast-pkts { + type yang:counter64; + description + "The number of packets, delivered by this sub-layer to a + higher (sub-)layer, which were addressed to a multicast + address at this sub-layer. For a MAC layer protocol, + this includes both Group and Functional addresses. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - + ifHCInMulticastPkts"; + } + leaf in-discards { + type yang:counter32; + description + "The number of inbound packets which were chosen to be + discarded even though no errors had been detected to + prevent their being deliverable to a higher-layer + protocol. One possible reason for discarding such a + packet could be to free up buffer space. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifInDiscards"; + } + leaf in-errors { + type yang:counter32; + description + "For packet-oriented interfaces, the number of inbound + packets that contained errors preventing them from being + deliverable to a higher-layer protocol. For character- + oriented or fixed-length interfaces, the number of + inbound transmission units that contained errors + preventing them from being deliverable to a higher-layer + protocol. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifInErrors"; + } + leaf in-unknown-protos { + type yang:counter32; + description + "For packet-oriented interfaces, the number of packets + received via the interface which were discarded because + of an unknown or unsupported protocol. For + character-oriented or fixed-length interfaces that + support protocol multiplexing the number of transmission + units received via the interface which were discarded + because of an unknown or unsupported protocol. For any + interface that does not support protocol multiplexing, + this counter is not present. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifInUnknownProtos"; + } + + leaf out-octets { + type yang:counter64; + description + "The total number of octets transmitted out of the + interface, including framing characters. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifHCOutOctets"; + } + leaf out-unicast-pkts { + type yang:counter64; + description + "The total number of packets that higher-level protocols + requested be transmitted, and which were not addressed + to a multicast or broadcast address at this sub-layer, + including those that were discarded or not sent. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifHCOutUcastPkts"; + } + leaf out-broadcast-pkts { + type yang:counter64; + description + "The total number of packets that higher-level protocols + requested be transmitted, and which were addressed to a + broadcast address at this sub-layer, including those + that were discarded or not sent. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - + ifHCOutBroadcastPkts"; + } + leaf out-multicast-pkts { + type yang:counter64; + description + "The total number of packets that higher-level protocols + requested be transmitted, and which were addressed to a + multicast address at this sub-layer, including those + that were discarded or not sent. For a MAC layer + protocol, this includes both Group and Functional + addresses. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - + ifHCOutMulticastPkts"; + } + leaf out-discards { + type yang:counter32; + description + "The number of outbound packets which were chosen to be + discarded even though no errors had been detected to + prevent their being transmitted. One possible reason + for discarding such a packet could be to free up buffer + space. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifOutDiscards"; + } + leaf out-errors { + type yang:counter32; + description + "For packet-oriented interfaces, the number of outbound + packets that could not be transmitted because of errors. + For character-oriented or fixed-length interfaces, the + number of outbound transmission units that could not be + transmitted because of errors. + + Discontinuities in the value of this counter can occur + at re-initialization of the management system, and at + other times as indicated by the value of + 'discontinuity-time'."; + reference + "RFC 2863: The Interfaces Group MIB - ifOutErrors"; + } + } + } + } +} \ No newline at end of file diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-yang-types@2010-09-24.yang b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-yang-types@2010-09-24.yang new file mode 100644 index 0000000000..e9d88ab781 --- /dev/null +++ b/opendaylight/sal/yang-prototype/code-generator/binding-generator-impl/src/test/resources/leafref-test-models/ietf-yang-types@2010-09-24.yang @@ -0,0 +1,396 @@ + module ietf-yang-types { + + namespace "urn:ietf:params:xml:ns:yang:ietf-yang-types"; + prefix "yang"; + + organization + "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; + + contact + "WG Web: + WG List: + + WG Chair: David Partain + + + WG Chair: David Kessens + + + Editor: Juergen Schoenwaelder + "; + + description + "This module contains a collection of generally useful derived + YANG data types. + + Copyright (c) 2010 IETF Trust and the persons identified as + authors of the code. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, is permitted pursuant to, and subject to the license + terms contained in, the Simplified BSD License set forth in Section + 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents + (http://trustee.ietf.org/license-info). + + This version of this YANG module is part of RFC 6021; see + the RFC itself for full legal notices."; + + revision 2010-09-24 { + description + "Initial revision."; + reference + "RFC 6021: Common YANG Data Types"; + } + + /*** collection of counter and gauge types ***/ + + typedef counter32 { + type uint32; + description + "The counter32 type represents a non-negative integer + that monotonically increases until it reaches a + maximum value of 2^32-1 (4294967295 decimal), when it + wraps around and starts increasing again from zero. + + Counters have no defined 'initial' value, and thus, a + single value of a counter has (in general) no information + content. Discontinuities in the monotonically increasing + value normally occur at re-initialization of the + management system, and at other times as specified in the + description of a schema node using this type. If such + other times can occur, for example, the creation of + a schema node of type counter32 at times other than + re-initialization, then a corresponding schema node + should be defined, with an appropriate type, to indicate + the last discontinuity. + + The counter32 type should not be used for configuration + schema nodes. A default statement SHOULD NOT be used in + combination with the type counter32. + + In the value set and its semantics, this type is equivalent + to the Counter32 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 (SMIv2)"; + } + + typedef zero-based-counter32 { + type yang:counter32; + default "0"; + description + "The zero-based-counter32 type represents a counter32 + that has the defined 'initial' value zero. + + A schema node of this type will be set to zero (0) on creation + and will thereafter increase monotonically until it reaches + a maximum value of 2^32-1 (4294967295 decimal), when it + wraps around and starts increasing again from zero. + + Provided that an application discovers a new schema node + of this type within the minimum time to wrap, it can use the + 'initial' value as a delta. It is important for a management + station to be aware of this minimum time and the actual time + between polls, and to discard data if the actual time is too + long or there is no defined minimum time. + + In the value set and its semantics, this type is equivalent + to the ZeroBasedCounter32 textual convention of the SMIv2."; + reference + "RFC 4502: Remote Network Monitoring Management Information + Base Version 2"; + } + + typedef counter64 { + type uint64; + description + "The counter64 type represents a non-negative integer + that monotonically increases until it reaches a + maximum value of 2^64-1 (18446744073709551615 decimal), + when it wraps around and starts increasing again from zero. + + Counters have no defined 'initial' value, and thus, a + single value of a counter has (in general) no information + content. Discontinuities in the monotonically increasing + value normally occur at re-initialization of the + management system, and at other times as specified in the + description of a schema node using this type. If such + other times can occur, for example, the creation of + a schema node of type counter64 at times other than + re-initialization, then a corresponding schema node + should be defined, with an appropriate type, to indicate + the last discontinuity. + + The counter64 type should not be used for configuration + schema nodes. A default statement SHOULD NOT be used in + combination with the type counter64. + + In the value set and its semantics, this type is equivalent + to the Counter64 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 (SMIv2)"; + } + + typedef zero-based-counter64 { + type yang:counter64; + default "0"; + description + "The zero-based-counter64 type represents a counter64 that + has the defined 'initial' value zero. + + A schema node of this type will be set to zero (0) on creation + and will thereafter increase monotonically until it reaches + a maximum value of 2^64-1 (18446744073709551615 decimal), + when it wraps around and starts increasing again from zero. + + Provided that an application discovers a new schema node + of this type within the minimum time to wrap, it can use the + 'initial' value as a delta. It is important for a management + station to be aware of this minimum time and the actual time + between polls, and to discard data if the actual time is too + long or there is no defined minimum time. + + In the value set and its semantics, this type is equivalent + to the ZeroBasedCounter64 textual convention of the SMIv2."; + reference + "RFC 2856: Textual Conventions for Additional High Capacity + Data Types"; + } + + typedef gauge32 { + type uint32; + description + "The gauge32 type represents a non-negative integer, which + may increase or decrease, but shall never exceed a maximum + value, nor fall below a minimum value. The maximum value + cannot be greater than 2^32-1 (4294967295 decimal), and + the minimum value cannot be smaller than 0. The value of + a gauge32 has its maximum value whenever the information + being modeled is greater than or equal to its maximum + value, and has its minimum value whenever the information + being modeled is smaller than or equal to its minimum value. + If the information being modeled subsequently decreases + below (increases above) the maximum (minimum) value, the + gauge32 also decreases (increases). + + In the value set and its semantics, this type is equivalent + to the Gauge32 type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 (SMIv2)"; + } + + typedef gauge64 { + type uint64; + description + "The gauge64 type represents a non-negative integer, which + may increase or decrease, but shall never exceed a maximum + value, nor fall below a minimum value. The maximum value + cannot be greater than 2^64-1 (18446744073709551615), and + the minimum value cannot be smaller than 0. The value of + a gauge64 has its maximum value whenever the information + being modeled is greater than or equal to its maximum + value, and has its minimum value whenever the information + being modeled is smaller than or equal to its minimum value. + If the information being modeled subsequently decreases + below (increases above) the maximum (minimum) value, the + gauge64 also decreases (increases). + + In the value set and its semantics, this type is equivalent + to the CounterBasedGauge64 SMIv2 textual convention defined + in RFC 2856"; + reference + "RFC 2856: Textual Conventions for Additional High Capacity + Data Types"; + } + + /*** collection of identifier related types ***/ + + typedef object-identifier { + type string { + pattern '(([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))' + + '(\.(0|([1-9]\d*)))*'; + } + description + "The object-identifier type represents administratively + assigned names in a registration-hierarchical-name tree. + + Values of this type are denoted as a sequence of numerical + non-negative sub-identifier values. Each sub-identifier + value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers + are separated by single dots and without any intermediate + whitespace. + + The ASN.1 standard restricts the value space of the first + sub-identifier to 0, 1, or 2. Furthermore, the value space + of the second sub-identifier is restricted to the range + 0 to 39 if the first sub-identifier is 0 or 1. Finally, + the ASN.1 standard requires that an object identifier + has always at least two sub-identifier. The pattern + captures these restrictions. + + Although the number of sub-identifiers is not limited, + module designers should realize that there may be + implementations that stick with the SMIv2 limit of 128 + sub-identifiers. + + This type is a superset of the SMIv2 OBJECT IDENTIFIER type + since it is not restricted to 128 sub-identifiers. Hence, + this type SHOULD NOT be used to represent the SMIv2 OBJECT + IDENTIFIER type, the object-identifier-128 type SHOULD be + used instead."; + reference + "ISO9834-1: Information technology -- Open Systems + Interconnection -- Procedures for the operation of OSI + Registration Authorities: General procedures and top + arcs of the ASN.1 Object Identifier tree"; + } + + + + + typedef object-identifier-128 { + type object-identifier { + pattern '\d*(\.\d*){1,127}'; + } + description + "This type represents object-identifiers restricted to 128 + sub-identifiers. + + In the value set and its semantics, this type is equivalent + to the OBJECT IDENTIFIER type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 (SMIv2)"; + } + + /*** collection of date and time related types ***/ + + typedef date-and-time { + type string { + pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?' + + '(Z|[\+\-]\d{2}:\d{2})'; + } + description + "The date-and-time type is a profile of the ISO 8601 + standard for representation of dates and times using the + Gregorian calendar. The profile is defined by the + date-time production in Section 5.6 of RFC 3339. + + The date-and-time type is compatible with the dateTime XML + schema type with the following notable exceptions: + + (a) The date-and-time type does not allow negative years. + + (b) The date-and-time time-offset -00:00 indicates an unknown + time zone (see RFC 3339) while -00:00 and +00:00 and Z all + represent the same time zone in dateTime. + + (c) The canonical format (see below) of data-and-time values + differs from the canonical format used by the dateTime XML + schema type, which requires all times to be in UTC using the + time-offset 'Z'. + + This type is not equivalent to the DateAndTime textual + convention of the SMIv2 since RFC 3339 uses a different + separator between full-date and full-time and provides + higher resolution of time-secfrac. + + The canonical format for date-and-time values with a known time + zone uses a numeric time zone offset that is calculated using + the device's configured known offset to UTC time. A change of + the device's offset to UTC time will cause date-and-time values + to change accordingly. Such changes might happen periodically + in case a server follows automatically daylight saving time + (DST) time zone offset changes. The canonical format for + date-and-time values with an unknown time zone (usually referring + to the notion of local time) uses the time-offset -00:00."; + reference + "RFC 3339: Date and Time on the Internet: Timestamps + RFC 2579: Textual Conventions for SMIv2 + XSD-TYPES: XML Schema Part 2: Datatypes Second Edition"; + } + + typedef timeticks { + type uint32; + description + "The timeticks type represents a non-negative integer that + represents the time, modulo 2^32 (4294967296 decimal), in + hundredths of a second between two epochs. When a schema + node is defined that uses this type, the description of + the schema node identifies both of the reference epochs. + + In the value set and its semantics, this type is equivalent + to the TimeTicks type of the SMIv2."; + reference + "RFC 2578: Structure of Management Information Version 2 (SMIv2)"; + } + + typedef timestamp { + type yang:timeticks; + description + "The timestamp type represents the value of an associated + timeticks schema node at which a specific occurrence happened. + The specific occurrence must be defined in the description + of any schema node defined using this type. When the specific + occurrence occurred prior to the last time the associated + timeticks attribute was zero, then the timestamp value is + zero. Note that this requires all timestamp values to be + reset to zero when the value of the associated timeticks + attribute reaches 497+ days and wraps around to zero. + + The associated timeticks schema node must be specified + in the description of any schema node using this type. + + In the value set and its semantics, this type is equivalent + to the TimeStamp textual convention of the SMIv2."; + reference + "RFC 2579: Textual Conventions for SMIv2"; + } + + /*** collection of generic address types ***/ + + typedef phys-address { + type string { + pattern '([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?'; + } + description + "Represents media- or physical-level addresses represented + as a sequence octets, each octet represented by two hexadecimal + numbers. Octets are separated by colons. The canonical + representation uses lowercase characters. + + In the value set and its semantics, this type is equivalent + to the PhysAddress textual convention of the SMIv2."; + reference + "RFC 2579: Textual Conventions for SMIv2"; + } + + typedef mac-address { + type string { + pattern '[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}'; + } + description + "The mac-address type represents an IEEE 802 MAC address. + The canonical representation uses lowercase characters. + + In the value set and its semantics, this type is equivalent + to the MacAddress textual convention of the SMIv2."; + reference + "IEEE 802: IEEE Standard for Local and Metropolitan Area + Networks: Overview and Architecture + RFC 2579: Textual Conventions for SMIv2"; + } + + /*** collection of XML specific types ***/ + + typedef xpath1.0 { + type string; + description + "This type represents an XPATH 1.0 expression. + + When a schema node is defined that uses this type, the + description of the schema node MUST specify the XPath + context in which the XPath expression is evaluated."; + reference + "XPATH: XML Path Language (XPath) Version 1.0"; + } + + } \ No newline at end of file