/
ClassOrInterfaceView.java
163 lines (143 loc) · 5.01 KB
/
ClassOrInterfaceView.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/**
*
* Copyright (c) 2006-2017, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.common.codegen.internal.java.view;
import com.speedment.common.codegen.Generator;
import com.speedment.common.codegen.Transform;
import com.speedment.common.codegen.internal.java.view.trait.*;
import com.speedment.common.codegen.model.ClassOrInterface;
import java.util.Optional;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import static com.speedment.common.codegen.internal.util.NullUtil.requireNonNullElements;
import static com.speedment.common.codegen.internal.util.NullUtil.requireNonNulls;
import static com.speedment.common.codegen.util.Formatting.*;
import static java.util.stream.Collectors.joining;
/**
* An abstract base class used to share functionality between different view
* components such as {@link ClassView}, {@link EnumView} and
* {@link InterfaceView}.
*
* @param <M> the extending model type
* @author Emil Forslund
*/
abstract class ClassOrInterfaceView<M extends ClassOrInterface<M>> implements Transform<M, String>,
HasNameView<M>,
HasModifiersView<M>,
HasJavadocView<M>,
HasGenericsView<M>,
HasImplementsView<M>,
HasInitializersView<M>,
HasMethodsView<M>,
HasClassesView<M>,
HasAnnotationUsageView<M>,
HasFieldsView<M> {
private static final Pattern EMPTY_BLOCK =
Pattern.compile("^\\s*\\{\\s*}\\s*$");
protected static final String
CLASS_STRING = "class ",
INTERFACE_STRING = "interface ",
ENUM_STRING = "enum ",
IMPLEMENTS_STRING = "implements ",
EXTENDS_STRING = "extends ";
/**
* A hook that is executed just before the 'fields' part of the class code.
*
* @param gen the generator being used
* @param model the model that is generated
* @return code to be inserted before the fields
*/
protected String onBeforeFields(Generator gen, M model) {
return "";
}
@Override
public String fieldSeparator(M model) {
return nl();
}
@Override
public String fieldSuffix() {
return ";";
}
/**
* Returns the declaration type of this model. This can be either 'class',
* 'interface' or 'enum'.
*
* @return the declaration type
*/
protected abstract String renderDeclarationType();
/**
* Returns the supertype of this model. The supertype should include any
* declaration like 'implements' or 'extends'.
* <p>
* Example: <pre>"implements List"</pre>
*
* @param gen the generator to use
* @param model the model of the component
* @return the supertype part
*/
protected abstract String renderSupertype(Generator gen, M model);
/**
* Should render the constructors part of the code and return it.
*
* @param gen the generator to use
* @param model the model of the component
* @return generated constructors or an empty string if there shouldn't
* be any
*/
protected abstract String renderConstructors(Generator gen, M model);
@Override
public Optional<String> transform(Generator gen, M model) {
requireNonNulls(gen, model);
String code = block(nl() + separate(
onBeforeFields(gen, model), // Enums have constants here.´
renderFields(gen, model),
renderConstructors(gen, model),
renderInitalizers(gen, model),
renderMethods(gen, model),
renderClasses(gen, model)
));
if (EMPTY_BLOCK.matcher(code).find()) {
code = "{}";
}
return Optional.of(renderJavadoc(gen, model) +
renderAnnotations(gen, model) +
renderModifiers(gen, model) +
renderDeclarationType() +
renderName(gen, model) +
renderGenerics(gen, model) +
(model.getGenerics().isEmpty() ? " " : "") +
renderSupertype(gen, model) +
renderInterfaces(gen, model) +
// Code
code
);
}
/**
* Converts the specified elements into strings using their
* <code>toString</code>-method and combines them with two new-line-characters.
* Empty strings will be discarded.
*
* @param strings the strings to combine
* @return the combined string
*/
private String separate(Object... strings) {
requireNonNullElements(strings);
return Stream.of(strings)
.map(Object::toString)
.filter(s -> s.length() > 0)
.collect(joining(dnl()));
}
}