MDSAL-301: Binding v2 - Rework javadoc generation
[mdsal.git] / binding2 / mdsal-binding2-generator-util / src / main / java / org / opendaylight / mdsal / binding / javav2 / generator / util / generated / type / builder / GeneratedTypeBuilderImpl.java
1 /*
2  * Copyright (c) 2017 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
9 package org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder;
10
11 import com.google.common.annotations.Beta;
12 import com.google.common.base.Preconditions;
13 import java.util.List;
14 import java.util.Optional;
15 import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
16 import org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil;
17 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
18 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTypeForBuilder;
19 import org.opendaylight.mdsal.binding.javav2.model.api.TypeComment;
20 import org.opendaylight.mdsal.binding.javav2.model.api.type.builder.GeneratedTypeBuilder;
21 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingNamespaceType;
22 import org.opendaylight.yangtools.yang.common.QName;
23
24 @Beta
25 public final class GeneratedTypeBuilderImpl extends AbstractGeneratedTypeBuilder<GeneratedTypeBuilder> implements
26         GeneratedTypeBuilder {
27
28     private String description;
29     private String reference;
30     private String moduleName;
31     private List<QName> schemaPath;
32     private boolean isWithBuilder = false;
33     private String basePackageName = null;
34
35     public GeneratedTypeBuilderImpl(final String packageName, final String name, ModuleContext context) {
36         super(packageName, name, context);
37         setAbstract(true);
38     }
39
40     public GeneratedTypeBuilderImpl(final String packageName, final String name, final boolean isPkNameNormalized,
41             final boolean isTypeNormalized, ModuleContext context) {
42         super(packageName, name, isPkNameNormalized, isTypeNormalized, context);
43         setAbstract(true);
44     }
45
46     @Override
47     public GeneratedType toInstance() {
48         if (this.isWithBuilder()) {
49             return new GeneratedTypeWithBuilderImpl(this);
50         } else {
51             return new GeneratedTypeImpl(this);
52         }
53     }
54
55     @Override
56     public void setDescription(String description) {
57         this.description = description;
58     }
59
60     @Override
61     public void setModuleName(String moduleName) {
62         this.moduleName = moduleName;
63     }
64
65     @Override
66     public void setSchemaPath(List<QName> schemaPath) {
67         this.schemaPath = schemaPath;
68     }
69
70     @Override
71     public void setReference(String reference) {
72         this.reference = reference;
73     }
74
75     @Override
76     public String toString() {
77         StringBuilder builder = new StringBuilder();
78         builder.append("GeneratedTransferObject [packageName=");
79         builder.append(getPackageName());
80         builder.append(", name=");
81         builder.append(getName());
82         final TypeComment comment = getComment();
83         if (comment != null) {
84             builder.append(", comment=");
85             builder.append(comment.getJavadoc());
86         }
87         builder.append(", annotations=");
88         builder.append(getAnnotations());
89         builder.append(", implements=");
90         builder.append(getImplementsTypes());
91         builder.append(", enclosedTypes=");
92         builder.append(getEnclosedTypes());
93         builder.append(", constants=");
94         builder.append(getConstants());
95         builder.append(", enumerations=");
96         builder.append(getEnumerations());
97         builder.append(", properties=");
98         builder.append(", methods=");
99         builder.append(getMethodDefinitions());
100         builder.append("]");
101         return builder.toString();
102     }
103
104     @Override
105     protected GeneratedTypeBuilderImpl thisInstance() {
106         return this;
107     }
108
109     public boolean isWithBuilder() {
110         return isWithBuilder;
111     }
112
113     public void setWithBuilder(boolean withBuilder) {
114         isWithBuilder = withBuilder;
115     }
116
117     public String getBasePackageName() {
118         return basePackageName;
119     }
120
121     public void setBasePackageName(String basePackageName) {
122         this.basePackageName = basePackageName;
123     }
124
125     private static class GeneratedTypeImpl extends AbstractGeneratedType {
126
127         private final String description;
128         private final String reference;
129         private final String moduleName;
130         private final List<QName> schemaPath;
131
132         public GeneratedTypeImpl(final GeneratedTypeBuilderImpl builder) {
133             super(builder);
134
135             this.description = builder.description;
136             this.reference = builder.reference;
137             this.moduleName = builder.moduleName;
138             this.schemaPath = builder.schemaPath;
139         }
140
141         @Override
142         public Optional<String> getDescription() {
143             return Optional.ofNullable(this.description);
144         }
145
146         @Override
147         public Optional<String> getReference() {
148             return Optional.ofNullable(this.reference);
149         }
150
151         @Override
152         public List<QName> getSchemaPath() {
153             return schemaPath;
154         }
155
156         @Override
157         public String getModuleName() {
158             return moduleName;
159         }
160     }
161
162     private static final class GeneratedTypeWithBuilderImpl extends GeneratedTypeImpl
163             implements GeneratedTypeForBuilder {
164
165         private final String basePackageName;
166         private final String builderPackageName;
167
168         public GeneratedTypeWithBuilderImpl(GeneratedTypeBuilderImpl builder) {
169             super(builder);
170             Preconditions.checkState(builder.getBasePackageName() != null,
171                     "Base package name can not be null for type with builder!");
172             this.basePackageName = builder.getBasePackageName();
173             this.builderPackageName = generatePackageNameForBuilder();
174         }
175
176         private String generatePackageNameForBuilder() {
177             return BindingGeneratorUtil.replacePackageTopNamespace(this.basePackageName, this.getPackageName(),
178                     BindingNamespaceType.Data, BindingNamespaceType.Builder);
179         }
180
181         @Override
182         public String getPackageNameForBuilder() {
183             return this.builderPackageName;
184         }
185
186         @Override
187         public String getBasePackageName() {
188             return this.basePackageName;
189         }
190     }
191 }