Skip to content

Commit 7cc84dc

Browse files
authored
Use constructors in all classes to avoid Java warnings (#12302)
Signed-off-by: Jakub Scholz <www@scholzj.com>
1 parent 087bb66 commit 7cc84dc

File tree

113 files changed

+351
-32
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+351
-32
lines changed

.checkstyle/checkstyle.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@
7272
<module name="StaticVariableName"/>
7373
<module name="TypeName"/>
7474
<module name="AvoidStarImport"/>
75+
<module name="HideUtilityClassConstructor"/>
76+
<module name="MissingCtor"/>
77+
7578

7679
<!-- dependencies and import control -->
7780
<module name="ImportControl">

.checkstyle/suppressions.xml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,24 @@
3333
<suppress checks="UnnecessaryParentheses"
3434
files="io[/\\]strimzi[/\\].*"/>
3535

36-
<!-- Skip Javadoc checks for tests-->
36+
<!-- Skip Javadoc checks for tests -->
3737
<suppress checks="(JavadocMethod|JavadocType|JavadocVariable|MissingJavadocType|MissingJavadocMethod)" files="src[/\\]test[/\\]java[/\\].*"/>
3838

39-
<!-- The api module is currently not ready or Javadoc checks-->
39+
<!-- Do not require constructors in test classes -->
40+
<suppress checks="(MissingCtor|HideUtilityClassConstructor)" files="src[/\\]test[/\\]java[/\\].*"/>
41+
42+
<!-- The api module is currently not ready for Javadoc checks -->
4043
<suppress checks="(JavadocMethod|JavadocType|JavadocVariable|MissingJavadocType|MissingJavadocMethod)" files="api[/\\]src[/\\]main[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
4144

42-
<!-- The systemtest module is currently not ready or Javadoc checks-->
45+
<!-- The api module is currently not ready for constructor checks -->
46+
<suppress checks="(MissingCtor|HideUtilityClassConstructor)" files="api[/\\]src[/\\]main[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
47+
48+
<!-- The systemtest module is currently not ready for Javadoc checks -->
4349
<suppress checks="(JavadocMethod|JavadocType|JavadocVariable|MissingJavadocType|MissingJavadocMethod|JavadocStyle)" files="systemtest[/\\]src[/\\]main[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
4450
<suppress checks="(JavadocStyle)" files="systemtest[/\\]src[/\\]test[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
4551

52+
<!-- The systemtest module is currently not ready for Constructor checks-->
53+
<suppress checks="(MissingCtor|HideUtilityClassConstructor)" files="systemtest[/\\]src[/\\]main[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
54+
<suppress checks="(MissingCtor|HideUtilityClassConstructor)" files="systemtest[/\\]src[/\\]test[/\\]java[/\\]io[/\\]strimzi[/\\].*"/>
55+
4656
</suppressions>

api/src/main/java/io/strimzi/api/ResourceAnnotations.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@
77
/**
88
* Class for holding some annotation keys.
99
*/
10+
@SuppressWarnings("HideUtilityClassConstructor") // We extend this class latest in the CO module, that is why it cannot have a private constructor
1011
public class ResourceAnnotations {
12+
/**
13+
* Constructor
14+
*/
15+
public ResourceAnnotations() { }
16+
1117
/**
1218
* The Strimzi domain used in all annotations
1319
*/

api/src/main/java/io/strimzi/api/ResourceLabels.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@
77
/**
88
* An immutable set of labels
99
*/
10+
@SuppressWarnings("HideUtilityClassConstructor") // We extend this class latest in the CO module, that is why it cannot have a private constructor
1011
public class ResourceLabels {
12+
/**
13+
* Constructor
14+
*/
15+
public ResourceLabels() { }
16+
1117
/**
1218
* Strimzi domain used for the Strimzi labels
1319
*/

api/src/main/java/io/strimzi/api/kafka/Crds.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ public class Crds {
5959
KafkaNodePool.class
6060
};
6161

62-
private Crds() {
63-
}
62+
private Crds() { }
6463

6564
@SuppressWarnings({"checkstyle:JavaNCSS"})
6665
private static CustomResourceDefinition crd(Class<? extends CustomResource> cls) {

api/src/main/java/io/strimzi/api/kafka/model/bridge/KafkaBridgeHttpConfig.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ public class KafkaBridgeHttpConfig implements UnknownPropertyPreserving {
3838
private KafkaBridgeHttpCors cors;
3939
private Map<String, Object> additionalProperties;
4040

41-
public KafkaBridgeHttpConfig() {
42-
}
41+
public KafkaBridgeHttpConfig() { }
4342

4443
public KafkaBridgeHttpConfig(int port) {
4544
this.port = port;

api/src/main/java/io/strimzi/api/kafka/model/common/Constants.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
package io.strimzi.api.kafka.model.common;
77

88
public class Constants {
9+
private Constants() { }
10+
911
public static final String RESOURCE_GROUP_NAME = "kafka.strimzi.io";
1012
public static final String RESOURCE_CORE_GROUP_NAME = "core.strimzi.io";
1113

api/src/main/java/io/strimzi/api/kafka/model/common/CustomResourceConditions.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@
3030
* </pre>
3131
*/
3232
public class CustomResourceConditions {
33-
private CustomResourceConditions() {
34-
}
33+
private CustomResourceConditions() { }
3534

3635
/**
3736
* Returns a predicate that determines if CRD is ready. A CRD is

api/src/main/java/io/strimzi/api/kafka/model/common/Probe.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ public class Probe implements UnknownPropertyPreserving {
3535
private Integer failureThreshold;
3636
private Map<String, Object> additionalProperties;
3737

38-
public Probe() {
39-
}
38+
public Probe() { }
4039

4140
public Probe(int initialDelaySeconds, int timeoutSeconds) {
4241
this.initialDelaySeconds = initialDelaySeconds;

api/src/main/java/io/strimzi/api/kafka/model/common/Rack.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ public class Rack implements UnknownPropertyPreserving {
3333
private String topologyKey;
3434
private Map<String, Object> additionalProperties;
3535

36-
public Rack() {
37-
}
36+
public Rack() { }
3837

3938
public Rack(String topologyKey) {
4039
this.topologyKey = topologyKey;

0 commit comments

Comments
 (0)