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.generator.util.generated.type.builder;
10 import com.google.common.base.Preconditions;
11 import java.util.Collections;
12 import java.util.List;
13 import java.util.Objects;
14 import org.opendaylight.mdsal.binding.generator.util.AbstractBaseType;
15 import org.opendaylight.mdsal.binding.model.api.AccessModifier;
16 import org.opendaylight.mdsal.binding.model.api.Constant;
17 import org.opendaylight.mdsal.binding.model.api.Type;
18 import org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder;
19 import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder;
20 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
21 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
22 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
23 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
24 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
25 import org.opendaylight.yangtools.util.LazyCollections;
27 abstract class AbstractGeneratedTypeBuilder<T extends GeneratedTypeBuilderBase<T>> extends AbstractBaseType implements GeneratedTypeBuilderBase<T> {
29 private List<AnnotationTypeBuilder> annotationBuilders = Collections.emptyList();
30 private List<Type> implementsTypes = Collections.emptyList();
31 private List<EnumBuilder> enumDefinitions = Collections.emptyList();
32 private List<Constant> constants = Collections.emptyList();
33 private List<MethodSignatureBuilder> methodDefinitions = Collections.emptyList();
34 private final List<GeneratedTypeBuilder> enclosedTypes = Collections.emptyList();
35 private List<GeneratedTOBuilder> enclosedTransferObjects = Collections.emptyList();
36 private List<GeneratedPropertyBuilder> properties = Collections.emptyList();
37 private String comment = "";
38 private boolean isAbstract;
40 protected AbstractGeneratedTypeBuilder(final String packageName, final String name) {
41 super(packageName, name);
44 protected String getComment() {
48 protected List<AnnotationTypeBuilder> getAnnotations() {
49 return annotationBuilders;
53 public boolean isAbstract() {
58 public List<Type> getImplementsTypes() {
59 return implementsTypes;
62 protected List<EnumBuilder> getEnumerations() {
63 return enumDefinitions;
66 protected List<Constant> getConstants() {
71 public List<MethodSignatureBuilder> getMethodDefinitions() {
72 return methodDefinitions;
75 protected List<GeneratedTypeBuilder> getEnclosedTypes() {
79 protected List<GeneratedTOBuilder> getEnclosedTransferObjects() {
80 return enclosedTransferObjects;
83 protected abstract T thisInstance();
86 public GeneratedTOBuilder addEnclosingTransferObject(final String name) {
87 Preconditions.checkArgument(name != null, "Name for Enclosing Generated Transfer Object cannot be null!");
88 GeneratedTOBuilder builder = new GeneratedTOBuilderImpl(getFullyQualifiedName(), name);
90 Preconditions.checkArgument(!enclosedTransferObjects.contains(builder), "This generated type already contains equal enclosing transfer object.");
91 enclosedTransferObjects = LazyCollections.lazyAdd(enclosedTransferObjects, builder);
96 public T addEnclosingTransferObject(final GeneratedTOBuilder genTOBuilder) {
97 Preconditions.checkArgument(genTOBuilder != null, "Parameter genTOBuilder cannot be null!");
98 Preconditions.checkArgument(!enclosedTransferObjects.contains(genTOBuilder), "This generated type already contains equal enclosing transfer object.");
99 enclosedTransferObjects = LazyCollections.lazyAdd(enclosedTransferObjects, genTOBuilder);
100 return thisInstance();
104 public T addComment(final String comment) {
105 this.comment = comment;
106 return thisInstance();
110 public AnnotationTypeBuilder addAnnotation(final String packageName, final String name) {
111 Preconditions.checkArgument(packageName != null, "Package Name for Annotation Type cannot be null!");
112 Preconditions.checkArgument(name != null, "Name of Annotation Type cannot be null!");
114 final AnnotationTypeBuilder builder = new AnnotationTypeBuilderImpl(packageName, name);
116 Preconditions.checkArgument(!annotationBuilders.contains(builder), "This generated type already contains equal annotation.");
117 annotationBuilders = LazyCollections.lazyAdd(annotationBuilders, builder);
122 public T setAbstract(final boolean isAbstract) {
123 this.isAbstract = isAbstract;
124 return thisInstance();
128 public T addImplementsType(final Type genType) {
129 Preconditions.checkArgument(genType != null, "Type cannot be null");
130 Preconditions.checkArgument(!implementsTypes.contains(genType), "This generated type already contains equal implements type.");
131 implementsTypes = LazyCollections.lazyAdd(implementsTypes, genType);
132 return thisInstance();
136 public Constant addConstant(final Type type, final String name, final Object value) {
137 Preconditions.checkArgument(type != null, "Returning Type for Constant cannot be null!");
138 Preconditions.checkArgument(name != null, "Name of constant cannot be null!");
139 Preconditions.checkArgument(!containsConstant(name), "This generated type already contains constant with the same name.");
141 final Constant constant = new ConstantImpl(this, type, name, value);
142 constants = LazyCollections.lazyAdd(constants, constant);
146 public boolean containsConstant(final String name) {
147 Preconditions.checkArgument(name != null, "Parameter name can't be null");
148 for (Constant constant : constants) {
149 if (name.equals(constant.getName())) {
157 public EnumBuilder addEnumeration(final String name) {
158 Preconditions.checkArgument(name != null, "Name of enumeration cannot be null!");
159 final EnumBuilder builder = new EnumerationBuilderImpl(getFullyQualifiedName(), name);
161 Preconditions.checkArgument(!enumDefinitions.contains(builder), "This generated type already contains equal enumeration.");
162 enumDefinitions = LazyCollections.lazyAdd(enumDefinitions, builder);
167 public MethodSignatureBuilder addMethod(final String name) {
168 Preconditions.checkArgument(name != null, "Name of method cannot be null!");
169 final MethodSignatureBuilder builder = new MethodSignatureBuilderImpl(name);
170 builder.setAccessModifier(AccessModifier.PUBLIC);
171 builder.setAbstract(true);
172 methodDefinitions = LazyCollections.lazyAdd(methodDefinitions, builder);
177 public boolean containsMethod(final String name) {
178 Preconditions.checkArgument(name != null, "Parameter name can't be null");
179 for (MethodSignatureBuilder methodDefinition : methodDefinitions) {
180 if (name.equals(methodDefinition.getName())) {
188 public GeneratedPropertyBuilder addProperty(final String name) {
189 Preconditions.checkArgument(name != null, "Parameter name can't be null");
190 Preconditions.checkArgument(!containsProperty(name), "This generated type already contains property with the same name.");
192 final GeneratedPropertyBuilder builder = new GeneratedPropertyBuilderImpl(name);
193 builder.setAccessModifier(AccessModifier.PUBLIC);
194 properties = LazyCollections.lazyAdd(properties, builder);
199 public boolean containsProperty(final String name) {
200 Preconditions.checkArgument(name != null, "Parameter name can't be null");
201 for (GeneratedPropertyBuilder property : properties) {
202 if (name.equals(property.getName())) {
210 public int hashCode() {
211 final int prime = 31;
213 result = prime * result + Objects.hashCode(getName());
214 result = prime * result + Objects.hashCode(getPackageName());
219 public boolean equals(final Object obj) {
226 if (getClass() != obj.getClass()) {
229 AbstractGeneratedTypeBuilder<?> other = (AbstractGeneratedTypeBuilder<?>) obj;
230 return Objects.equals(getName(), other.getName()) && Objects.equals(getPackageName(), other.getPackageName());
233 public Type getParent() {
238 public List<GeneratedPropertyBuilder> getProperties() {