diff --git a/README.md b/README.md index a58651e..1475469 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Rule|Level|Source|Enabled|Suppressible [AtclauseOrder](#atclauseorder)|javadoc|checkstyle|Yes| [AvoidConditionInversion](#avoidconditioninversion)|complexity|sevntu|| [AvoidConstantAsFirstOperandInCondition](#avoidconstantasfirstoperandincondition)|tweaks|sevntu|Yes| -[AvoidDefaultSerializableInInnerClasses](#avoiddefaultserializableininnerclasses)|complexity|sevntu|| +[AvoidDefaultSerializableInInnerClasses](#avoiddefaultserializableininnerclasses)|tweaks|sevntu|Yes| [AvoidEscapedUnicodeCharacters](#avoidescapedunicodecharacters)|tweaks|checkstyle|Yes| [AvoidHidingCauseException](#avoidhidingcauseexception)|tweaks|sevntu|Yes| [AvoidInlineConditionals](#avoidinlineconditionals)|complexity|checkstyle|Yes| @@ -116,7 +116,7 @@ Rule|Level|Source|Enabled|Suppressible [EmptyForInitializerPad](#emptyforinitializerpad)|layout|checkstyle|Yes| [EmptyForIteratorPad](#emptyforiteratorpad)|layout|checkstyle|Yes| [EmptyLineSeparator](#emptylineseparator)|layout|checkstyle|Yes| -[EmptyPublicCtorInClass](#emptypublicctorinclass)|tweaks|sevntu|| +[EmptyPublicCtorInClass](#emptypublicctorinclass)|tweaks|sevntu|Yes| [EmptyStatement](#emptystatement)|layout|checkstyle|Yes| [EnumValueName](#enumvaluename)|naming|sevntu|Yes| [EqualsAvoidNull](#equalsavoidnull)|tweaks|checkstyle|Yes| @@ -127,7 +127,7 @@ Rule|Level|Source|Enabled|Suppressible [FileLength](#filelength)|complexity|checkstyle|Yes| [FileTabCharacter](#filetabcharacter)|layout|checkstyle|Yes| [FinalClass](#finalclass)|complexity|checkstyle|Yes| -[FinalizeImplementation](#finalizeimplementation)|unspecified|sevntu|| +[FinalizeImplementation](#finalizeimplementation)|tweaks|sevntu|Yes| [FinalLocalVariable](#finallocalvariable)|tweaks|checkstyle|| [FinalParameters](#finalparameters)|tweaks|checkstyle|Yes| [ForbidAnnotation](#forbidannotation)|unspecified|sevntu|| @@ -268,7 +268,7 @@ Rule|Level|Source|Enabled|Suppressible [VisibilityModifier](#visibilitymodifier)|tweaks|checkstyle|Yes|No [WhitespaceAfter](#whitespaceafter)|layout|checkstyle|Yes| [WhitespaceAround](#whitespacearound)|layout|checkstyle|Yes| -[WhitespaceBeforeArrayInitializer](#whitespacebeforearrayinitializer)|layout|sevntu|| +[WhitespaceBeforeArrayInitializer](#whitespacebeforearrayinitializer)|layout|sevntu|Yes| [WriteTag](#writetag)|unspecified|checkstyle|| ## Enabled Checks @@ -2182,6 +2182,9 @@ Invalid: ```` if (12 == a) {} ```` +#### [AvoidDefaultSerializableInInnerClasses](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.html) + +Prevent the use of default serialization methods on inner classes. If an inner class needs to implement the Serializable interface, then it *must* implement both `writeObject()` and `readObject()` methods. #### [AvoidHidingCauseException](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidHidingCauseExceptionCheck.html) Ensures that an exception is re-thrown properly and is not swallowed by a `catch` block. @@ -2258,6 +2261,32 @@ Map idTable = new HashMap(); Checks that when an exception is caught, that if it is logged then it is not also re-thrown. Log or throw; one or the other or neither, but not both. Accepts `java.util.logging.Logger` and `org.slf4j.Logger`. +#### [EmptyPublicCtorInClass](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/EmptyPublicCtorInClassCheck.html) + +This Check looks for useless empty public constructors. Class constructor is considered useless by this Check if and only if class has exactly one ctor, which is public, empty(one that has no statements) and default. + +Valid: +````java +class ValidPrivateCtor { + private ValidPrivateCtor() { + } +} + +class ValidOverloadedCtor { + public ValidOverloadedCtor() { + } + public ValidOverloadedCtor(int i) { + } +} +```` + +Invalid: +````java +class Invalid { + public Invalid() { + } +} +```` #### [EnumValueName](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/naming/EnumValueNameCheck.html) Checks that Enum Values match the pattern: `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$` @@ -2277,6 +2306,49 @@ enum InvalidConstants { alpha, Beta; } ```` +#### [FinalizeImplementation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html) + +Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation. + +Valid: +```java +class Valid { + protected void finalize() { + try { + doSomething(); + } finally { + super.finalize(); + } + } +} +``` + +Invalid: +```java +class InvalidNoEffect1 { + protected void finalize() { + } +} +class InvalidNoEffect2 { + protected void finalize() { + doSomething(); + } +} +class InvalidUseless { + protected void finalize() { + super.finalize(); + } +} +class InvalidPublic { + public void finalize() { + try { + doSomething(); + } finally { + super.finalize(); + } + } +} +``` #### [ForbidCCommentsInMethods](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/ForbidCCommentsInMethodsCheck.html) Prevents the use of `/* C-style */` comments inside methods. @@ -2581,6 +2653,24 @@ class Derived extends Base { } } ```` +#### [WhitespaceBeforeArrayInitializer](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/WhitespaceBeforeArrayInitializerCheck.html) + +This checks enforces whitespace before array initializer. + +Valid: +````java +int[] ints = new int[] { + 0, 1, 2, 3 +}; + +int[] tab = new int[] + {0, 1, 2, 3}; +```` + +Invalid: +````java +int[] ints = new int[]{0, 1, 2, 3}; +```` ## Disabled Checks @@ -2671,9 +2761,6 @@ As the sevntu check are considered experimental not all those that are not enabl #### [AvoidConditionInversion](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/AvoidConditionInversionCheck.html) Should already be covered by [SimplifyBooleanExpression](simplifybooleanexpression). -#### [AvoidDefaultSerializableInInnerClasses](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.html) - -TODO: enable #### [AvoidModifiersForTypes](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidModifiersForTypesCheck.html) Generic rule; doesn't embody a 'quality' check. @@ -2686,12 +2773,6 @@ Appears to be broken as of `1.21.0`. #### [CustomDeclarationOrder](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/CustomDeclarationOrderCheck.html) The [DeclarationOrder](#declarationorder) check already imposes an order for class elements. -#### [EmptyPublicCtorInClass](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/EmptyPublicCtorInClassCheck.html) - -TODO: enable -#### [FinalizeImplementation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html) - -TODO: enable #### [ForbidAnnotation](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.html) Generic rule; doesn't embody a 'quality' check. @@ -2710,8 +2791,5 @@ Generic rule; doesn't embody a 'quality' check. #### [StaticMethodCandidate](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/design/StaticMethodCandidateCheck.html) Can't handle private methods called by reflection, which may cause issues with Spring and other DI frameworks. -#### [WhitespaceBeforeArrayInitializer](http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/WhitespaceBeforeArrayInitializerCheck.html) - -TODO: enable [Effective Java]: http://amzn.to/2aSz6GE \ No newline at end of file diff --git a/builder/src/main/resources/application.yml b/builder/src/main/resources/application.yml index e3ef8a4..b6f3195 100644 --- a/builder/src/main/resources/application.yml +++ b/builder/src/main/resources/application.yml @@ -1392,11 +1392,10 @@ rules: - name: AvoidDefaultSerializableInInnerClasses parent: TREEWALKER - level: COMPLEXITY - enabled: false + level: TWEAKS + enabled: true source: SEVNTU uri: http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.html - reason: "TODO: enable" - name: AvoidModifiersForTypes parent: TREEWALKER @@ -1433,18 +1432,16 @@ rules: name: EmptyPublicCtorInClass parent: TREEWALKER level: TWEAKS - enabled: false + enabled: true source: SEVNTU uri: http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/EmptyPublicCtorInClassCheck.html - reason: "TODO: enable" - name: FinalizeImplementation parent: TREEWALKER - level: - enabled: false + level: TWEAKS + enabled: true source: SEVNTU uri: http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/FinalizeImplementationCheck.html - reason: "TODO: enable" - name: ForbidAnnotation parent: TREEWALKER @@ -1497,10 +1494,9 @@ rules: name: WhitespaceBeforeArrayInitializer parent: TREEWALKER level: LAYOUT - enabled: false + enabled: true source: SEVNTU uri: http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/coding/WhitespaceBeforeArrayInitializerCheck.html - reason: "TODO: enable" - name: MoveVariableInsideIfCheck parent: TREEWALKER diff --git a/builder/src/main/resources/rules/AvoidDefaultSerializableInInnerClasses.md b/builder/src/main/resources/rules/AvoidDefaultSerializableInInnerClasses.md new file mode 100644 index 0000000..db09462 --- /dev/null +++ b/builder/src/main/resources/rules/AvoidDefaultSerializableInInnerClasses.md @@ -0,0 +1,2 @@ + +Prevent the use of default serialization methods on inner classes. If an inner class needs to implement the Serializable interface, then it *must* implement both `writeObject()` and `readObject()` methods. diff --git a/builder/src/main/resources/rules/EmptyPublicCtorInClass.md b/builder/src/main/resources/rules/EmptyPublicCtorInClass.md new file mode 100644 index 0000000..52c7674 --- /dev/null +++ b/builder/src/main/resources/rules/EmptyPublicCtorInClass.md @@ -0,0 +1,25 @@ + +This Check looks for useless empty public constructors. Class constructor is considered useless by this Check if and only if class has exactly one ctor, which is public, empty(one that has no statements) and default. + +Valid: +````java +class ValidPrivateCtor { + private ValidPrivateCtor() { + } +} + +class ValidOverloadedCtor { + public ValidOverloadedCtor() { + } + public ValidOverloadedCtor(int i) { + } +} +```` + +Invalid: +````java +class Invalid { + public Invalid() { + } +} +```` diff --git a/builder/src/main/resources/rules/FinalizeImplementation.md b/builder/src/main/resources/rules/FinalizeImplementation.md new file mode 100644 index 0000000..323e07e --- /dev/null +++ b/builder/src/main/resources/rules/FinalizeImplementation.md @@ -0,0 +1,42 @@ + +Checks that the `finalize()` implementation doesn't ignore the base class implementation, and doesn't *only* call the base class implementation. + +Valid: +```java +class Valid { + protected void finalize() { + try { + doSomething(); + } finally { + super.finalize(); + } + } +} +``` + +Invalid: +```java +class InvalidNoEffect1 { + protected void finalize() { + } +} +class InvalidNoEffect2 { + protected void finalize() { + doSomething(); + } +} +class InvalidUseless { + protected void finalize() { + super.finalize(); + } +} +class InvalidPublic { + public void finalize() { + try { + doSomething(); + } finally { + super.finalize(); + } + } +} +``` diff --git a/builder/src/main/resources/rules/WhitespaceBeforeArrayInitializer.md b/builder/src/main/resources/rules/WhitespaceBeforeArrayInitializer.md new file mode 100644 index 0000000..75703f6 --- /dev/null +++ b/builder/src/main/resources/rules/WhitespaceBeforeArrayInitializer.md @@ -0,0 +1,17 @@ + +This checks enforces whitespace before array initializer. + +Valid: +````java +int[] ints = new int[] { + 0, 1, 2, 3 +}; + +int[] tab = new int[] + {0, 1, 2, 3}; +```` + +Invalid: +````java +int[] ints = new int[]{0, 1, 2, 3}; +```` diff --git a/regressions/src/main/java/net/kemitix/checkstyle/regressions/AvoidDefaultSerializableInInnerClasses.java b/regressions/src/main/java/net/kemitix/checkstyle/regressions/AvoidDefaultSerializableInInnerClasses.java new file mode 100644 index 0000000..1ac2c72 --- /dev/null +++ b/regressions/src/main/java/net/kemitix/checkstyle/regressions/AvoidDefaultSerializableInInnerClasses.java @@ -0,0 +1,41 @@ +/** + * The MIT License (MIT) + * + * Copyright (c) 2017 Paul Campbell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies + * or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE + * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +package net.kemitix.checkstyle.regressions; + +import java.io.Serializable; + +/** + * Regression test for {@code AvoidDefaultSerializableInInnerClasses}. + * + * @author Paul Campbell (pcampbell@kemitix.net) + */ +public class AvoidDefaultSerializableInInnerClasses { + + /** + * Inner class should not use default implementations of {@code readObject()} and {@code writeObject()}. + */ + @SuppressWarnings("avoiddefaultserializableininnerclasses") + public class InnerClass implements Serializable { + + } + +} diff --git a/regressions/src/main/java/net/kemitix/checkstyle/regressions/EmptyPublicCtorInClass.java b/regressions/src/main/java/net/kemitix/checkstyle/regressions/EmptyPublicCtorInClass.java new file mode 100644 index 0000000..1ce63b0 --- /dev/null +++ b/regressions/src/main/java/net/kemitix/checkstyle/regressions/EmptyPublicCtorInClass.java @@ -0,0 +1,38 @@ +/** + * The MIT License (MIT) + * + * Copyright (c) 2017 Paul Campbell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies + * or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE + * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +package net.kemitix.checkstyle.regressions; + +/** + * Regression demo for {@code EmptyPublicCtorInClassCheck}. + * + * @author Paul Campbell (pcampbell@kemitix.net) + */ +public class EmptyPublicCtorInClass { + + /** + * Useless empty public constructors. + */ + @SuppressWarnings("emptypublicctorinclass") + EmptyPublicCtorInClass() { + } + +} diff --git a/regressions/src/main/java/net/kemitix/checkstyle/regressions/ExplicitInitialization.java b/regressions/src/main/java/net/kemitix/checkstyle/regressions/ExplicitInitialization.java index d2987c1..8742195 100644 --- a/regressions/src/main/java/net/kemitix/checkstyle/regressions/ExplicitInitialization.java +++ b/regressions/src/main/java/net/kemitix/checkstyle/regressions/ExplicitInitialization.java @@ -26,7 +26,7 @@ package net.kemitix.checkstyle.regressions; * * @author Paul Campbell (pcampbell@kemitix.net). */ -@SuppressWarnings("hideutilityclassconstructor") +@SuppressWarnings({"hideutilityclassconstructor", "PMD.UnusedPrivateField"}) class ExplicitInitialization { private boolean validBoolean = false; diff --git a/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java b/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java new file mode 100644 index 0000000..738f7de --- /dev/null +++ b/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java @@ -0,0 +1,39 @@ +/** + * The MIT License (MIT) + * + * Copyright (c) 2017 Paul Campbell + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies + * or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE + * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +package net.kemitix.checkstyle.regressions; + +/** + * Regression test for {@code FinalizeImplementationCheck}. + * + * @author Paul Campbell pcampbell@kemitix.net + */ +class FinalizeImplementation { + + /** + * Negates effect of superclass finalize. + */ + @SuppressWarnings({"PMD.EmptyFinalizer", "nofinalizer", "finalizeimplementation"}) + protected void finalize() { + // doesn't call super.finalize() + } + +} diff --git a/ruleset/src/main/resources/net/kemitix/checkstyle-1-layout.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-1-layout.xml index dcb2199..8b69e34 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-1-layout.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-1-layout.xml @@ -59,6 +59,7 @@ + diff --git a/ruleset/src/main/resources/net/kemitix/checkstyle-2-naming.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-2-naming.xml index a4a70a0..330545e 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-2-naming.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-2-naming.xml @@ -91,6 +91,7 @@ + diff --git a/ruleset/src/main/resources/net/kemitix/checkstyle-3-javadoc.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-3-javadoc.xml index 5536268..00f2043 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-3-javadoc.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-3-javadoc.xml @@ -117,6 +117,7 @@ + diff --git a/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml index 08ac646..0358887 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml @@ -177,6 +177,10 @@ + + + + diff --git a/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml index 95ead8f..e3a5f44 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml @@ -230,6 +230,10 @@ + + + +