binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/generated/type/builder/AbstractGeneratedType.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.mdsal.binding.model.util.generated.type.builder;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.List;
  13 import java.util.Optional;
  14 import org.opendaylight.mdsal.binding.model.api.AnnotationType;
  15 import org.opendaylight.mdsal.binding.model.api.Constant;
  16 import org.opendaylight.mdsal.binding.model.api.Enumeration;
  17 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  18 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  19 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  20 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  21 import org.opendaylight.mdsal.binding.model.api.Type;
  22 import org.opendaylight.mdsal.binding.model.api.TypeComment;
  23 import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition;
  24 import org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder;
  25 import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder;
  26 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
  27 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
  28 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  29 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
  30 import org.opendaylight.mdsal.binding.model.util.AbstractBaseType;
  31
  32 abstract class AbstractGeneratedType extends AbstractBaseType implements GeneratedType {
  33
  34     private final Type parent;
  35     private final TypeComment comment;
  36     private final List<AnnotationType> annotations;
  37     private final List<Type> implementsTypes;
  38     private final List<Enumeration> enumerations;
  39     private final List<Constant> constants;
  40     private final List<MethodSignature> methodSignatures;
  41     private final List<GeneratedType> enclosedTypes;
  42     private final List<GeneratedProperty> properties;
  43     private final boolean isAbstract;
  44     private final YangSourceDefinition definition;
  45
  46     AbstractGeneratedType(final AbstractGeneratedTypeBuilder<?> builder) {
  47         super(builder.getIdentifier());
  48         this.parent = builder.getParent();
  49         this.comment = builder.getComment();
  50         this.annotations = toUnmodifiableAnnotations(builder.getAnnotations());
  51         this.implementsTypes = makeUnmodifiable(builder.getImplementsTypes());
  52         this.constants = makeUnmodifiable(builder.getConstants());
  53         this.enumerations = toUnmodifiableEnumerations(builder.getEnumerations());
  54         this.methodSignatures = toUnmodifiableMethods(builder.getMethodDefinitions());
  55         this.enclosedTypes = toUnmodifiableEnclosedTypes(builder.getEnclosedTypes(),
  56                 builder.getEnclosedTransferObjects());
  57         this.properties = toUnmodifiableProperties(builder.getProperties());
  58         this.isAbstract = builder.isAbstract();
  59         this.definition = builder.getYangSourceDefinition().orElse(null);
  60     }
  61
  62     AbstractGeneratedType(final Type parent, final JavaTypeName identifier, final TypeComment comment,
  63             final List<AnnotationTypeBuilder> annotationBuilders, final boolean isAbstract,
  64             final List<Type> implementsTypes, final List<GeneratedTypeBuilder> enclosedGenTypeBuilders,
  65             final List<GeneratedTOBuilder> enclosedGenTOBuilders, final List<EnumBuilder> enumBuilders,
  66             final List<Constant> constants, final List<MethodSignatureBuilder> methodBuilders,
  67             final List<GeneratedPropertyBuilder> propertyBuilders) {
  68         super(identifier);
  69         this.parent = parent;
  70         this.comment = comment;
  71         this.annotations = toUnmodifiableAnnotations(annotationBuilders);
  72         this.implementsTypes = makeUnmodifiable(implementsTypes);
  73         this.constants = makeUnmodifiable(constants);
  74         this.enumerations = toUnmodifiableEnumerations(enumBuilders);
  75         this.methodSignatures = toUnmodifiableMethods(methodBuilders);
  76         this.enclosedTypes = toUnmodifiableEnclosedTypes(enclosedGenTypeBuilders, enclosedGenTOBuilders);
  77         this.properties = toUnmodifiableProperties(propertyBuilders);
  78         this.isAbstract = isAbstract;
  79         this.definition = null;
  80     }
  81
  82     protected static final <T> List<T> makeUnmodifiable(final List<T> list) {
  83         switch (list.size()) {
  84             case 0:
  85                 return Collections.emptyList();
  86             case 1:
  87                 return Collections.singletonList(list.get(0));
  88             default:
  89                 return Collections.unmodifiableList(list);
  90         }
  91     }
  92
  93     private static List<GeneratedType> toUnmodifiableEnclosedTypes(
  94             final List<GeneratedTypeBuilder> enclosedGenTypeBuilders,
  95             final List<GeneratedTOBuilder> enclosedGenTOBuilders) {
  96         final ArrayList<GeneratedType> enclosedTypesList = new ArrayList<>(enclosedGenTypeBuilders.size()
  97                 + enclosedGenTOBuilders.size());
  98         for (final GeneratedTypeBuilder builder : enclosedGenTypeBuilders) {
  99             if (builder != null) {
 100                 enclosedTypesList.add(builder.build());
 101             }
 102         }
 103
 104         for (final GeneratedTOBuilder builder : enclosedGenTOBuilders) {
 105             if (builder != null) {
 106                 enclosedTypesList.add(builder.build());
 107             }
 108         }
 109
 110         return makeUnmodifiable(enclosedTypesList);
 111     }
 112
 113     protected static final List<AnnotationType> toUnmodifiableAnnotations(
 114             final List<AnnotationTypeBuilder> annotationBuilders) {
 115         final List<AnnotationType> annotationList = new ArrayList<>(annotationBuilders.size());
 116         for (final AnnotationTypeBuilder builder : annotationBuilders) {
 117             annotationList.add(builder.build());
 118         }
 119         return makeUnmodifiable(annotationList);
 120     }
 121
 122     protected final List<MethodSignature> toUnmodifiableMethods(final List<MethodSignatureBuilder> methodBuilders) {
 123         final List<MethodSignature> methods = new ArrayList<>(methodBuilders.size());
 124         for (final MethodSignatureBuilder methodBuilder : methodBuilders) {
 125             methods.add(methodBuilder.toInstance(this));
 126         }
 127         return makeUnmodifiable(methods);
 128     }
 129
 130     protected final List<Enumeration> toUnmodifiableEnumerations(final List<EnumBuilder> enumBuilders) {
 131         final List<Enumeration> enums = new ArrayList<>(enumBuilders.size());
 132         for (final EnumBuilder enumBuilder : enumBuilders) {
 133             enums.add(enumBuilder.toInstance(this));
 134         }
 135         return makeUnmodifiable(enums);
 136     }
 137
 138     protected final List<GeneratedProperty> toUnmodifiableProperties(
 139             final List<GeneratedPropertyBuilder> methodBuilders) {
 140         final List<GeneratedProperty> methods = new ArrayList<>(methodBuilders.size());
 141         for (final GeneratedPropertyBuilder methodBuilder : methodBuilders) {
 142             methods.add(methodBuilder.toInstance(this));
 143         }
 144         return makeUnmodifiable(methods);
 145     }
 146
 147     @Override
 148     public final Type getParentType() {
 149         return this.parent;
 150     }
 151
 152     @Override
 153     public final TypeComment getComment() {
 154         return this.comment;
 155     }
 156
 157     @Override
 158     public final List<AnnotationType> getAnnotations() {
 159         return this.annotations;
 160     }
 161
 162     @Override
 163     public final boolean isAbstract() {
 164         return this.isAbstract;
 165     }
 166
 167     @Override
 168     public final List<Type> getImplements() {
 169         return this.implementsTypes;
 170     }
 171
 172     @Override
 173     public final List<GeneratedType> getEnclosedTypes() {
 174         return this.enclosedTypes;
 175     }
 176
 177     @Override
 178     public final List<Enumeration> getEnumerations() {
 179         return this.enumerations;
 180     }
 181
 182     @Override
 183     public final List<Constant> getConstantDefinitions() {
 184         return this.constants;
 185     }
 186
 187     @Override
 188     public final List<MethodSignature> getMethodDefinitions() {
 189         return this.methodSignatures;
 190     }
 191
 192     @Override
 193     public final List<GeneratedProperty> getProperties() {
 194         return this.properties;
 195     }
 196
 197     @Override
 198     public final Optional<YangSourceDefinition> getYangSourceDefinition() {
 199         return Optional.ofNullable(definition);
 200     }
 201
 202     @Override
 203     public String toString() {
 204         final StringBuilder builder = new StringBuilder();
 205         builder.append("GeneratedType [packageName=");
 206         builder.append(getPackageName());
 207         builder.append(", name=");
 208         builder.append(getName());
 209         if (this.parent != null) {
 210             builder.append(", parent=");
 211             builder.append(this.parent.getFullyQualifiedName());
 212         } else {
 213             builder.append(", parent=null");
 214         }
 215         builder.append(", comment=");
 216         builder.append(this.comment);
 217         builder.append(", annotations=");
 218         builder.append(this.annotations);
 219         builder.append(", enclosedTypes=");
 220         builder.append(this.enclosedTypes);
 221         builder.append(", enumerations=");
 222         builder.append(this.enumerations);
 223         builder.append(", constants=");
 224         builder.append(this.constants);
 225         builder.append(", methodSignatures=");
 226         builder.append(this.methodSignatures);
 227         builder.append("]");
 228         return builder.toString();
 229     }
 230 }