binding2/mdsal-binding2-generator-util/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/util/generated/type/builder/AbstractGeneratedTypeBuilder.java

   1 /*
   2  * Copyright (c) 2017 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
   9 package org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder;
  10
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.List;
  15 import java.util.Objects;
  16 import org.opendaylight.mdsal.binding.javav2.generator.util.AbstractBaseType;
  17 import org.opendaylight.mdsal.binding.javav2.model.api.AccessModifier;
  18 import org.opendaylight.mdsal.binding.javav2.model.api.Constant;
  19 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  20 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.AnnotationTypeBuilder;
  21 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.EnumBuilder;
  22 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
  23 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
  24 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
  25 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilderBase;
  26 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
  27 import org.opendaylight.yangtools.util.LazyCollections;
  28
  29 @Beta
  30 abstract class AbstractGeneratedTypeBuilder<T extends GeneratedTypeBuilderBase<T>> extends AbstractBaseType
  31         implements GeneratedTypeBuilderBase<T> {
  32
  33     private List<AnnotationTypeBuilder> annotationBuilders = ImmutableList.of();
  34     private List<Type> implementsTypes = ImmutableList.of();
  35     private List<EnumBuilder> enumDefinitions = ImmutableList.of();
  36     private List<Constant> constants = ImmutableList.of();
  37     private List<MethodSignatureBuilder> methodDefinitions = ImmutableList.of();
  38     private final List<GeneratedTypeBuilder> enclosedTypes = ImmutableList.of();
  39     private List<GeneratedTOBuilder> enclosedTransferObjects = ImmutableList.of();
  40     private List<GeneratedPropertyBuilder> properties = ImmutableList.of();
  41     private String comment = "";
  42     private boolean isAbstract;
  43     private Type parentTypeForBuilder;
  44
  45     protected AbstractGeneratedTypeBuilder(final String packageName, final String name) {
  46         super(packageName, name);
  47     }
  48
  49     protected String getComment() {
  50         return comment;
  51     }
  52
  53     protected List<AnnotationTypeBuilder> getAnnotations() {
  54         return annotationBuilders;
  55     }
  56
  57     @Override
  58     public boolean isAbstract() {
  59         return isAbstract;
  60     }
  61
  62     @Override
  63     public List<Type> getImplementsTypes() {
  64         return implementsTypes;
  65     }
  66
  67     protected List<EnumBuilder> getEnumerations() {
  68         return enumDefinitions;
  69     }
  70
  71     protected List<Constant> getConstants() {
  72         return constants;
  73     }
  74
  75     @Override
  76     public List<MethodSignatureBuilder> getMethodDefinitions() {
  77         return methodDefinitions;
  78     }
  79
  80     protected List<GeneratedTypeBuilder> getEnclosedTypes() {
  81         return enclosedTypes;
  82     }
  83
  84     protected List<GeneratedTOBuilder> getEnclosedTransferObjects() {
  85         return enclosedTransferObjects;
  86     }
  87
  88     protected abstract T thisInstance();
  89
  90     @Override
  91     public GeneratedTOBuilder addEnclosingTransferObject(final String name) {
  92         Preconditions.checkArgument(name != null, "Name for Enclosing Generated Transfer Object cannot be null!");
  93         GeneratedTOBuilder builder = new GeneratedTOBuilderImpl(getFullyQualifiedName(), name);
  94
  95         Preconditions.checkArgument(!enclosedTransferObjects.contains(builder), "This generated type already contains equal enclosing transfer object.");
  96         enclosedTransferObjects = LazyCollections.lazyAdd(enclosedTransferObjects, builder);
  97         return builder;
  98     }
  99
 100     @Override
 101     public T addEnclosingTransferObject(final GeneratedTOBuilder genTOBuilder) {
 102         Preconditions.checkArgument(genTOBuilder != null, "Parameter genTOBuilder cannot be null!");
 103         Preconditions.checkArgument(!enclosedTransferObjects.contains(genTOBuilder), "This generated type already contains equal enclosing transfer object.");
 104         enclosedTransferObjects = LazyCollections.lazyAdd(enclosedTransferObjects, genTOBuilder);
 105         return thisInstance();
 106     }
 107
 108     @Override
 109     public T addComment(final String comment) {
 110         this.comment = comment;
 111         return thisInstance();
 112     }
 113
 114     @Override
 115     public AnnotationTypeBuilder addAnnotation(final String packageName, final String name) {
 116         Preconditions.checkArgument(packageName != null, "Package Name for Annotation Type cannot be null!");
 117         Preconditions.checkArgument(name != null, "Name of Annotation Type cannot be null!");
 118
 119         final AnnotationTypeBuilder builder = new AnnotationTypeBuilderImpl(packageName, name);
 120
 121         Preconditions.checkArgument(!annotationBuilders.contains(builder), "This generated type already contains equal annotation.");
 122         annotationBuilders = LazyCollections.lazyAdd(annotationBuilders, builder);
 123         return builder;
 124     }
 125
 126     @Override
 127     public T setAbstract(final boolean isAbstract) {
 128         this.isAbstract = isAbstract;
 129         return thisInstance();
 130     }
 131
 132     @Override
 133     public T addImplementsType(final Type genType) {
 134         Preconditions.checkArgument(genType != null, "Type cannot be null");
 135         Preconditions.checkArgument(!implementsTypes.contains(genType), "This generated type already contains equal implements type.");
 136         implementsTypes = LazyCollections.lazyAdd(implementsTypes, genType);
 137         return thisInstance();
 138     }
 139
 140     @Override
 141     public Constant addConstant(final Type type, final String name, final Object value) {
 142         Preconditions.checkArgument(type != null, "Returning Type for Constant cannot be null!");
 143         Preconditions.checkArgument(name != null, "Name of constant cannot be null!");
 144         Preconditions.checkArgument(!containsConstant(name), "This generated type already contains constant with the same name.");
 145
 146         final Constant constant = new ConstantImpl(this, type, name, value);
 147         constants = LazyCollections.lazyAdd(constants, constant);
 148         return constant;
 149     }
 150
 151     @Override
 152     public Type setParentTypeForBuilder(Type type) {
 153         return this.parentTypeForBuilder = type;
 154     }
 155
 156     public boolean containsConstant(final String name) {
 157         Preconditions.checkArgument(name != null, "Parameter name can't be null");
 158         for (Constant constant : constants) {
 159             if (name.equals(constant.getName())) {
 160                 return true;
 161             }
 162         }
 163         return false;
 164     }
 165
 166     @Override
 167     public EnumBuilder addEnumeration(final String name) {
 168         Preconditions.checkArgument(name != null, "Name of enumeration cannot be null!");
 169         final EnumBuilder builder = new EnumerationBuilderImpl(getFullyQualifiedName(), name);
 170
 171         Preconditions.checkArgument(!enumDefinitions.contains(builder), "This generated type already contains equal enumeration.");
 172         enumDefinitions = LazyCollections.lazyAdd(enumDefinitions, builder);
 173         return builder;
 174     }
 175
 176     @Override
 177     public MethodSignatureBuilder addMethod(final String name) {
 178         Preconditions.checkArgument(name != null, "Name of method cannot be null!");
 179         final MethodSignatureBuilder builder = new MethodSignatureBuilderImpl(name);
 180         builder.setAccessModifier(AccessModifier.PUBLIC);
 181         builder.setAbstract(true);
 182         methodDefinitions = LazyCollections.lazyAdd(methodDefinitions, builder);
 183         return builder;
 184     }
 185
 186     @Override
 187     public boolean containsMethod(final String name) {
 188         Preconditions.checkArgument(name != null, "Parameter name can't be null");
 189         for (MethodSignatureBuilder methodDefinition : methodDefinitions) {
 190             if (name.equals(methodDefinition.getName())) {
 191                 return true;
 192             }
 193         }
 194         return false;
 195     }
 196
 197     @Override
 198     public GeneratedPropertyBuilder addProperty(final String name) {
 199         Preconditions.checkArgument(name != null, "Parameter name can't be null");
 200         Preconditions.checkArgument(!containsProperty(name), "This generated type already contains property with the same name.");
 201
 202         final GeneratedPropertyBuilder builder = new GeneratedPropertyBuilderImpl(name);
 203         builder.setAccessModifier(AccessModifier.PUBLIC);
 204         properties = LazyCollections.lazyAdd(properties, builder);
 205         return builder;
 206     }
 207
 208     @Override
 209     public boolean containsProperty(final String name) {
 210         Preconditions.checkArgument(name != null, "Parameter name can't be null");
 211         for (GeneratedPropertyBuilder property : properties) {
 212             if (name.equals(property.getName())) {
 213                 return true;
 214             }
 215         }
 216         return false;
 217     }
 218
 219     @Override
 220     public int hashCode() {
 221         return Objects.hash(getName(), getPackageName());
 222     }
 223
 224     @Override
 225     public boolean equals(final Object obj) {
 226         if (this == obj) {
 227             return true;
 228         }
 229         if (obj == null) {
 230             return false;
 231         }
 232         if (getClass() != obj.getClass()) {
 233             return false;
 234         }
 235
 236         if (!(obj instanceof AbstractGeneratedTypeBuilder)) {
 237             return false;
 238         }
 239
 240         AbstractGeneratedTypeBuilder<?> other = (AbstractGeneratedTypeBuilder<?>) obj;
 241         return Objects.equals(this, other);
 242     }
 243
 244     public Type getParent() {
 245         return null;
 246     }
 247
 248     public Type getParentTypeForBuilder() {
 249         return parentTypeForBuilder;
 250     }
 251
 252     @Override
 253     public List<GeneratedPropertyBuilder> getProperties() {
 254         return properties;
 255     }
 256
 257 }