Merge "Added tests for yang.model.util"
[yangtools.git] / code-generator / binding-generator-util / src / main / java / org / opendaylight / yangtools / binding / generator / util / generated / type / builder / GeneratedTOBuilderImpl.java
index 9a78eabf820ea235dc4844b9c4499fe2d85603e6..8d1bcea0e80be00fd1ccc4bc9923747474b6f076 100644 (file)
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.binding.generator.util.generated.type.builder;\r
-\r
-import java.util.ArrayList;\r
-import java.util.List;\r
-\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty;\r
-import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;\r
-import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;\r
-import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;\r
-\r
-public final class GeneratedTOBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder> implements\r
-        GeneratedTOBuilder {\r
-\r
-    private GeneratedTransferObject extendsType;\r
-    private final List<GeneratedPropertyBuilder> properties = new ArrayList<>();\r
-    private final List<GeneratedPropertyBuilder> equalsProperties = new ArrayList<>();\r
-    private final List<GeneratedPropertyBuilder> hashProperties = new ArrayList<>();\r
-    private final List<GeneratedPropertyBuilder> toStringProperties = new ArrayList<>();\r
-    private boolean isUnionType = false;\r
-    private Restrictions restrictions;\r
-    private GeneratedPropertyBuilder SUID;\r
-\r
-    public GeneratedTOBuilderImpl(String packageName, String name) {\r
-        super(packageName, name);\r
-        setAbstract(false);\r
-    }\r
-\r
-    @Override\r
-    public GeneratedTOBuilder setExtendsType(final GeneratedTransferObject genTransObj) {\r
-        if (genTransObj == null) {\r
-            throw new IllegalArgumentException("Generated Transfer Object cannot be null!");\r
-        }\r
-        extendsType = genTransObj;\r
-        return this;\r
-    }\r
-\r
-    /**\r
-     * Add new Method Signature definition for Generated Type Builder and\r
-     * returns Method Signature Builder for specifying all Method parameters. <br>\r
-     * Name of Method cannot be <code>null</code>, if it is <code>null</code>\r
-     * the method SHOULD throw {@link IllegalArgumentException} <br>\r
-     * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as\r
-     * {@link MethodSignatureBuilder#setAbstract(boolean)},\r
-     * {TypeMemberBuilder#setFinal(boolean)} and\r
-     * {TypeMemberBuilder#setAccessModifier(boolean)}\r
-     *\r
-     * @param name\r
-     *            Name of Method\r
-     * @return <code>new</code> instance of Method Signature Builder.\r
-     */\r
-    @Override\r
-    public MethodSignatureBuilder addMethod(String name) {\r
-        final MethodSignatureBuilder builder = super.addMethod(name);\r
-        builder.setAbstract(false);\r
-        return builder;\r
-    }\r
-\r
-    @Override\r
-    public GeneratedTOBuilder addEqualsIdentity(GeneratedPropertyBuilder property) {\r
-        equalsProperties.add(property);\r
-        return this;\r
-    }\r
-\r
-    @Override\r
-    public GeneratedTOBuilder addHashIdentity(GeneratedPropertyBuilder property) {\r
-        hashProperties.add(property);\r
-        return this;\r
-    }\r
-\r
-    @Override\r
-    public GeneratedTOBuilder addToStringProperty(GeneratedPropertyBuilder property) {\r
-        toStringProperties.add(property);\r
-        return this;\r
-    }\r
-\r
-    @Override\r
-    protected GeneratedTOBuilder thisInstance() {\r
-        return this;\r
-    }\r
-\r
-    @Override\r
-    public void setRestrictions(Restrictions restrictions) {\r
-        this.restrictions = restrictions;\r
-    }\r
-\r
-    @Override\r
-    public void setSUID(GeneratedPropertyBuilder suid) {\r
-        this.SUID = suid;\r
-    }\r
-\r
-    @Override\r
-    public GeneratedTransferObject toInstance() {\r
-        return new GeneratedTransferObjectImpl(this);\r
-    }\r
-\r
-    @Override\r
-    public String toString() {\r
-        StringBuilder builder = new StringBuilder();\r
-        builder.append("GeneratedTransferObject [packageName=");\r
-        builder.append(getPackageName());\r
-        builder.append(", name=");\r
-        builder.append(getName());\r
-        builder.append(", comment=");\r
-        builder.append(getComment());\r
-        builder.append(", constants=");\r
-        builder.append(getConstants());\r
-        builder.append(", enumerations=");\r
-        builder.append(getEnumerations());\r
-        builder.append(", properties=");\r
-        builder.append(properties);\r
-        builder.append(", equalsProperties=");\r
-        builder.append(equalsProperties);\r
-        builder.append(", hashCodeProperties=");\r
-        builder.append(hashProperties);\r
-        builder.append(", stringProperties=");\r
-        builder.append(toStringProperties);\r
-        builder.append(", annotations=");\r
-        builder.append(getAnnotations());\r
-        builder.append(", methods=");\r
-        builder.append(getMethodDefinitions());\r
-        builder.append("]");\r
-        return builder.toString();\r
-    }\r
-\r
-    @Override\r
-    public void setIsUnion(boolean isUnion) {\r
-        this.isUnionType = isUnion;\r
-    }\r
-\r
-    private static final class GeneratedTransferObjectImpl extends AbstractGeneratedType implements\r
-            GeneratedTransferObject {\r
-\r
-        private final List<GeneratedProperty> equalsProperties;\r
-        private final List<GeneratedProperty> hashCodeProperties;\r
-        private final List<GeneratedProperty> stringProperties;\r
-        private final GeneratedTransferObject extendsType;\r
-        private final boolean isUnionType;\r
-        private final Restrictions restrictions;\r
-        private final GeneratedProperty SUID;\r
-\r
-        public GeneratedTransferObjectImpl(GeneratedTOBuilderImpl builder) {\r
-            super(builder);\r
-            this.extendsType = builder.extendsType;\r
-            this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);\r
-            this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);\r
-            this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);\r
-            this.isUnionType = builder.isUnionType;\r
-            this.restrictions = builder.restrictions;\r
-            if (builder.SUID == null) {\r
-                this.SUID = null;\r
-            } else {\r
-                this.SUID = builder.SUID.toInstance(GeneratedTransferObjectImpl.this);\r
-            }\r
-        }\r
-\r
-        @Override\r
-        public boolean isUnionType() {\r
-            return isUnionType;\r
-        }\r
-\r
-        @Override\r
-        public GeneratedTransferObject getSuperType() {\r
-            return extendsType;\r
-        }\r
-\r
-        @Override\r
-        public List<GeneratedProperty> getEqualsIdentifiers() {\r
-            return equalsProperties;\r
-        }\r
-\r
-        @Override\r
-        public List<GeneratedProperty> getHashCodeIdentifiers() {\r
-            return hashCodeProperties;\r
-        }\r
-\r
-        @Override\r
-        public List<GeneratedProperty> getToStringIdentifiers() {\r
-            return stringProperties;\r
-        }\r
-\r
-        @Override\r
-        public Restrictions getRestrictions() {\r
-            return restrictions;\r
-        }\r
-\r
-        @Override\r
-        public GeneratedProperty getSUID() {\r
-            return SUID;\r
-        }\r
-\r
-        @Override\r
-        public String toString() {\r
-            StringBuilder builder = new StringBuilder();\r
-            builder.append("GeneratedTransferObject [packageName=");\r
-            builder.append(getPackageName());\r
-            builder.append(", name=");\r
-            builder.append(getName());\r
-            builder.append(", comment=");\r
-            builder.append(", annotations=");\r
-            builder.append(getAnnotations());\r
-            builder.append(getComment());\r
-            builder.append(", extends=");\r
-            builder.append(getSuperType());\r
-            builder.append(", implements=");\r
-            builder.append(getImplements());\r
-            builder.append(", enclosedTypes=");\r
-            builder.append(getEnclosedTypes());\r
-            builder.append(", constants=");\r
-            builder.append(getConstantDefinitions());\r
-            builder.append(", enumerations=");\r
-            builder.append(getEnumerations());\r
-            builder.append(", properties=");\r
-            builder.append(getProperties());\r
-            builder.append(", equalsProperties=");\r
-            builder.append(equalsProperties);\r
-            builder.append(", hashCodeProperties=");\r
-            builder.append(hashCodeProperties);\r
-            builder.append(", stringProperties=");\r
-            builder.append(stringProperties);\r
-            builder.append(", methods=");\r
-            builder.append(getMethodDefinitions());\r
-            builder.append("]");\r
-            return builder.toString();\r
-        }\r
-    }\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.binding.generator.util.generated.type.builder;
+
+import com.google.common.base.Preconditions;
+import java.util.Collections;
+import java.util.List;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty;
+import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
+import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
+import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
+import org.opendaylight.yangtools.sal.binding.model.api.Type;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
+import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
+import org.opendaylight.yangtools.util.LazyCollections;
+import org.opendaylight.yangtools.yang.common.QName;
+
+public final class GeneratedTOBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder> implements GeneratedTOBuilder {
+
+    private GeneratedTransferObject extendsType;
+    private List<GeneratedPropertyBuilder> equalsProperties = Collections.emptyList();
+    private List<GeneratedPropertyBuilder> hashProperties = Collections.emptyList();
+    private List<GeneratedPropertyBuilder> toStringProperties = Collections.emptyList();
+    private boolean isTypedef = false;
+    private boolean isUnionType = false;
+    private boolean isUnionTypeBuilder = false;
+    private Restrictions restrictions;
+    private GeneratedPropertyBuilder SUID;
+    private String reference;
+    private String description;
+    private String moduleName;
+    private Iterable<QName> schemaPath;
+
+    public GeneratedTOBuilderImpl(final String packageName, final String name) {
+        super(packageName, name);
+        setAbstract(false);
+    }
+
+    @Override
+    public GeneratedTOBuilder setExtendsType(final GeneratedTransferObject genTransObj) {
+        Preconditions.checkArgument(genTransObj != null, "Generated Transfer Object cannot be null!");
+        extendsType = genTransObj;
+        return this;
+    }
+
+    /**
+     * Add new Method Signature definition for Generated Type Builder and
+     * returns Method Signature Builder for specifying all Method parameters. <br>
+     * Name of Method cannot be <code>null</code>, if it is <code>null</code>
+     * the method SHOULD throw {@link IllegalArgumentException} <br>
+     * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as
+     * {@link MethodSignatureBuilder#setAbstract(boolean)},
+     * {TypeMemberBuilder#setFinal(boolean)} and
+     * {TypeMemberBuilder#setAccessModifier(boolean)}
+     *
+     * @param name
+     *            Name of Method
+     * @return <code>new</code> instance of Method Signature Builder.
+     */
+    @Override
+    public MethodSignatureBuilder addMethod(final String name) {
+        final MethodSignatureBuilder builder = super.addMethod(name);
+        builder.setAbstract(false);
+        return builder;
+    }
+
+    @Override
+    public GeneratedTOBuilder addEqualsIdentity(final GeneratedPropertyBuilder property) {
+        equalsProperties = LazyCollections.lazyAdd(equalsProperties, property);
+        return this;
+    }
+
+    @Override
+    public GeneratedTOBuilder addHashIdentity(final GeneratedPropertyBuilder property) {
+        hashProperties = LazyCollections.lazyAdd(hashProperties, property);
+        return this;
+    }
+
+    @Override
+    public GeneratedTOBuilder addToStringProperty(final GeneratedPropertyBuilder property) {
+        toStringProperties = LazyCollections.lazyAdd(toStringProperties, property);
+        return this;
+    }
+
+    @Override
+    protected GeneratedTOBuilder thisInstance() {
+        return this;
+    }
+
+    @Override
+    public void setRestrictions(final Restrictions restrictions) {
+        this.restrictions = restrictions;
+    }
+
+    @Override
+    public void setSUID(final GeneratedPropertyBuilder suid) {
+        this.SUID = suid;
+    }
+
+    @Override
+    public GeneratedTransferObject toInstance() {
+        return new GeneratedTransferObjectImpl(this);
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder builder = new StringBuilder();
+        builder.append("GeneratedTransferObject [packageName=");
+        builder.append(getPackageName());
+        builder.append(", name=");
+        builder.append(getName());
+        builder.append(", comment=");
+        builder.append(getComment());
+        builder.append(", constants=");
+        builder.append(getConstants());
+        builder.append(", enumerations=");
+        builder.append(getEnumerations());
+        builder.append(", equalsProperties=");
+        builder.append(equalsProperties);
+        builder.append(", hashCodeProperties=");
+        builder.append(hashProperties);
+        builder.append(", stringProperties=");
+        builder.append(toStringProperties);
+        builder.append(", annotations=");
+        builder.append(getAnnotations());
+        builder.append(", methods=");
+        builder.append(getMethodDefinitions());
+        builder.append("]");
+        return builder.toString();
+    }
+
+    @Override
+    public void setTypedef(final boolean isTypedef) {
+        this.isTypedef = isTypedef;
+    }
+
+    @Override
+    public void setIsUnion(final boolean isUnion) {
+        this.isUnionType = isUnion;
+    }
+
+    @Override
+    public void setIsUnionBuilder(final boolean isUnionTypeBuilder) {
+        this.isUnionTypeBuilder = isUnionTypeBuilder;
+    }
+
+    @Override
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    @Override
+    public void setModuleName(String moduleName) {
+        this.moduleName = moduleName;
+    }
+
+    @Override
+    public void setSchemaPath(Iterable<QName> schemaPath) {
+        this.schemaPath = schemaPath;
+    }
+
+    @Override
+    public void setReference(String reference) {
+        this.reference = reference;
+    }
+
+    private static final class GeneratedTransferObjectImpl extends AbstractGeneratedType implements
+    GeneratedTransferObject {
+
+        private final List<GeneratedProperty> equalsProperties;
+        private final List<GeneratedProperty> hashCodeProperties;
+        private final List<GeneratedProperty> stringProperties;
+        private final GeneratedTransferObject extendsType;
+        private final boolean isTypedef;
+        private final boolean isUnionType;
+        private final boolean isUnionTypeBuilder;
+        private final Restrictions restrictions;
+        private final GeneratedProperty SUID;
+        private final String reference;
+        private final String description;
+        private final String moduleName;
+        private final Iterable<QName> schemaPath;
+
+        public GeneratedTransferObjectImpl(final GeneratedTOBuilderImpl builder) {
+            super(builder);
+            this.extendsType = builder.extendsType;
+
+            // FIXME: if these fields were guaranteed to be constant, we could perhaps
+            //        cache and reuse them between instances...
+            this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);
+            this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);
+            this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);
+
+            this.isTypedef = builder.isTypedef;
+            this.isUnionType = builder.isUnionType;
+            this.isUnionTypeBuilder = builder.isUnionTypeBuilder;
+            this.restrictions = builder.restrictions;
+            this.reference = builder.reference;
+            this.description = builder.description;
+            this.moduleName = builder.moduleName;
+            this.schemaPath = builder.schemaPath;
+
+            if (builder.SUID == null) {
+                this.SUID = null;
+            } else {
+                this.SUID = builder.SUID.toInstance(GeneratedTransferObjectImpl.this);
+            }
+        }
+
+        @Override
+        public boolean isTypedef() {
+            return isTypedef;
+        }
+
+        @Override
+        public boolean isUnionType() {
+            return isUnionType;
+        }
+
+        @Override
+        public boolean isUnionTypeBuilder() {
+            return isUnionTypeBuilder;
+        }
+
+        @Override
+        public GeneratedTransferObject getSuperType() {
+            return extendsType;
+        }
+
+        @Override
+        public List<GeneratedProperty> getEqualsIdentifiers() {
+            return equalsProperties;
+        }
+
+        @Override
+        public List<GeneratedProperty> getHashCodeIdentifiers() {
+            return hashCodeProperties;
+        }
+
+        @Override
+        public List<GeneratedProperty> getToStringIdentifiers() {
+            return stringProperties;
+        }
+
+        @Override
+        public Restrictions getRestrictions() {
+            return restrictions;
+        }
+
+        @Override
+        public GeneratedProperty getSUID() {
+            return SUID;
+        }
+
+        @Override
+        public String toString() {
+            if (isTypedef) {
+                return serializeTypedef(this);
+            }
+            StringBuilder builder = new StringBuilder();
+            builder.append("GeneratedTransferObject [packageName=");
+            builder.append(getPackageName());
+            builder.append(", name=");
+            builder.append(getName());
+            builder.append(", comment=");
+            builder.append(", annotations=");
+            builder.append(getAnnotations());
+            builder.append(getComment());
+            builder.append(", extends=");
+            builder.append(getSuperType());
+            builder.append(", implements=");
+            builder.append(getImplements());
+            builder.append(", enclosedTypes=");
+            builder.append(getEnclosedTypes());
+            builder.append(", constants=");
+            builder.append(getConstantDefinitions());
+            builder.append(", enumerations=");
+            builder.append(getEnumerations());
+            builder.append(", properties=");
+            builder.append(getProperties());
+            builder.append(", equalsProperties=");
+            builder.append(equalsProperties);
+            builder.append(", hashCodeProperties=");
+            builder.append(hashCodeProperties);
+            builder.append(", stringProperties=");
+            builder.append(stringProperties);
+            builder.append(", methods=");
+            builder.append(getMethodDefinitions());
+            builder.append("]");
+            return builder.toString();
+        }
+
+        public String serializeTypedef(final Type type) {
+            if (type instanceof ParameterizedType) {
+                ParameterizedType parameterizedType = (ParameterizedType) type;
+                StringBuffer sb = new StringBuffer();
+                sb.append(parameterizedType.getRawType().getFullyQualifiedName());
+                sb.append("<");
+                boolean first = true;
+                for (Type parameter : parameterizedType.getActualTypeArguments()) {
+                    if (first) {
+                        first = false;
+                    } else {
+                        sb.append(",");
+                    }
+                    sb.append(serializeTypedef(parameter));
+                }
+                sb.append(">");
+                return sb.toString();
+            } else {
+                return type.getFullyQualifiedName();
+            }
+        }
+
+        @Override
+        public String getDescription() {
+            return description;
+        }
+
+        @Override
+        public String getReference() {
+            return reference;
+        }
+
+        @Override
+        public Iterable<QName> getSchemaPath() {
+            return schemaPath;
+        }
+
+        @Override
+        public String getModuleName() {
+            return moduleName;
+        }
+
+        @Override
+        public boolean isSuitableForBoxing() {
+            return false;
+        }
+    }
+}