Skip to content

Commit 30bae25

Browse files
gfukushimagfukushima
authored
Add final to method input params - Teku module (Consensys#8211)
* Add final to method params - teku module Signed-off-by: Gabriel Fukushima <[email protected]> --------- Signed-off-by: Gabriel Fukushima <[email protected]>
1 parent 7717b16 commit 30bae25

23 files changed

+42
-41
lines changed

‎teku/src/main/java/tech/pegasys/teku/Teku.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public final class Teku {
3333
Security.addProvider(new BouncyCastleProvider());
3434
}
3535

36-
public static void main(String[] args) {
36+
public static void main(final String[] args) {
3737
Thread.setDefaultUncaughtExceptionHandler(new TekuDefaultExceptionHandler());
3838

3939
try {
@@ -54,7 +54,7 @@ public static void main(String[] args) {
5454
}
5555
}
5656

57-
private static int start(StartAction startAction, final String... args) {
57+
private static int start(final StartAction startAction, final String... args) {
5858
final PrintWriter outputWriter = new PrintWriter(System.out, true, Charset.defaultCharset());
5959
final PrintWriter errorWriter = new PrintWriter(System.err, true, Charset.defaultCharset());
6060
final LoggingConfigurator loggingConfigurator = new LoggingConfigurator();
@@ -80,7 +80,7 @@ private static Node start(final TekuConfiguration config, final boolean validato
8080
return node;
8181
}
8282

83-
static Optional<Node> startFromCLIArgs(String[] cliArgs) throws CLIException {
83+
static Optional<Node> startFromCLIArgs(final String[] cliArgs) throws CLIException {
8484
AtomicReference<Node> nodeRef = new AtomicReference<>();
8585
int result =
8686
start((config, validatorClient) -> nodeRef.set(start(config, validatorClient)), cliArgs);
@@ -90,18 +90,18 @@ static Optional<Node> startFromCLIArgs(String[] cliArgs) throws CLIException {
9090
return Optional.ofNullable(nodeRef.get());
9191
}
9292

93-
static BeaconNode startBeaconNode(TekuConfiguration config) {
93+
static BeaconNode startBeaconNode(final TekuConfiguration config) {
9494
return (BeaconNode) start(config, false);
9595
}
9696

97-
static ValidatorNode startValidatorNode(TekuConfiguration config) {
97+
static ValidatorNode startValidatorNode(final TekuConfiguration config) {
9898
return (ValidatorNode) start(config, true);
9999
}
100100

101101
private static class CLIException extends RuntimeException {
102102
private final int resultCode;
103103

104-
public CLIException(int resultCode) {
104+
public CLIException(final int resultCode) {
105105
super("Unable to start Teku. Exit code: " + resultCode);
106106
this.resultCode = resultCode;
107107
}

‎teku/src/main/java/tech/pegasys/teku/TekuFacade.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ public final class TekuFacade {
3131
* start a Node (e.g. <code>--help</code> command)
3232
* @throws RuntimeException if invalid args supplied or an internal error while starting a Node
3333
*/
34-
public static Optional<? extends NodeFacade> startFromCLIArgs(String[] cliArgs) {
34+
public static Optional<? extends NodeFacade> startFromCLIArgs(final String[] cliArgs) {
3535
return Teku.startFromCLIArgs(cliArgs);
3636
}
3737

38-
public static BeaconNodeFacade startBeaconNode(TekuConfiguration config) {
38+
public static BeaconNodeFacade startBeaconNode(final TekuConfiguration config) {
3939
return Teku.startBeaconNode(config);
4040
}
4141

42-
public static ValidatorNodeFacade startValidatorNode(TekuConfiguration config) {
42+
public static ValidatorNodeFacade startValidatorNode(final TekuConfiguration config) {
4343
return Teku.startValidatorNode(config);
4444
}
4545
}

‎teku/src/main/java/tech/pegasys/teku/cli/BeaconNodeCommand.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -319,13 +319,13 @@ private int handleParseException(final CommandLine.ParameterException ex, final
319319
return ex.getCommandLine().getCommandSpec().exitCodeOnInvalidInput();
320320
}
321321

322-
private void printUsage(PrintWriter outputWriter) {
322+
private void printUsage(final PrintWriter outputWriter) {
323323
outputWriter.println();
324324
outputWriter.println("To display full help:");
325325
outputWriter.println("teku [COMMAND] --help");
326326
}
327327

328-
public boolean isOptionSpecified(String optionLongName) {
328+
public boolean isOptionSpecified(final String optionLongName) {
329329
var parseResult = spec.commandLine().getParseResult();
330330
var option = spec.findOption(optionLongName);
331331
return option != null && parseResult.hasMatchedOption(option);

‎teku/src/main/java/tech/pegasys/teku/cli/converter/LogTypeConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
public class LogTypeConverter implements ITypeConverter<Level> {
2222
@Override
23-
public Level convert(String value) {
23+
public Level convert(final String value) {
2424
switch (value.toUpperCase(Locale.ROOT)) {
2525
case "OFF":
2626
return Level.OFF;

‎teku/src/main/java/tech/pegasys/teku/cli/options/BeaconRestApiOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public class BeaconRestApiOptions {
101101
defaultValue = "65535",
102102
showDefaultValue = Visibility.ALWAYS,
103103
hidden = true)
104-
public void setMaxUrlLength(int maxUrlLength) {
104+
public void setMaxUrlLength(final int maxUrlLength) {
105105
if (maxUrlLength < 4096 || maxUrlLength > 1052672) {
106106
throw new CommandLine.ParameterException(
107107
cliSpec.commandLine(),

‎teku/src/main/java/tech/pegasys/teku/cli/options/DataOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public String getDataPath() {
3535
return getDataConfig().getDataBasePath().toString();
3636
}
3737

38-
public void configure(TekuConfiguration.Builder builder) {
38+
public void configure(final TekuConfiguration.Builder builder) {
3939
builder.data(this::configureDataConfig);
4040
}
4141

‎teku/src/main/java/tech/pegasys/teku/cli/options/Eth2NetworkOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ private Eth2NetworkConfiguration createEth2NetworkConfig(
277277
return builder.build();
278278
}
279279

280-
private void configureEth2Network(Eth2NetworkConfiguration.Builder builder) {
280+
private void configureEth2Network(final Eth2NetworkConfiguration.Builder builder) {
281281
builder.applyNetworkDefaults(network);
282282
if (startupTargetPeerCount != null) {
283283
builder.startupTargetPeerCount(startupTargetPeerCount);

‎teku/src/main/java/tech/pegasys/teku/cli/options/LoggingOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public class LoggingOptions {
149149
arity = "1")
150150
private int dbOpAlertThresholdMillis = LoggingConfig.DEFAULT_DB_OP_ALERT_THRESHOLD_MILLIS;
151151

152-
private boolean containsPath(String file) {
152+
private boolean containsPath(final String file) {
153153
return file.contains(LINUX_SEP) || file.contains(WINDOWS_SEP);
154154
}
155155

‎teku/src/main/java/tech/pegasys/teku/cli/options/MetricsOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public class MetricsOptions {
155155
private boolean blobSidecarsStorageCountersEnabled =
156156
MetricsConfig.DEFAULT_BLOB_SIDECARS_STORAGE_COUNTERS_ENABLED;
157157

158-
public void configure(TekuConfiguration.Builder builder) {
158+
public void configure(final TekuConfiguration.Builder builder) {
159159
builder.metrics(
160160
b ->
161161
b.metricsEnabled(metricsEnabled)

‎teku/src/main/java/tech/pegasys/teku/cli/options/ValidatorClientOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public class ValidatorClientOptions {
8686
private boolean obolDvtSelectionsEndpointEnabled =
8787
ValidatorConfig.DEFAULT_OBOL_DVT_SELECTIONS_ENDPOINT_ENABLED;
8888

89-
public void configure(TekuConfiguration.Builder builder) {
89+
public void configure(final TekuConfiguration.Builder builder) {
9090
configureBeaconNodeApiEndpoints();
9191

9292
builder.validator(

‎teku/src/main/java/tech/pegasys/teku/cli/options/ValidatorKeysOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public class ValidatorKeysOptions {
104104
private int validatorExternalSignerConcurrentRequestLimit =
105105
ValidatorConfig.DEFAULT_VALIDATOR_EXTERNAL_SIGNER_CONCURRENT_REQUEST_LIMIT;
106106

107-
public void configure(TekuConfiguration.Builder builder) {
107+
public void configure(final TekuConfiguration.Builder builder) {
108108
builder.validator(
109109
config ->
110110
config

‎teku/src/main/java/tech/pegasys/teku/cli/options/ValidatorOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public class ValidatorOptions {
174174
fallbackValue = "true")
175175
private boolean shutdownWhenValidatorSlashed = DEFAULT_SHUTDOWN_WHEN_VALIDATOR_SLASHED_ENABLED;
176176

177-
public void configure(TekuConfiguration.Builder builder) {
177+
public void configure(final TekuConfiguration.Builder builder) {
178178
builder.validator(
179179
config ->
180180
config

‎teku/src/main/java/tech/pegasys/teku/cli/options/ValidatorProposerOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public class ValidatorProposerOptions {
111111
arity = "0..1")
112112
private boolean blindedBlocksEnabled = DEFAULT_VALIDATOR_BLINDED_BLOCKS_ENABLED;
113113

114-
public void configure(TekuConfiguration.Builder builder) {
114+
public void configure(final TekuConfiguration.Builder builder) {
115115
builder.validator(
116116
config ->
117117
config

‎teku/src/main/java/tech/pegasys/teku/cli/options/WeakSubjectivityOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class WeakSubjectivityOptions {
4444
hidden = true)
4545
private UInt64 suppressWSPeriodChecksUntilEpoch = null;
4646

47-
public TekuConfiguration.Builder configure(TekuConfiguration.Builder builder) {
47+
public TekuConfiguration.Builder configure(final TekuConfiguration.Builder builder) {
4848
return builder.weakSubjectivity(
4949
wsBuilder -> {
5050
getWeakSubjectivityCheckpoint().ifPresent(wsBuilder::weakSubjectivityCheckpoint);

‎teku/src/main/java/tech/pegasys/teku/cli/subcommand/GenesisCommand.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ public class GenesisCommand {
5454
footerHeading = "%n",
5555
footer = "Teku is licensed under the Apache License 2.0")
5656
public void generate(
57-
@Mixin MockGenesisParams genesisParams, @Mixin MinimalEth2NetworkOptions networkOptions)
57+
@Mixin final MockGenesisParams genesisParams,
58+
@Mixin final MinimalEth2NetworkOptions networkOptions)
5859
throws IOException {
5960
// Output to stdout if no file is specified
6061
final Spec spec = networkOptions.getSpec();

‎teku/src/main/java/tech/pegasys/teku/cli/subcommand/PeerCommand.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ public class PeerCommand {
7272
footerHeading = "%n",
7373
footer = "Teku is licensed under the Apache License 2.0")
7474
public void generate(
75-
@Mixin PeerGenerationParams params,
75+
@Mixin final PeerGenerationParams params,
7676
@Option(
7777
names = {"-n", "--number"},
7878
arity = "1",
7979
required = true,
8080
description = "number of peerIDs to generate")
81-
int number) {
81+
final int number) {
8282
try {
8383
validateParamsAndGenerate(params.outputFile, number);
8484
spec.commandLine().getOut().println("Generated file " + params.outputFile);
@@ -87,7 +87,7 @@ public void generate(
8787
}
8888
}
8989

90-
void validateParamsAndGenerate(String outputFile, int number) throws IOException {
90+
void validateParamsAndGenerate(final String outputFile, final int number) throws IOException {
9191
try {
9292
File f = new File(outputFile);
9393
if (f.exists()) {

‎teku/src/main/java/tech/pegasys/teku/cli/subcommand/TransitionCommand.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ public class TransitionCommand implements Runnable {
7676
footerHeading = "%n",
7777
footer = "Teku is licensed under the Apache License 2.0")
7878
public int blocks(
79-
@Mixin InAndOutParams params,
79+
@Mixin final InAndOutParams params,
8080
@Parameters(paramLabel = "block", description = "Files to read blocks from (ssz or hex)")
81-
List<String> blockPaths) {
81+
final List<String> blockPaths) {
8282
return processStateTransition(
8383
params,
8484
(spec, state) -> {
@@ -110,15 +110,15 @@ public int blocks(
110110
footerHeading = "%n",
111111
footer = "Teku is licensed under the Apache License 2.0")
112112
public int slots(
113-
@Mixin InAndOutParams params,
113+
@Mixin final InAndOutParams params,
114114
@Option(
115115
names = {"--delta", "-d"},
116116
showDefaultValue = Visibility.ALWAYS,
117117
fallbackValue = "true",
118118
description = "to interpret the slot number as a delta from the pre-state")
119-
boolean delta,
119+
final boolean delta,
120120
@Parameters(paramLabel = "<number>", description = "Number of slots to process")
121-
long number) {
121+
final long number) {
122122
return processStateTransition(
123123
params,
124124
(specProvider, state) -> {
@@ -200,7 +200,7 @@ private SignedBeaconBlock deserializeSignedBeaconBlockFromHex(
200200
final Spec spec,
201201
final String path,
202202
final byte[] hexBlockData,
203-
RuntimeException sszSerializationException) {
203+
final RuntimeException sszSerializationException) {
204204
try {
205205
final Bytes blockData = Bytes.wrap(Hex.decode(hexBlockData));
206206
return spec.deserializeSignedBeaconBlock(blockData);

‎teku/src/main/java/tech/pegasys/teku/cli/subcommand/ValidatorClientCommand.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ private void configureWithSpecFromBeaconNode(final Eth2NetworkConfiguration.Buil
119119
}
120120
}
121121

122-
private boolean isAutoDetectNetworkOption(String option) {
122+
private boolean isAutoDetectNetworkOption(final String option) {
123123
return AUTO_NETWORK_OPTION.equalsIgnoreCase(option);
124124
}
125125

126-
private void configureEth2Network(TekuConfiguration.Builder builder) {
126+
private void configureEth2Network(final TekuConfiguration.Builder builder) {
127127
if (parentCommand.isOptionSpecified("--network")) {
128128
throw new InvalidConfigurationException(
129129
"--network option should not be specified before the validator-client command");

‎teku/src/main/java/tech/pegasys/teku/cli/subcommand/internal/validator/tools/DepositTransactionSender.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public DepositTransactionSender(
5959
}
6060

6161
public SafeFuture<TransactionReceipt> sendDepositTransaction(
62-
BLSKeyPair validatorKeyPair,
62+
final BLSKeyPair validatorKeyPair,
6363
final BLSPublicKey withdrawalPublicKey,
6464
final UInt64 amountInGwei,
6565
final Consumer<String> commandStdOutput,

‎teku/src/main/java/tech/pegasys/teku/cli/util/DatabaseMigrater.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ void migrateData() throws DatabaseMigraterError {
176176
}
177177

178178
@VisibleForTesting
179-
KvStoreDatabase createDatabase(final Path databasePath, DatabaseVersion databaseVersion)
179+
KvStoreDatabase createDatabase(final Path databasePath, final DatabaseVersion databaseVersion)
180180
throws DatabaseMigraterError {
181181
final Eth2NetworkConfiguration config = Eth2NetworkConfiguration.builder(network).build();
182182
final VersionedDatabaseFactory databaseFactory =

‎teku/src/main/java/tech/pegasys/teku/cli/util/EnvironmentVariableParamsProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public EnvironmentVariableParamsProvider(final Map<String, String> environment)
3333
}
3434

3535
@Override
36-
public Map<String, String> getAdditionalParams(List<OptionSpec> potentialParams) {
36+
public Map<String, String> getAdditionalParams(final List<OptionSpec> potentialParams) {
3737
return getAdditionalParams(potentialParams, environment);
3838
}
3939

@@ -64,7 +64,7 @@ protected Optional<Entry<String, String>> translateEntry(
6464

6565
@Override
6666
protected Map.Entry<String, String> translateToArg(
67-
OptionSpec matchedOption, Map.Entry<String, String> envEntry) {
67+
final OptionSpec matchedOption, final Map.Entry<String, String> envEntry) {
6868
return Map.entry(matchedOption.longestName(), envEntry.getValue());
6969
}
7070
}

‎teku/src/main/java/tech/pegasys/teku/cli/util/YamlConfigFileParamsProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ protected Optional<Entry<String, Object>> translateEntry(
8585

8686
@Override
8787
protected Map.Entry<String, String> translateToArg(
88-
OptionSpec matchedOption, Map.Entry<String, Object> yamlEntry) {
88+
final OptionSpec matchedOption, final Map.Entry<String, Object> yamlEntry) {
8989
final Object value = yamlEntry.getValue();
9090

9191
final String translatedValue;
@@ -160,7 +160,7 @@ private void checkUnknownOptions(final Map<String, Object> result) {
160160
}
161161
}
162162

163-
private void checkConfigurationValidity(boolean isEmpty) {
163+
private void checkConfigurationValidity(final boolean isEmpty) {
164164
if (isEmpty) {
165165
throw new ParameterException(
166166
commandLine, String.format("Empty yaml configuration file: %s", configFile));

‎teku/src/main/java/tech/pegasys/teku/config/TekuConfiguration.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ public Builder store(final Consumer<StoreConfig.Builder> storeConfigBuilderConsu
386386
}
387387

388388
public Builder beaconChainControllerFactory(
389-
BeaconChainControllerFactory beaconChainControllerFactory) {
389+
final BeaconChainControllerFactory beaconChainControllerFactory) {
390390
this.beaconChainControllerFactory = beaconChainControllerFactory;
391391
return this;
392392
}

0 commit comments

Comments
 (0)