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