Skip to content

Commit 564ba03

Browse files
mjpt777mjpt777
committed
[Java] Add final parameter checkstyle.
1 parent 10e5ae7 commit 564ba03

File tree

11 files changed

+108
-81
lines changed

11 files changed

+108
-81
lines changed

‎config/checkstyle.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<property name="file" value="config/suppress.xml"/>
77
</module>
88

9+
<module name="SuppressWarningsFilter"/>
10+
911
<module name="SeverityMatchFilter">
1012
<property name="severity" value="info"/>
1113
<property name="acceptOnMatch" value="false"/>
@@ -19,10 +21,14 @@
1921
<property name="tabWidth" value="4"/>
2022
<property name="severity" value="error"/>
2123

24+
<module name="SuppressWarningsHolder"/>
25+
2226
<module name="Indentation"/>
2327

2428
<module name="ConstantName"/>
2529

30+
<module name="FinalParameters"/>
31+
2632
<module name="FinalLocalVariable"/>
2733

2834
<module name="LocalFinalVariableName"/>

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/PrimitiveType.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,13 @@ public PrimitiveValue nullValue()
109109
return nullValue;
110110
}
111111

112-
public static boolean isUnsigned(PrimitiveType type)
112+
/**
113+
* Is the type an unsigned type like in C.
114+
*
115+
* @param type to be tested.
116+
* @return true if unsigned otherwise false.
117+
*/
118+
public static boolean isUnsigned(final PrimitiveType type)
113119
{
114120
switch (type)
115121
{

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/golang/GolangGenerator.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public GolangGenerator(final Ir ir, final OutputManager outputManager)
5353
this.outputManager = outputManager;
5454
}
5555

56-
public void generateFileFromTemplate(String fileName, String templateName) throws IOException
56+
public void generateFileFromTemplate(final String fileName, final String templateName) throws IOException
5757
{
5858
try (Writer out = outputManager.createOutput(fileName))
5959
{
@@ -512,8 +512,8 @@ private void generateEncodeDecodeClose(
512512
// length elements (groups and vardata). We read past the difference
513513
// between the message's blockLength and our (older) schema's blockLength
514514
private void generateExtensionCheck(
515-
StringBuilder sb,
516-
char varName)
515+
final StringBuilder sb,
516+
final char varName)
517517
{
518518
this.imports.add("io");
519519
this.imports.add("io/ioutil");
@@ -529,8 +529,8 @@ private int generateEncodeDecode(
529529
final StringBuilder sb,
530530
final String typeName,
531531
final List<Token> tokens,
532-
boolean isMessage,
533-
boolean isExtensible)
532+
final boolean isMessage,
533+
final boolean isExtensible)
534534
{
535535
final char varName = Character.toLowerCase(typeName.charAt(0));
536536
final StringBuilder encode = new StringBuilder();
@@ -913,10 +913,10 @@ private int generateFieldEncodeDecode(
913913
final List<Token> tokens,
914914
final char varName,
915915
final int currentOffset,
916-
StringBuilder encode,
917-
StringBuilder decode,
918-
StringBuilder rc,
919-
StringBuilder init)
916+
final StringBuilder encode,
917+
final StringBuilder decode,
918+
final StringBuilder rc,
919+
final StringBuilder init)
920920
{
921921
final Token signalToken = tokens.get(0);
922922
final Token encodingToken = tokens.get(1);

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1353,15 +1353,16 @@ private void generateAnnotations(
13531353
final String className,
13541354
final List<Token> tokens,
13551355
final Appendable out,
1356-
int index,
1356+
final int index,
13571357
final Function<String, String> nameMapping) throws IOException
13581358
{
13591359
if (shouldGenerateGroupOrderAnnotation)
13601360
{
13611361
final List<String> groupClassNames = new ArrayList<>();
13621362
int level = 0;
1363+
int i = index;
13631364

1364-
for (int size = tokens.size(); index < size; index++)
1365+
for (int size = tokens.size(); i < size; i++)
13651366
{
13661367
if (tokens.get(index).signal() == Signal.BEGIN_GROUP)
13671368
{
@@ -1381,11 +1382,11 @@ else if (tokens.get(index).signal() == Signal.END_GROUP && --level < 0)
13811382
if (!groupClassNames.isEmpty())
13821383
{
13831384
out.append(indent).append("@uk.co.real_logic.sbe.codec.java.GroupOrder({");
1384-
index = 0;
1385+
i = 0;
13851386
for (final String name : groupClassNames)
13861387
{
13871388
out.append(className).append('.').append(name).append(".class");
1388-
if (++index < groupClassNames.size())
1389+
if (++i < groupClassNames.size())
13891390
{
13901391
out.append(", ");
13911392
}

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/GenerationUtil.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,26 @@ public static int collectVarData(final List<Token> tokens, final int index, fina
4444
return collect(Signal.BEGIN_VAR_DATA, tokens, index, varData);
4545
}
4646

47-
public static int collect(final Signal signal, final List<Token> tokens, int index, final List<Token> collected)
47+
public static int collect(
48+
final Signal signal, final List<Token> tokens, final int index, final List<Token> collected)
4849
{
49-
while (index < tokens.size())
50+
int i = index;
51+
while (i < tokens.size())
5052
{
51-
final Token token = tokens.get(index);
53+
final Token token = tokens.get(i);
5254
if (signal != token.signal())
5355
{
5456
break;
5557
}
5658

5759
final int tokenCount = token.componentTokenCount();
58-
for (final int limit = index + tokenCount; index < limit; index++)
60+
for (final int limit = i + tokenCount; i < limit; i++)
5961
{
60-
collected.add(tokens.get(index));
62+
collected.add(tokens.get(i));
6163
}
6264
}
6365

64-
return index;
66+
return i;
6567
}
6668

6769
public static List<Token> getMessageBody(final List<Token> tokens)

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/Ir.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -320,21 +320,22 @@ private void captureTypes(final List<Token> tokens, final int beginIndex, final
320320
}
321321
}
322322

323-
private int captureType(final List<Token> tokens, int index, final Signal endSignal, final String name)
323+
private int captureType(final List<Token> tokens, final int index, final Signal endSignal, final String name)
324324
{
325325
final List<Token> typeTokens = new ArrayList<>();
326326

327-
Token token = tokens.get(index);
327+
int i = index;
328+
Token token = tokens.get(i);
328329
typeTokens.add(token);
329330
do
330331
{
331-
token = tokens.get(++index);
332+
token = tokens.get(++i);
332333
typeTokens.add(token);
333334
}
334335
while (endSignal != token.signal() || !name.equals(token.name()));
335336

336337
typesByNameMap.put(name, typeTokens);
337338

338-
return index;
339+
return i;
339340
}
340341
}

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/IrDecoder.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,22 +130,23 @@ private int captureHeader(final List<Token> tokens)
130130
return index;
131131
}
132132

133-
private static int captureMessage(final List<Token> tokens, int index, final Ir ir)
133+
private static int captureMessage(final List<Token> tokens, final int index, final Ir ir)
134134
{
135135
final List<Token> messageTokens = new ArrayList<>();
136136

137-
Token token = tokens.get(index);
137+
int i = index;
138+
Token token = tokens.get(i);
138139
messageTokens.add(token);
139140
do
140141
{
141-
token = tokens.get(++index);
142+
token = tokens.get(++i);
142143
messageTokens.add(token);
143144
}
144145
while (Signal.END_MESSAGE != token.signal());
145146

146-
ir.addMessage(tokens.get(index).id(), messageTokens);
147+
ir.addMessage(tokens.get(i).id(), messageTokens);
147148

148-
return index;
149+
return i;
149150
}
150151

151152
private void decodeFrame()

‎sbe-tool/src/main/java/uk/co/real_logic/sbe/otf/AbstractTokenListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public void onEndComposite(
8484
// no op
8585
}
8686

87-
public void onGroupHeader(Token token, int numInGroup)
87+
public void onGroupHeader(final Token token, final int numInGroup)
8888
{
8989
// no op
9090
}

0 commit comments

Comments
 (0)