code-generator/binding-generator-util/src/main/java/org/opendaylight/yangtools/binding/generator/util/generated/type/builder/GeneratedTOBuilderImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.binding.generator.util.generated.type.builder;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.Collections;
  12 import java.util.List;
  13 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedProperty;
  14 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
  15 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
  16 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
  17 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  18 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
  19 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
  20 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
  21 import org.opendaylight.yangtools.util.LazyCollections;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23
  24 public final class GeneratedTOBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder> implements GeneratedTOBuilder {
  25
  26     private GeneratedTransferObject extendsType;
  27     private List<GeneratedPropertyBuilder> equalsProperties = Collections.emptyList();
  28     private List<GeneratedPropertyBuilder> hashProperties = Collections.emptyList();
  29     private List<GeneratedPropertyBuilder> toStringProperties = Collections.emptyList();
  30     private boolean isTypedef = false;
  31     private boolean isUnionType = false;
  32     private boolean isUnionTypeBuilder = false;
  33     private Restrictions restrictions;
  34     private GeneratedPropertyBuilder SUID;
  35     private String reference;
  36     private String description;
  37     private String moduleName;
  38     private Iterable<QName> schemaPath;
  39
  40     public GeneratedTOBuilderImpl(final String packageName, final String name) {
  41         super(packageName, name);
  42         setAbstract(false);
  43     }
  44
  45     @Override
  46     public GeneratedTOBuilder setExtendsType(final GeneratedTransferObject genTransObj) {
  47         Preconditions.checkArgument(genTransObj != null, "Generated Transfer Object cannot be null!");
  48         extendsType = genTransObj;
  49         return this;
  50     }
  51
  52     /**
  53      * Add new Method Signature definition for Generated Type Builder and
  54      * returns Method Signature Builder for specifying all Method parameters. <br>
  55      * Name of Method cannot be <code>null</code>, if it is <code>null</code>
  56      * the method SHOULD throw {@link IllegalArgumentException} <br>
  57      * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as
  58      * {@link MethodSignatureBuilder#setAbstract(boolean)},
  59      * {TypeMemberBuilder#setFinal(boolean)} and
  60      * {TypeMemberBuilder#setAccessModifier(boolean)}
  61      *
  62      * @param name
  63      *            Name of Method
  64      * @return <code>new</code> instance of Method Signature Builder.
  65      */
  66     @Override
  67     public MethodSignatureBuilder addMethod(final String name) {
  68         final MethodSignatureBuilder builder = super.addMethod(name);
  69         builder.setAbstract(false);
  70         return builder;
  71     }
  72
  73     @Override
  74     public GeneratedTOBuilder addEqualsIdentity(final GeneratedPropertyBuilder property) {
  75         equalsProperties = LazyCollections.lazyAdd(equalsProperties, property);
  76         return this;
  77     }
  78
  79     @Override
  80     public GeneratedTOBuilder addHashIdentity(final GeneratedPropertyBuilder property) {
  81         hashProperties = LazyCollections.lazyAdd(hashProperties, property);
  82         return this;
  83     }
  84
  85     @Override
  86     public GeneratedTOBuilder addToStringProperty(final GeneratedPropertyBuilder property) {
  87         toStringProperties = LazyCollections.lazyAdd(toStringProperties, property);
  88         return this;
  89     }
  90
  91     @Override
  92     protected GeneratedTOBuilder thisInstance() {
  93         return this;
  94     }
  95
  96     @Override
  97     public void setRestrictions(final Restrictions restrictions) {
  98         this.restrictions = restrictions;
  99     }
 100
 101     @Override
 102     public void setSUID(final GeneratedPropertyBuilder suid) {
 103         this.SUID = suid;
 104     }
 105
 106     @Override
 107     public GeneratedTransferObject toInstance() {
 108         return new GeneratedTransferObjectImpl(this);
 109     }
 110
 111     @Override
 112     public String toString() {
 113         StringBuilder builder = new StringBuilder();
 114         builder.append("GeneratedTransferObject [packageName=");
 115         builder.append(getPackageName());
 116         builder.append(", name=");
 117         builder.append(getName());
 118         builder.append(", comment=");
 119         builder.append(getComment());
 120         builder.append(", constants=");
 121         builder.append(getConstants());
 122         builder.append(", enumerations=");
 123         builder.append(getEnumerations());
 124         builder.append(", equalsProperties=");
 125         builder.append(equalsProperties);
 126         builder.append(", hashCodeProperties=");
 127         builder.append(hashProperties);
 128         builder.append(", stringProperties=");
 129         builder.append(toStringProperties);
 130         builder.append(", annotations=");
 131         builder.append(getAnnotations());
 132         builder.append(", methods=");
 133         builder.append(getMethodDefinitions());
 134         builder.append("]");
 135         return builder.toString();
 136     }
 137
 138     @Override
 139     public void setTypedef(final boolean isTypedef) {
 140         this.isTypedef = isTypedef;
 141     }
 142
 143     @Override
 144     public void setIsUnion(final boolean isUnion) {
 145         this.isUnionType = isUnion;
 146     }
 147
 148     @Override
 149     public void setIsUnionBuilder(final boolean isUnionTypeBuilder) {
 150         this.isUnionTypeBuilder = isUnionTypeBuilder;
 151     }
 152
 153     @Override
 154     public void setDescription(String description) {
 155         this.description = description;
 156     }
 157
 158     @Override
 159     public void setModuleName(String moduleName) {
 160         this.moduleName = moduleName;
 161     }
 162
 163     @Override
 164     public void setSchemaPath(Iterable<QName> schemaPath) {
 165         this.schemaPath = schemaPath;
 166     }
 167
 168     @Override
 169     public void setReference(String reference) {
 170         this.reference = reference;
 171     }
 172
 173     private static final class GeneratedTransferObjectImpl extends AbstractGeneratedType implements
 174     GeneratedTransferObject {
 175
 176         private final List<GeneratedProperty> equalsProperties;
 177         private final List<GeneratedProperty> hashCodeProperties;
 178         private final List<GeneratedProperty> stringProperties;
 179         private final GeneratedTransferObject extendsType;
 180         private final boolean isTypedef;
 181         private final boolean isUnionType;
 182         private final boolean isUnionTypeBuilder;
 183         private final Restrictions restrictions;
 184         private final GeneratedProperty SUID;
 185         private final String reference;
 186         private final String description;
 187         private final String moduleName;
 188         private final Iterable<QName> schemaPath;
 189
 190         public GeneratedTransferObjectImpl(final GeneratedTOBuilderImpl builder) {
 191             super(builder);
 192             this.extendsType = builder.extendsType;
 193
 194             // FIXME: if these fields were guaranteed to be constant, we could perhaps
 195             //        cache and reuse them between instances...
 196             this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);
 197             this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);
 198             this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);
 199
 200             this.isTypedef = builder.isTypedef;
 201             this.isUnionType = builder.isUnionType;
 202             this.isUnionTypeBuilder = builder.isUnionTypeBuilder;
 203             this.restrictions = builder.restrictions;
 204             this.reference = builder.reference;
 205             this.description = builder.description;
 206             this.moduleName = builder.moduleName;
 207             this.schemaPath = builder.schemaPath;
 208
 209             if (builder.SUID == null) {
 210                 this.SUID = null;
 211             } else {
 212                 this.SUID = builder.SUID.toInstance(GeneratedTransferObjectImpl.this);
 213             }
 214         }
 215
 216         @Override
 217         public boolean isTypedef() {
 218             return isTypedef;
 219         }
 220
 221         @Override
 222         public boolean isUnionType() {
 223             return isUnionType;
 224         }
 225
 226         @Override
 227         public boolean isUnionTypeBuilder() {
 228             return isUnionTypeBuilder;
 229         }
 230
 231         @Override
 232         public GeneratedTransferObject getSuperType() {
 233             return extendsType;
 234         }
 235
 236         @Override
 237         public List<GeneratedProperty> getEqualsIdentifiers() {
 238             return equalsProperties;
 239         }
 240
 241         @Override
 242         public List<GeneratedProperty> getHashCodeIdentifiers() {
 243             return hashCodeProperties;
 244         }
 245
 246         @Override
 247         public List<GeneratedProperty> getToStringIdentifiers() {
 248             return stringProperties;
 249         }
 250
 251         @Override
 252         public Restrictions getRestrictions() {
 253             return restrictions;
 254         }
 255
 256         @Override
 257         public GeneratedProperty getSUID() {
 258             return SUID;
 259         }
 260
 261         @Override
 262         public String toString() {
 263             if (isTypedef) {
 264                 return serializeTypedef(this);
 265             }
 266             StringBuilder builder = new StringBuilder();
 267             builder.append("GeneratedTransferObject [packageName=");
 268             builder.append(getPackageName());
 269             builder.append(", name=");
 270             builder.append(getName());
 271             builder.append(", comment=");
 272             builder.append(", annotations=");
 273             builder.append(getAnnotations());
 274             builder.append(getComment());
 275             builder.append(", extends=");
 276             builder.append(getSuperType());
 277             builder.append(", implements=");
 278             builder.append(getImplements());
 279             builder.append(", enclosedTypes=");
 280             builder.append(getEnclosedTypes());
 281             builder.append(", constants=");
 282             builder.append(getConstantDefinitions());
 283             builder.append(", enumerations=");
 284             builder.append(getEnumerations());
 285             builder.append(", properties=");
 286             builder.append(getProperties());
 287             builder.append(", equalsProperties=");
 288             builder.append(equalsProperties);
 289             builder.append(", hashCodeProperties=");
 290             builder.append(hashCodeProperties);
 291             builder.append(", stringProperties=");
 292             builder.append(stringProperties);
 293             builder.append(", methods=");
 294             builder.append(getMethodDefinitions());
 295             builder.append("]");
 296             return builder.toString();
 297         }
 298
 299         public String serializeTypedef(final Type type) {
 300             if (type instanceof ParameterizedType) {
 301                 ParameterizedType parameterizedType = (ParameterizedType) type;
 302                 StringBuffer sb = new StringBuffer();
 303                 sb.append(parameterizedType.getRawType().getFullyQualifiedName());
 304                 sb.append("<");
 305                 boolean first = true;
 306                 for (Type parameter : parameterizedType.getActualTypeArguments()) {
 307                     if (first) {
 308                         first = false;
 309                     } else {
 310                         sb.append(",");
 311                     }
 312                     sb.append(serializeTypedef(parameter));
 313                 }
 314                 sb.append(">");
 315                 return sb.toString();
 316             } else {
 317                 return type.getFullyQualifiedName();
 318             }
 319         }
 320
 321         @Override
 322         public String getDescription() {
 323             return description;
 324         }
 325
 326         @Override
 327         public String getReference() {
 328             return reference;
 329         }
 330
 331         @Override
 332         public Iterable<QName> getSchemaPath() {
 333             return schemaPath;
 334         }
 335
 336         @Override
 337         public String getModuleName() {
 338             return moduleName;
 339         }
 340     }
 341 }