From 55ff66d98bb362ab85079b5988e63f3f8711e145 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Tue, 4 Jul 2017 12:19:36 +0100 Subject: [PATCH 1/6] EmptyPublicCtorInClass: enable rule --- README.md | 31 +++++++++++++-- builder/src/main/resources/application.yml | 3 +- .../resources/rules/EmptyPublicCtorInClass.md | 25 ++++++++++++ .../regressions/EmptyPublicCtorInClass.java | 38 +++++++++++++++++++ .../net/kemitix/checkstyle-4-tweaks.xml | 1 + .../net/kemitix/checkstyle-5-complexity.xml | 1 + 6 files changed, 93 insertions(+), 6 deletions(-) create mode 100644 builder/src/main/resources/rules/EmptyPublicCtorInClass.md create mode 100644 regressions/src/main/java/net/kemitix/checkstyle/regressions/EmptyPublicCtorInClass.java diff --git a/README.md b/README.md index a58651e..6097cad 100644 --- a/README.md +++ b/README.md @@ -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| @@ -2258,6 +2258,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]+)*$` @@ -2686,9 +2712,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 diff --git a/builder/src/main/resources/application.yml b/builder/src/main/resources/application.yml index e3ef8a4..2afaf9b 100644 --- a/builder/src/main/resources/application.yml +++ b/builder/src/main/resources/application.yml @@ -1433,10 +1433,9 @@ 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 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/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/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml index 08ac646..2f79826 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,7 @@ + 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..57e70ec 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,7 @@ + From 69ee78e50e7e8c6f6e5f7ce6aeecf9f6efc434fc Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Tue, 4 Jul 2017 12:31:12 +0100 Subject: [PATCH 2/6] WhiteSpaceBeforeArrayInitializer: enable rule --- README.md | 23 +++++++++++++++---- builder/src/main/resources/application.yml | 3 +-- .../rules/WhitespaceBeforeArrayInitializer.md | 17 ++++++++++++++ .../net/kemitix/checkstyle-1-layout.xml | 1 + .../net/kemitix/checkstyle-2-naming.xml | 1 + .../net/kemitix/checkstyle-3-javadoc.xml | 1 + .../net/kemitix/checkstyle-4-tweaks.xml | 1 + .../net/kemitix/checkstyle-5-complexity.xml | 1 + 8 files changed, 42 insertions(+), 6 deletions(-) create mode 100644 builder/src/main/resources/rules/WhitespaceBeforeArrayInitializer.md diff --git a/README.md b/README.md index 6097cad..872948b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -2607,6 +2607,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 @@ -2733,8 +2751,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 2afaf9b..5da6e97 100644 --- a/builder/src/main/resources/application.yml +++ b/builder/src/main/resources/application.yml @@ -1496,10 +1496,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/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/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 2f79826..d363925 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml @@ -178,6 +178,7 @@ + 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 57e70ec..4a96257 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml @@ -231,6 +231,7 @@ + From 3fe3d16d42580d647238fb22bba8926af972a035 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Wed, 5 Jul 2017 15:30:33 +0100 Subject: [PATCH 3/6] FinalizeImplementation: enable rule --- README.md | 48 +++++++++++++++++-- builder/src/main/resources/application.yml | 5 +- .../resources/rules/FinalizeImplementation.md | 42 ++++++++++++++++ .../regressions/FinalizeImplementation.java | 39 +++++++++++++++ .../net/kemitix/checkstyle-4-tweaks.xml | 1 + .../net/kemitix/checkstyle-5-complexity.xml | 1 + 6 files changed, 129 insertions(+), 7 deletions(-) create mode 100644 builder/src/main/resources/rules/FinalizeImplementation.md create mode 100644 regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java diff --git a/README.md b/README.md index 872948b..b9b3c75 100644 --- a/README.md +++ b/README.md @@ -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|| @@ -2303,6 +2303,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. @@ -2730,9 +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. -#### [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. diff --git a/builder/src/main/resources/application.yml b/builder/src/main/resources/application.yml index 5da6e97..c77c447 100644 --- a/builder/src/main/resources/application.yml +++ b/builder/src/main/resources/application.yml @@ -1439,11 +1439,10 @@ rules: - 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 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/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..b3b8c44 --- /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({"nofinalizer", "finalizeimplementation"}) + protected void finalize() { + // doesn't call super.finalize() + } + +} 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 d363925..33bebda 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml @@ -178,6 +178,7 @@ + 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 4a96257..dcbdc0a 100644 --- a/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml +++ b/ruleset/src/main/resources/net/kemitix/checkstyle-5-complexity.xml @@ -231,6 +231,7 @@ + From 7b144fdb0ac38f5907b369d42c86c44758b05ebd Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 13 Jul 2017 11:57:44 +0100 Subject: [PATCH 4/6] AvoidDefaultSerializableInInnerClasses: enable rule --- README.md | 8 ++-- builder/src/main/resources/application.yml | 5 +-- .../AvoidDefaultSerializableInInnerClasses.md | 2 + ...voidDefaultSerializableInInnerClasses.java | 41 +++++++++++++++++++ .../net/kemitix/checkstyle-4-tweaks.xml | 1 + .../net/kemitix/checkstyle-5-complexity.xml | 1 + 6 files changed, 51 insertions(+), 7 deletions(-) create mode 100644 builder/src/main/resources/rules/AvoidDefaultSerializableInInnerClasses.md create mode 100644 regressions/src/main/java/net/kemitix/checkstyle/regressions/AvoidDefaultSerializableInInnerClasses.java diff --git a/README.md b/README.md index b9b3c75..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| @@ -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. @@ -2758,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. diff --git a/builder/src/main/resources/application.yml b/builder/src/main/resources/application.yml index c77c447..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 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/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/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml b/ruleset/src/main/resources/net/kemitix/checkstyle-4-tweaks.xml index 33bebda..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,7 @@ + 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 dcbdc0a..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,7 @@ + From 208fcec26fb9d04356bcd12202537d19f21b0ab8 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 13 Jul 2017 12:39:40 +0100 Subject: [PATCH 5/6] ExplicitInitialization: suppress PMD warning --- .../kemitix/checkstyle/regressions/ExplicitInitialization.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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; From a6010126c5207482c19438d94135a8b2b9b700be Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 13 Jul 2017 13:18:44 +0100 Subject: [PATCH 6/6] FinalizeImplementation: suppress PMD warning --- .../kemitix/checkstyle/regressions/FinalizeImplementation.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java b/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java index b3b8c44..738f7de 100644 --- a/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java +++ b/regressions/src/main/java/net/kemitix/checkstyle/regressions/FinalizeImplementation.java @@ -31,7 +31,7 @@ class FinalizeImplementation { /** * Negates effect of superclass finalize. */ - @SuppressWarnings({"nofinalizer", "finalizeimplementation"}) + @SuppressWarnings({"PMD.EmptyFinalizer", "nofinalizer", "finalizeimplementation"}) protected void finalize() { // doesn't call super.finalize() }