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.yangtools.binding.generator.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.yangtools.sal.binding.model.api.GeneratedProperty;
14 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
15 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
16 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
17 import org.opendaylight.yangtools.sal.binding.model.api.Type;
18 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
19 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
20 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
21 import org.opendaylight.yangtools.util.LazyCollections;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
25 public final class GeneratedTOBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTOBuilder> implements GeneratedTOBuilder {
27 private GeneratedTransferObject extendsType;
28 private List<GeneratedPropertyBuilder> equalsProperties = Collections.emptyList();
29 private List<GeneratedPropertyBuilder> hashProperties = Collections.emptyList();
30 private List<GeneratedPropertyBuilder> toStringProperties = Collections.emptyList();
31 private boolean isTypedef = false;
32 private boolean isUnionType = false;
33 private boolean isUnionTypeBuilder = false;
34 private TypeDefinition<?> baseType = null;
35 private Restrictions restrictions;
36 private GeneratedPropertyBuilder SUID;
37 private String reference;
38 private String description;
39 private String moduleName;
40 private Iterable<QName> schemaPath;
42 public GeneratedTOBuilderImpl(final String packageName, final String name) {
43 super(packageName, name);
48 public GeneratedTOBuilder setExtendsType(final GeneratedTransferObject genTransObj) {
49 Preconditions.checkArgument(genTransObj != null, "Generated Transfer Object cannot be null!");
50 extendsType = genTransObj;
55 * Add new Method Signature definition for Generated Type Builder and
56 * returns Method Signature Builder for specifying all Method parameters. <br>
57 * Name of Method cannot be <code>null</code>, if it is <code>null</code>
58 * the method SHOULD throw {@link IllegalArgumentException} <br>
59 * By <i>Default</i> the MethodSignatureBuilder SHOULD be pre-set as
60 * {@link MethodSignatureBuilder#setAbstract(boolean)},
61 * {TypeMemberBuilder#setFinal(boolean)} and
62 * {TypeMemberBuilder#setAccessModifier(boolean)}
66 * @return <code>new</code> instance of Method Signature Builder.
69 public MethodSignatureBuilder addMethod(final String name) {
70 final MethodSignatureBuilder builder = super.addMethod(name);
71 builder.setAbstract(false);
76 public GeneratedTOBuilder addEqualsIdentity(final GeneratedPropertyBuilder property) {
77 equalsProperties = LazyCollections.lazyAdd(equalsProperties, property);
82 public GeneratedTOBuilder addHashIdentity(final GeneratedPropertyBuilder property) {
83 hashProperties = LazyCollections.lazyAdd(hashProperties, property);
88 public GeneratedTOBuilder addToStringProperty(final GeneratedPropertyBuilder property) {
89 toStringProperties = LazyCollections.lazyAdd(toStringProperties, property);
94 protected GeneratedTOBuilder thisInstance() {
99 public void setRestrictions(final Restrictions restrictions) {
100 this.restrictions = restrictions;
104 public void setSUID(final GeneratedPropertyBuilder suid) {
109 public GeneratedTransferObject toInstance() {
110 return new GeneratedTransferObjectImpl(this);
114 public String toString() {
115 StringBuilder builder = new StringBuilder();
116 builder.append("GeneratedTransferObject [packageName=");
117 builder.append(getPackageName());
118 builder.append(", name=");
119 builder.append(getName());
120 builder.append(", comment=");
121 builder.append(getComment());
122 builder.append(", constants=");
123 builder.append(getConstants());
124 builder.append(", enumerations=");
125 builder.append(getEnumerations());
126 builder.append(", equalsProperties=");
127 builder.append(equalsProperties);
128 builder.append(", hashCodeProperties=");
129 builder.append(hashProperties);
130 builder.append(", stringProperties=");
131 builder.append(toStringProperties);
132 builder.append(", annotations=");
133 builder.append(getAnnotations());
134 builder.append(", methods=");
135 builder.append(getMethodDefinitions());
137 return builder.toString();
141 public void setTypedef(final boolean isTypedef) {
142 this.isTypedef = isTypedef;
146 public void setBaseType(final TypeDefinition<?> typeDef) {
147 this.baseType = typeDef;
151 public void setIsUnion(final boolean isUnion) {
152 this.isUnionType = isUnion;
156 public void setIsUnionBuilder(final boolean isUnionTypeBuilder) {
157 this.isUnionTypeBuilder = isUnionTypeBuilder;
161 public void setDescription(String description) {
162 this.description = description;
166 public void setModuleName(String moduleName) {
167 this.moduleName = moduleName;
171 public void setSchemaPath(Iterable<QName> schemaPath) {
172 this.schemaPath = schemaPath;
176 public void setReference(String reference) {
177 this.reference = reference;
180 private static final class GeneratedTransferObjectImpl extends AbstractGeneratedType implements
181 GeneratedTransferObject {
183 private final List<GeneratedProperty> equalsProperties;
184 private final List<GeneratedProperty> hashCodeProperties;
185 private final List<GeneratedProperty> stringProperties;
186 private final GeneratedTransferObject extendsType;
187 private final boolean isTypedef;
188 private final TypeDefinition<?> baseType;
189 private final boolean isUnionType;
190 private final boolean isUnionTypeBuilder;
191 private final Restrictions restrictions;
192 private final GeneratedProperty SUID;
193 private final String reference;
194 private final String description;
195 private final String moduleName;
196 private final Iterable<QName> schemaPath;
198 public GeneratedTransferObjectImpl(final GeneratedTOBuilderImpl builder) {
200 this.extendsType = builder.extendsType;
202 // FIXME: if these fields were guaranteed to be constant, we could perhaps
203 // cache and reuse them between instances...
204 this.equalsProperties = toUnmodifiableProperties(builder.equalsProperties);
205 this.hashCodeProperties = toUnmodifiableProperties(builder.hashProperties);
206 this.stringProperties = toUnmodifiableProperties(builder.toStringProperties);
208 this.isTypedef = builder.isTypedef;
209 this.baseType = builder.baseType;
210 this.isUnionType = builder.isUnionType;
211 this.isUnionTypeBuilder = builder.isUnionTypeBuilder;
212 this.restrictions = builder.restrictions;
213 this.reference = builder.reference;
214 this.description = builder.description;
215 this.moduleName = builder.moduleName;
216 this.schemaPath = builder.schemaPath;
218 if (builder.SUID == null) {
221 this.SUID = builder.SUID.toInstance(GeneratedTransferObjectImpl.this);
226 public boolean isTypedef() {
231 public TypeDefinition<?> getBaseType() {
236 public boolean isUnionType() {
241 public boolean isUnionTypeBuilder() {
242 return isUnionTypeBuilder;
246 public GeneratedTransferObject getSuperType() {
251 public List<GeneratedProperty> getEqualsIdentifiers() {
252 return equalsProperties;
256 public List<GeneratedProperty> getHashCodeIdentifiers() {
257 return hashCodeProperties;
261 public List<GeneratedProperty> getToStringIdentifiers() {
262 return stringProperties;
266 public Restrictions getRestrictions() {
271 public GeneratedProperty getSUID() {
276 public String toString() {
278 return serializeTypedef(this);
280 StringBuilder builder = new StringBuilder();
281 builder.append("GeneratedTransferObject [packageName=");
282 builder.append(getPackageName());
283 builder.append(", name=");
284 builder.append(getName());
285 builder.append(", comment=");
286 builder.append(", annotations=");
287 builder.append(getAnnotations());
288 builder.append(getComment());
289 builder.append(", extends=");
290 builder.append(getSuperType());
291 builder.append(", implements=");
292 builder.append(getImplements());
293 builder.append(", enclosedTypes=");
294 builder.append(getEnclosedTypes());
295 builder.append(", constants=");
296 builder.append(getConstantDefinitions());
297 builder.append(", enumerations=");
298 builder.append(getEnumerations());
299 builder.append(", properties=");
300 builder.append(getProperties());
301 builder.append(", equalsProperties=");
302 builder.append(equalsProperties);
303 builder.append(", hashCodeProperties=");
304 builder.append(hashCodeProperties);
305 builder.append(", stringProperties=");
306 builder.append(stringProperties);
307 builder.append(", methods=");
308 builder.append(getMethodDefinitions());
310 return builder.toString();
313 public String serializeTypedef(final Type type) {
314 if (type instanceof ParameterizedType) {
315 ParameterizedType parameterizedType = (ParameterizedType) type;
316 StringBuilder sb = new StringBuilder();
317 sb.append(parameterizedType.getRawType().getFullyQualifiedName());
319 boolean first = true;
320 for (Type parameter : parameterizedType.getActualTypeArguments()) {
326 sb.append(serializeTypedef(parameter));
329 return sb.toString();
331 return type.getFullyQualifiedName();
336 public String getDescription() {
341 public String getReference() {
346 public Iterable<QName> getSchemaPath() {
351 public String getModuleName() {