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