2 * Copyright (c) 2017 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder;
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.Optional;
16 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedProperty;
17 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
18 import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
19 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
20 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
21 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedPropertyBuilder;
22 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTOBuilder;
23 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.MethodSignatureBuilder;
24 import org.opendaylight.yangtools.util.LazyCollections;
25 import org.opendaylight.yangtools.yang.common.QName;
26 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
29 public final class GeneratedTOBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder> implements
32 private GeneratedTransferObject extendsType;
33 private List<GeneratedPropertyBuilder> equalsProperties = ImmutableList.of();
34 private List<GeneratedPropertyBuilder> hashProperties = ImmutableList.of();
35 private List<GeneratedPropertyBuilder> toStringProperties = ImmutableList.of();
36 private boolean isTypedef = false;
37 private boolean isUnionType = false;
38 private boolean isUnionTypeBuilder = false;
39 private TypeDefinition<?> baseType = null;
40 private Restrictions restrictions;
41 private GeneratedPropertyBuilder suid;
42 private String reference;
43 private String description;
44 private String moduleName;
45 private List<QName> schemaPath;
47 public GeneratedTOBuilderImpl(final String packageName, final String name) {
48 super(packageName, name);
52 public GeneratedTOBuilderImpl(final String packageName, final String name, final boolean isNormalized) {
53 super(packageName, name, true);
56 public GeneratedTOBuilderImpl(final String packageName, final String name,
57 final boolean isPkNameNormalized,
58 final boolean isTypeNormalized) {
59 super(packageName, name, isPkNameNormalized, isTypeNormalized);
64 public GeneratedTOBuilder setExtendsType(GeneratedTransferObject genTransObj) {
65 Preconditions.checkArgument(genTransObj != null, "Generated Transfer Object cannot be null!");
66 extendsType = genTransObj;
71 * Add new MethodSignature definition for GeneratedTypeBuilder and
72 * returns MethodSignatureBuilder for specifying all Method parameters. <br>
73 * Name of Method cannot be <code>null</code>, if it is <code>null</code>
74 * the method SHOULD throw {@link IllegalArgumentException} <br>
75 * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as
76 * {@link MethodSignatureBuilder#setAbstract(boolean)},
77 * {TypeMemberBuilder#setFinal(boolean)} and
78 * {TypeMemberBuilder#setAccessModifier(boolean)}
82 * @return <code>new</code> instance of Method Signature Builder.
85 public MethodSignatureBuilder addMethod(final String name) {
86 final MethodSignatureBuilder builder = super.addMethod(name);
87 builder.setAbstract(false);
92 public GeneratedTOBuilder addEqualsIdentity(GeneratedPropertyBuilder property) {
93 equalsProperties = LazyCollections.lazyAdd(equalsProperties, property);
98 public GeneratedTOBuilder addHashIdentity(GeneratedPropertyBuilder property) {
99 hashProperties = LazyCollections.lazyAdd(hashProperties, property);
104 public GeneratedTOBuilder addToStringProperty(GeneratedPropertyBuilder property) {
105 toStringProperties = LazyCollections.lazyAdd(toStringProperties, property);
110 public void setRestrictions(Restrictions restrictions) {
111 this.restrictions = restrictions;
115 public GeneratedTransferObject toInstance() {
116 return new GeneratedTransferObjectImpl(this);
120 public void setTypedef(boolean isTypedef) {
121 this.isTypedef = isTypedef;
125 public void setBaseType(TypeDefinition<?> typeDef) {
126 this.baseType = typeDef;
130 public void setIsUnion(boolean isUnion) {
131 this.isUnionType = isUnion;
135 public void setIsUnionBuilder(boolean isUnionTypeBuilder) {
136 this.isUnionTypeBuilder = isUnionTypeBuilder;
140 public void setSUID(GeneratedPropertyBuilder suid) {
145 public void setDescription(String description) {
146 this.description = description;
150 public void setModuleName(String moduleName) {
151 this.moduleName = moduleName;
155 public void setSchemaPath(List<QName> schemaPath) {
156 this.schemaPath = schemaPath;
160 public void setReference(String reference) {
161 this.reference = reference;
165 protected GeneratedTOBuilderImpl thisInstance() {
170 public String toString() {
171 StringBuilder builder = new StringBuilder();
172 builder.append("GeneratedTransferObject [packageName=");
173 builder.append(getPackageName());
174 builder.append(", name=");
175 builder.append(getName());
176 builder.append(", comment=");
177 builder.append(getComment());
178 builder.append(", constants=");
179 builder.append(getConstants());
180 builder.append(", enumerations=");
181 builder.append(getEnumerations());
182 builder.append(", equalsProperties=");
183 builder.append(equalsProperties);
184 builder.append(", hashCodeProperties=");
185 builder.append(hashProperties);
186 builder.append(", stringProperties=");
187 builder.append(toStringProperties);
188 builder.append(", annotations=");
189 builder.append(getAnnotations());
190 builder.append(", methods=");
191 builder.append(getMethodDefinitions());
193 return builder.toString();
196 private static final class GeneratedTransferObjectImpl extends AbstractGeneratedType implements GeneratedTransferObject {
198 private final List<GeneratedProperty> equalsProperties;
199 private final List<GeneratedProperty> hashCodeProperties;
200 private final List<GeneratedProperty> stringProperties;
201 private final GeneratedTransferObject extendsType;
202 private final boolean isTypedef;
203 private final TypeDefinition<?> baseType;
204 private final boolean isUnionType;
205 private final boolean isUnionTypeBuilder;
206 private final Restrictions restrictions;
207 private final GeneratedProperty innerSuid;
208 private final String reference;
209 private final String description;
210 private final String moduleName;
211 private final List<QName> schemaPath;
213 public GeneratedTransferObjectImpl(final GeneratedTOBuilderImpl builder) {
216 this.extendsType = builder.extendsType;
217 this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);
218 this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);
219 this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);
221 this.isTypedef = builder.isTypedef;
222 this.baseType = builder.baseType;
223 this.isUnionType = builder.isUnionType;
224 this.isUnionTypeBuilder = builder.isUnionTypeBuilder;
225 this.restrictions = builder.restrictions;
226 this.reference = builder.reference;
227 this.description = builder.description;
228 this.moduleName = builder.moduleName;
229 this.schemaPath = builder.schemaPath;
231 if (builder.suid == null) {
232 this.innerSuid = null;
234 this.innerSuid = builder.suid.toInstance(GeneratedTransferObjectImpl.this);
239 public GeneratedProperty getSUID() {
244 public GeneratedTransferObject getSuperType() {
249 public List<GeneratedProperty> getEqualsIdentifiers() {
250 return equalsProperties;
254 public List<GeneratedProperty> getHashCodeIdentifiers() {
255 return hashCodeProperties;
259 public List<GeneratedProperty> getToStringIdentifiers() {
260 return stringProperties;
264 public boolean isTypedef() {
269 public TypeDefinition<?> getBaseType() {
274 public boolean isUnionType() {
279 public boolean isUnionTypeBuilder() {
280 return isUnionTypeBuilder;
284 public Restrictions getRestrictions() {
289 public Optional<String> getDescription() {
290 return Optional.ofNullable(this.description);
294 public Optional<String> getReference() {
295 return Optional.ofNullable(this.reference);
299 public List<QName> getSchemaPath() {
304 public String getModuleName() {
309 public String toString() {
311 return serializeTypedef(this);
313 StringBuilder builder = new StringBuilder();
314 builder.append("GeneratedTransferObject [packageName=");
315 builder.append(getPackageName());
316 builder.append(", name=");
317 builder.append(getName());
318 builder.append(", comment=");
319 builder.append(", annotations=");
320 builder.append(getAnnotations());
321 builder.append(getComment());
322 builder.append(", extends=");
323 builder.append(getSuperType());
324 builder.append(", implements=");
325 builder.append(getImplements());
326 builder.append(", enclosedTypes=");
327 builder.append(getEnclosedTypes());
328 builder.append(", constants=");
329 builder.append(getConstantDefinitions());
330 builder.append(", enumerations=");
331 builder.append(getEnumerations());
332 builder.append(", properties=");
333 builder.append(getProperties());
334 builder.append(", equalsProperties=");
335 builder.append(equalsProperties);
336 builder.append(", hashCodeProperties=");
337 builder.append(hashCodeProperties);
338 builder.append(", stringProperties=");
339 builder.append(stringProperties);
340 builder.append(", methods=");
341 builder.append(getMethodDefinitions());
343 return builder.toString();
346 private String serializeTypedef(final Type type) {
347 if (type instanceof ParameterizedType) {
348 ParameterizedType parameterizedType = (ParameterizedType) type;
349 StringBuilder sb = new StringBuilder();
350 sb.append(parameterizedType.getRawType().getFullyQualifiedName());
352 boolean first = true;
353 for (Type parameter : parameterizedType.getActualTypeArguments()) {
359 sb.append(serializeTypedef(parameter));
362 return sb.toString();
364 return type.getFullyQualifiedName();