2 * Copyright (c) 2013 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
8 package org.opendaylight.mdsal.binding.model.util.generated.type.builder;
10 import com.google.common.base.Preconditions;
11 import java.util.Collections;
12 import java.util.List;
13 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
14 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
15 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
16 import org.opendaylight.mdsal.binding.model.api.Type;
17 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
18 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
19 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
20 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
21 import org.opendaylight.yangtools.util.LazyCollections;
22 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
24 abstract class AbstractGeneratedTOBuilder extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder>
25 implements GeneratedTOBuilder {
27 // FIXME are these three referenced anywhere at runtime?
28 private List<GeneratedPropertyBuilder> equalsProperties = Collections.emptyList();
29 private List<GeneratedPropertyBuilder> hashProperties = Collections.emptyList();
30 private List<GeneratedPropertyBuilder> toStringProperties = Collections.emptyList();
31 private GeneratedTransferObject extendsType;
32 private boolean isTypedef = false;
33 private boolean isUnionType = false;
34 private boolean isUnionTypeBuilder = false;
35 private TypeDefinition<?> baseType = null;
37 AbstractGeneratedTOBuilder(final JavaTypeName identifier) {
43 public final GeneratedTOBuilder setExtendsType(final GeneratedTransferObject genTransObj) {
44 Preconditions.checkArgument(genTransObj != null, "Generated Transfer Object cannot be null!");
45 this.extendsType = genTransObj;
50 * Add new Method Signature definition for Generated Type Builder and
51 * returns Method Signature Builder for specifying all Method parameters. <br>
52 * Name of Method cannot be <code>null</code>, if it is <code>null</code>
53 * the method SHOULD throw {@link IllegalArgumentException} <br>
54 * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as
55 * {@link MethodSignatureBuilder#setAbstract(boolean)},
56 * {TypeMemberBuilder#setFinal(boolean)} and
57 * {TypeMemberBuilder#setAccessModifier(boolean)}
61 * @return <code>new</code> instance of Method Signature Builder.
64 public final MethodSignatureBuilder addMethod(final String name) {
65 final MethodSignatureBuilder builder = super.addMethod(name);
66 builder.setAbstract(false);
71 public final GeneratedTOBuilder addEqualsIdentity(final GeneratedPropertyBuilder property) {
72 this.equalsProperties = LazyCollections.lazyAdd(this.equalsProperties, property);
77 public final GeneratedTOBuilder addHashIdentity(final GeneratedPropertyBuilder property) {
78 this.hashProperties = LazyCollections.lazyAdd(this.hashProperties, property);
83 public final GeneratedTOBuilder addToStringProperty(final GeneratedPropertyBuilder property) {
84 this.toStringProperties = LazyCollections.lazyAdd(this.toStringProperties, property);
89 protected final GeneratedTOBuilder thisInstance() {
94 public final String toString() {
95 final StringBuilder builder = new StringBuilder();
96 builder.append("GeneratedTransferObject [packageName=");
97 builder.append(getPackageName());
98 builder.append(", name=");
99 builder.append(getName());
100 builder.append(", comment=");
101 builder.append(getComment());
102 builder.append(", constants=");
103 builder.append(getConstants());
104 builder.append(", enumerations=");
105 builder.append(getEnumerations());
106 builder.append(", equalsProperties=");
107 builder.append(this.equalsProperties);
108 builder.append(", hashCodeProperties=");
109 builder.append(this.hashProperties);
110 builder.append(", stringProperties=");
111 builder.append(this.toStringProperties);
112 builder.append(", annotations=");
113 builder.append(getAnnotations());
114 builder.append(", methods=");
115 builder.append(getMethodDefinitions());
117 return builder.toString();
121 public final void setTypedef(final boolean isTypedef) {
122 this.isTypedef = isTypedef;
126 public final void setBaseType(final TypeDefinition<?> typeDef) {
127 this.baseType = typeDef;
131 public final void setIsUnion(final boolean isUnion) {
132 this.isUnionType = isUnion;
136 public final void setIsUnionBuilder(final boolean isUnionTypeBuilder) {
137 this.isUnionTypeBuilder = isUnionTypeBuilder;
140 static abstract class AbstractGeneratedTransferObject extends AbstractGeneratedType implements
141 GeneratedTransferObject {
143 private final List<GeneratedProperty> equalsProperties;
144 private final List<GeneratedProperty> hashCodeProperties;
145 private final List<GeneratedProperty> stringProperties;
146 private final GeneratedTransferObject extendsType;
147 private final boolean isTypedef;
148 private final TypeDefinition<?> baseType;
149 private final boolean isUnionType;
150 private final boolean isUnionTypeBuilder;
152 AbstractGeneratedTransferObject(final AbstractGeneratedTOBuilder builder) {
154 this.extendsType = builder.extendsType;
156 // FIXME: if these fields were guaranteed to be constant, we could perhaps
157 // cache and reuse them between instances...
158 this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);
159 this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);
160 this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);
162 this.isTypedef = builder.isTypedef;
163 this.baseType = builder.baseType;
164 this.isUnionType = builder.isUnionType;
165 this.isUnionTypeBuilder = builder.isUnionTypeBuilder;
169 public final boolean isTypedef() {
170 return this.isTypedef;
174 public final TypeDefinition<?> getBaseType() {
175 return this.baseType;
179 public final boolean isUnionType() {
180 return this.isUnionType;
184 public final boolean isUnionTypeBuilder() {
185 return this.isUnionTypeBuilder;
189 public final GeneratedTransferObject getSuperType() {
190 return this.extendsType;
194 public final List<GeneratedProperty> getEqualsIdentifiers() {
195 return this.equalsProperties;
199 public final List<GeneratedProperty> getHashCodeIdentifiers() {
200 return this.hashCodeProperties;
204 public final List<GeneratedProperty> getToStringIdentifiers() {
205 return this.stringProperties;
209 public final String toString() {
210 if (this.isTypedef) {
211 return serializeTypedef(this);
213 final StringBuilder builder = new StringBuilder();
214 builder.append("GeneratedTransferObject [packageName=");
215 builder.append(getPackageName());
216 builder.append(", name=");
217 builder.append(getName());
218 builder.append(", comment=");
219 builder.append(", annotations=");
220 builder.append(getAnnotations());
221 builder.append(getComment());
222 builder.append(", extends=");
223 builder.append(getSuperType());
224 builder.append(", implements=");
225 builder.append(getImplements());
226 builder.append(", enclosedTypes=");
227 builder.append(getEnclosedTypes());
228 builder.append(", constants=");
229 builder.append(getConstantDefinitions());
230 builder.append(", enumerations=");
231 builder.append(getEnumerations());
232 builder.append(", properties=");
233 builder.append(getProperties());
234 builder.append(", equalsProperties=");
235 builder.append(this.equalsProperties);
236 builder.append(", hashCodeProperties=");
237 builder.append(this.hashCodeProperties);
238 builder.append(", stringProperties=");
239 builder.append(this.stringProperties);
240 builder.append(", methods=");
241 builder.append(getMethodDefinitions());
243 return builder.toString();
246 public final String serializeTypedef(final Type type) {
247 if (!(type instanceof ParameterizedType)) {
248 return type.getFullyQualifiedName();
251 final ParameterizedType parameterizedType = (ParameterizedType) type;
252 final StringBuilder sb = new StringBuilder();
253 sb.append(parameterizedType.getRawType().getFullyQualifiedName()).append('<');
254 boolean first = true;
255 for (final Type parameter : parameterizedType.getActualTypeArguments()) {
261 sb.append(serializeTypedef(parameter));
263 return sb.append('>').toString();