Skip to content

Commit fecb8f7

Browse files
maybeecmaybeec
committed
#52: small code cleanup
1 parent 25f79a2 commit fecb8f7

File tree

3 files changed

+46
-38
lines changed

3 files changed

+46
-38
lines changed

‎cobigen/cobigen-javaplugin/src/main/java/com/capgemini/cobigen/javaplugin/merger/JavaMerger.java

+40-37
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
/**
2626
* The {@link JavaMerger} merges a patch and the base file of the same class. This merge is a structural merge
2727
* considering code blocks of fields, methods and inner classes. There will be no merging on statement level
28-
*
28+
*
2929
* @author mbrunnli (19.03.2013)
3030
*/
3131
public class JavaMerger implements IMerger {
@@ -42,12 +42,12 @@ public class JavaMerger implements IMerger {
4242

4343
/**
4444
* Creates a new {@link JavaMerger}
45-
*
45+
*
4646
* @param type
47-
* merger type
47+
* merger type
4848
* @param patchOverrides
49-
* if <code>true</code>, conflicts will be resolved by using the patch contents<br>
50-
* if <code>false</code>, conflicts will be resolved by using the base contents
49+
* if <code>true</code>, conflicts will be resolved by using the patch contents<br>
50+
* if <code>false</code>, conflicts will be resolved by using the base contents
5151
* @author mbrunnli (19.03.2013)
5252
*/
5353
public JavaMerger(String type, boolean patchOverrides) {
@@ -58,7 +58,7 @@ public JavaMerger(String type, boolean patchOverrides) {
5858

5959
/**
6060
* {@inheritDoc}
61-
*
61+
*
6262
* @author mbrunnli (08.04.2014)
6363
*/
6464
@Override
@@ -69,21 +69,23 @@ public String getType() {
6969

7070
/**
7171
* {@inheritDoc}
72-
*
72+
*
7373
* @throws IOException
74-
* if the base file does not exist or could not be written
74+
* if the base file does not exist or could not be written
7575
* @throws MergeException
76-
* if problems occurs while merging
76+
* if problems occurs while merging
7777
* @author mbrunnli (19.03.2013)
7878
*/
7979
@Override
8080
public String merge(File base, String patch, String targetCharset) throws IOException, MergeException {
8181

82-
ModifyableJavaClass baseClass = getJavaClass(new InputStreamReader(new FileInputStream(base), targetCharset));
82+
ModifyableJavaClass baseClass =
83+
getJavaClass(new InputStreamReader(new FileInputStream(base), targetCharset));
8384
ModifyableJavaClass patchClass = getJavaClass(new StringReader(patch));
8485

8586
if (baseClass == null) {
86-
throw new MergeException("The base file " + base.getAbsolutePath() + " does not declare a valid JavaClass");
87+
throw new MergeException("The base file " + base.getAbsolutePath()
88+
+ " does not declare a valid JavaClass");
8789
} else if (patchClass == null) {
8890
throw new MergeException("The patch does not declare a valid JavaClass");
8991
}
@@ -94,9 +96,9 @@ public String merge(File base, String patch, String targetCharset) throws IOExce
9496

9597
/**
9698
* Consolidates all line endings to the System default
97-
*
99+
*
98100
* @param codeBlock
99-
* which should be consolidate
101+
* which should be consolidate
100102
* @return the consolidated code block
101103
* @author mbrunnli (04.06.2013)
102104
*/
@@ -107,12 +109,12 @@ private String consolidateLineEndings(String codeBlock) {
107109

108110
/**
109111
* Merges the two classes
110-
*
112+
*
111113
* @return the merged {@link JavaClass}
112114
* @param baseClass
113-
* {@link JavaClass}
115+
* {@link JavaClass}
114116
* @param patchClass
115-
* {@link JavaClass}
117+
* {@link JavaClass}
116118
* @author mbrunnli (19.03.2013)
117119
*/
118120
private ModifyableJavaClass merge(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
@@ -127,11 +129,11 @@ private ModifyableJavaClass merge(ModifyableJavaClass baseClass, ModifyableJavaC
127129

128130
/**
129131
* Merges all super types of the two class sources
130-
*
132+
*
131133
* @param baseClass
132-
* {@link JavaClass}
134+
* {@link JavaClass}
133135
* @param patchClass
134-
* {@link JavaClass}
136+
* {@link JavaClass}
135137
* @author mbrunnli (03.06.2013)
136138
*/
137139
private void mergeSupertypes(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
@@ -161,11 +163,11 @@ private void mergeSupertypes(ModifyableJavaClass baseClass, ModifyableJavaClass
161163

162164
/**
163165
* Merges all imports of the two class sources
164-
*
166+
*
165167
* @param baseClass
166-
* {@link JavaClass}
168+
* {@link JavaClass}
167169
* @param patchClass
168-
* {@link JavaClass}
170+
* {@link JavaClass}
169171
* @author mbrunnli (05.04.2013)
170172
*/
171173
private void mergeImports(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
@@ -192,10 +194,11 @@ private void mergeImports(ModifyableJavaClass baseClass, ModifyableJavaClass pat
192194

193195
/**
194196
* Shortens a canonical type name to the type name itself
195-
*
197+
*
196198
* @param canonicalName
199+
* to be shortend
197200
* @return the Type name
198-
* @author Malte Brunnlieb
201+
* @author mbrunnli
199202
*/
200203
private String getShortTypeName(String canonicalName) {
201204

@@ -208,19 +211,19 @@ private String getShortTypeName(String canonicalName) {
208211

209212
/**
210213
* Merges all inner {@link JavaClass}es of the given {@link JavaClass}es
211-
*
214+
*
212215
* @param baseClass
213-
* {@link JavaClass}
216+
* {@link JavaClass}
214217
* @param patchClass
215-
* {@link JavaClass}
218+
* {@link JavaClass}
216219
* @author mbrunnli (19.03.2013)
217220
*/
218221
private void mergeInnerClasses(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
219222

220223
for (JavaClass rawInnerPatchClass : patchClass.getNestedClasses()) {
221224
ModifyableJavaClass innerPatchClass = (ModifyableJavaClass) rawInnerPatchClass;
222225
ModifyableJavaClass nestedBaseClass =
223-
(ModifyableJavaClass) baseClass.getNestedClassByName(innerPatchClass.getName());
226+
(ModifyableJavaClass) baseClass.getNestedClassByName(innerPatchClass.getName());
224227
if (nestedBaseClass == null) {
225228
baseClass.addClass(innerPatchClass);
226229
} else {
@@ -231,11 +234,11 @@ private void mergeInnerClasses(ModifyableJavaClass baseClass, ModifyableJavaClas
231234

232235
/**
233236
* Merges all fields of the given {@link JavaClass}es
234-
*
237+
*
235238
* @param baseClass
236-
* {@link JavaClass}
239+
* {@link JavaClass}
237240
* @param patchClass
238-
* {@link JavaClass}
241+
* {@link JavaClass}
239242
* @author mbrunnli (19.03.2013)
240243
*/
241244
private void mergeFields(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
@@ -254,11 +257,11 @@ private void mergeFields(ModifyableJavaClass baseClass, ModifyableJavaClass patc
254257

255258
/**
256259
* Merges all methods of the given {@link JavaClass}es
257-
*
260+
*
258261
* @param baseClass
259-
* {@link JavaClass}
262+
* {@link JavaClass}
260263
* @param patchClass
261-
* {@link JavaClass}
264+
* {@link JavaClass}
262265
* @author mbrunnli (19.03.2013)
263266
*/
264267
private void mergeMethods(ModifyableJavaClass baseClass, ModifyableJavaClass patchClass) {
@@ -279,7 +282,7 @@ private void mergeMethods(ModifyableJavaClass baseClass, ModifyableJavaClass pat
279282
}
280283
for (JavaMethod patchMethod : patchClass.getMethods()) {
281284
JavaMethod baseMethod =
282-
baseClass.getMethodBySignature(patchMethod.getName(), patchMethod.getParameterTypes(true));
285+
baseClass.getMethodBySignature(patchMethod.getName(), patchMethod.getParameterTypes(true));
283286
if (baseMethod == null) {
284287
baseClass.addMethod(patchMethod);
285288
} else {
@@ -292,9 +295,9 @@ private void mergeMethods(ModifyableJavaClass baseClass, ModifyableJavaClass pat
292295

293296
/**
294297
* Returns the {@link JavaClass} parsed by the given {@link Reader}
295-
*
298+
*
296299
* @param reader
297-
* {@link Reader} which contents should be parsed
300+
* {@link Reader} which contents should be parsed
298301
* @return the parsed {@link JavaClass}
299302
* @author mbrunnli (19.03.2013)
300303
*/

‎cobigen/cobigen-javaplugin/src/main/java/com/capgemini/cobigen/javaplugin/util/JavaModelUtil.java

+5
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ public class JavaModelUtil {
2020
*/
2121
public static Map<String, Object> getRoot(Map<String, Object> model) {
2222

23+
@SuppressWarnings("unchecked")
2324
Map<String, Object> pojoMap = (Map<String, Object>) model.get(ModelConstant.ROOT);
2425
return pojoMap;
2526
}
@@ -33,6 +34,7 @@ public static Map<String, Object> getRoot(Map<String, Object> model) {
3334
*/
3435
public static Map<String, Object> getAnnotations(Map<String, Object> model) {
3536

37+
@SuppressWarnings("unchecked")
3638
Map<String, Object> annotations = (Map<String, Object>) model.get(ModelConstant.ANNOTATIONS);
3739
return annotations;
3840
}
@@ -81,6 +83,7 @@ public static Map<String, Object> getField(Map<String, Object> model, String fie
8183
* @return the model's supertype element
8284
*/
8385
public static Map<String, Object> getExtendedType(Map<String, Object> model) {
86+
@SuppressWarnings("unchecked")
8487
Map<String, Object> supertype = (Map<String, Object>) getRoot(model).get(ModelConstant.EXTENDED_TYPE);
8588
return supertype;
8689
}
@@ -93,6 +96,7 @@ public static Map<String, Object> getExtendedType(Map<String, Object> model) {
9396
* @return the model's interfaces element
9497
*/
9598
public static List<Map<String, Object>> getImplementedTypes(Map<String, Object> model) {
99+
@SuppressWarnings("unchecked")
96100
List<Map<String, Object>> interfaces =
97101
(List<Map<String, Object>>) getRoot(model).get(ModelConstant.IMPLEMENTED_TYPES);
98102
return interfaces;
@@ -126,6 +130,7 @@ public static Map<String, Object> getImplementedType(Map<String, Object> model,
126130
* @return the model's methods element
127131
*/
128132
public static List<Map<String, Object>> getMethods(Map<String, Object> model) {
133+
@SuppressWarnings("unchecked")
129134
List<Map<String, Object>> methods =
130135
(List<Map<String, Object>>) getRoot(model).get(ModelConstant.METHODS);
131136
return methods;

‎cobigen/cobigen-javaplugin/src/test/java/com/capgemini/cobigen/javaplugin/test/inputreader/ReflectedJavaModelBuilderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public void testCorrectlyExtractedImplementedTypes() throws FileNotFoundExceptio
9292
* @author mbrunnli (30.09.2014)
9393
*/
9494
@Test
95-
public void testCorrectlyExtractedInheritedType() throws FileNotFoundException {
95+
public void testCorrectlyExtractedInheritedType() {
9696
JavaInputReader javaModelBuilder = new JavaInputReader();
9797
Map<String, Object> model = javaModelBuilder.createModel(TestClass.class);
9898

0 commit comments

Comments
 (0)