From 920e6531305cfaa9ec8a329568646ed4c2adc9b5 Mon Sep 17 00:00:00 2001 From: Mauryan Kansara Date: Tue, 30 Apr 2024 23:06:22 +0530 Subject: [PATCH] Issue #14726: new implementation of the module --- ...llness-optional-interning-suppressions.xml | 7 ++ ...onConstructorsDeclarationGroupingTest.java | 6 +- ...onstructorsDeclarationGroupingRecords.java | 4 - .../ConstructorsDeclarationGroupingCheck.java | 81 ++++++++++++------- .../checks/coding/messages.properties | 2 +- .../checks/coding/messages_fi.properties | 2 +- .../checks/coding/messages_fr.properties | 2 +- .../checks/coding/messages_ja.properties | 2 +- .../checks/coding/messages_pt.properties | 2 +- .../checks/coding/messages_ru.properties | 2 +- .../checks/coding/messages_tr.properties | 2 +- .../checks/coding/messages_zh.properties | 2 +- .../ConstructorsDeclarationGroupingCheck.xml | 4 +- ...structorsDeclarationGroupingCheckTest.java | 59 ++++---------- ...onstructorsDeclarationGroupingRecords.java | 22 ++++- .../InputConstructorsDeclarationGrouping.java | 29 +++++++ .../Example1.java | 2 + .../Example2.java | 3 +- .../constructorsdeclarationgrouping.xml | 12 ++- ...nstructorsdeclarationgrouping.xml.template | 7 +- 20 files changed, 154 insertions(+), 98 deletions(-) diff --git a/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml b/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml index 5604b4e3f15..ca751d51fc6 100644 --- a/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml +++ b/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml @@ -1673,6 +1673,13 @@ + + src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheck.java + dereference.of.nullable + dereference of possibly-null reference previousCtor + firstNonCtorSiblingLineNo = previousCtor.getNextSibling().getLineNo(); + + src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java argument diff --git a/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionConstructorsDeclarationGroupingTest.java b/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionConstructorsDeclarationGroupingTest.java index 6d054d2388c..d5261182476 100644 --- a/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionConstructorsDeclarationGroupingTest.java +++ b/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionConstructorsDeclarationGroupingTest.java @@ -47,7 +47,7 @@ public void testClass() throws Exception { final String[] expectedViolation = { "10:5: " + getCheckMessage(clazz, - ConstructorsDeclarationGroupingCheck.MSG_KEY, 6), + ConstructorsDeclarationGroupingCheck.MSG_KEY, 8), }; final List expectedXpathQueries = Arrays.asList( @@ -79,7 +79,7 @@ public void testEnum() throws Exception { final String[] expectedViolation = { "12:5: " + getCheckMessage(clazz, - ConstructorsDeclarationGroupingCheck.MSG_KEY, 8), + ConstructorsDeclarationGroupingCheck.MSG_KEY, 10), }; final List expectedXpathQueries = Arrays.asList( @@ -112,7 +112,7 @@ public void testRecords() throws Exception { final String[] expectedViolation = { "14:5: " + getCheckMessage(clazz, - ConstructorsDeclarationGroupingCheck.MSG_KEY, 8), + ConstructorsDeclarationGroupingCheck.MSG_KEY, 12), }; final List expectedXpathQueries = Arrays.asList( diff --git a/src/it/resources-noncompilable/org/checkstyle/suppressionxpathfilter/constructorsdeclarationgrouping/InputXpathConstructorsDeclarationGroupingRecords.java b/src/it/resources-noncompilable/org/checkstyle/suppressionxpathfilter/constructorsdeclarationgrouping/InputXpathConstructorsDeclarationGroupingRecords.java index 818f7d880d0..bf12fe5fd82 100644 --- a/src/it/resources-noncompilable/org/checkstyle/suppressionxpathfilter/constructorsdeclarationgrouping/InputXpathConstructorsDeclarationGroupingRecords.java +++ b/src/it/resources-noncompilable/org/checkstyle/suppressionxpathfilter/constructorsdeclarationgrouping/InputXpathConstructorsDeclarationGroupingRecords.java @@ -12,9 +12,5 @@ public MyRecord(int a) { void foo() {} public MyRecord {} // warn - - public MyRecord(int x, int y, int z) { - this(x+y, z); - } } } diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheck.java index 92cf5f007e4..4830c37e41e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheck.java @@ -19,20 +19,20 @@ package com.puppycrawl.tools.checkstyle.checks.coding; -import java.util.HashMap; -import java.util.Map; - -import com.puppycrawl.tools.checkstyle.FileStatefulCheck; +import com.puppycrawl.tools.checkstyle.StatelessCheck; import com.puppycrawl.tools.checkstyle.api.AbstractCheck; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; +import com.puppycrawl.tools.checkstyle.utils.TokenUtil; /** *

* Checks that all constructors are grouped together. * If there is any code between the constructors * then this check will give an error. - * Comments between constructors are ignored. + * The check identifies and flags any constructors that are not grouped together. + * The error message will specify the line number from where the constructors are separated. + * Comments between constructors are allowed. *

*

* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker} @@ -46,10 +46,10 @@ * * * - * @since 10.16.0 + * @since 10.17.0 */ -@FileStatefulCheck +@StatelessCheck public class ConstructorsDeclarationGroupingCheck extends AbstractCheck { /** @@ -58,11 +58,6 @@ public class ConstructorsDeclarationGroupingCheck extends AbstractCheck { */ public static final String MSG_KEY = "constructors.declaration.grouping"; - /** - * Specifies different Object Blocks scope. - */ - private final Map allObjBlocks = new HashMap<>(); - @Override public int[] getDefaultTokens() { return getRequiredTokens(); @@ -76,35 +71,59 @@ public int[] getAcceptableTokens() { @Override public int[] getRequiredTokens() { return new int[] { - TokenTypes.CTOR_DEF, - TokenTypes.COMPACT_CTOR_DEF, + TokenTypes.OBJBLOCK, }; } @Override - public void beginTree(DetailAST rootAst) { - allObjBlocks.clear(); + public void visitToken(DetailAST ast) { + final int parentType = ast.getParent().getType(); + + final int[] tokenTypes = { + TokenTypes.CLASS_DEF, + TokenTypes.ENUM_DEF, + TokenTypes.RECORD_DEF, + }; + + if (TokenUtil.isOfType(parentType, tokenTypes)) { + checkConstructorsGrouping(ast); + } } - @Override - public void visitToken(DetailAST ast) { - final DetailAST currObjBlock = ast.getParent(); - final Integer previousCtorLineNo = allObjBlocks.get(currObjBlock); + /** + * Checks that if constructors are grouped together, they should not be + * separated from each other. + * + * @param objectBlock is a class, enum or record block. + */ + private void checkConstructorsGrouping(DetailAST objectBlock) { + DetailAST currentToken = objectBlock.getFirstChild(); + DetailAST previousCtor = null; + int firstNonCtorSiblingLineNo = -1; + boolean ctorOccured = false; + boolean isViolation = false; + + while (currentToken != null) { + if (currentToken.getType() == TokenTypes.CTOR_DEF + || currentToken.getType() == TokenTypes.COMPACT_CTOR_DEF) { + final DetailAST previousSibling = currentToken.getPreviousSibling(); + final boolean isCtor = previousSibling.getType() == TokenTypes.CTOR_DEF + || previousSibling.getType() == TokenTypes.COMPACT_CTOR_DEF; - if (previousCtorLineNo != null) { - final DetailAST previousSibling = ast.getPreviousSibling(); - final int siblingType = previousSibling.getType(); - final boolean isCtor = siblingType == TokenTypes.CTOR_DEF; - final boolean isCompactCtor = siblingType == TokenTypes.COMPACT_CTOR_DEF; + if (ctorOccured && !isViolation && !isCtor) { + firstNonCtorSiblingLineNo = previousCtor.getNextSibling().getLineNo(); + isViolation = true; + } - if (!isCtor && !isCompactCtor) { - log(ast, MSG_KEY, previousCtorLineNo); + if (isViolation) { + log(currentToken, MSG_KEY, firstNonCtorSiblingLineNo); + } + + previousCtor = currentToken; + ctorOccured = true; } - allObjBlocks.put(currObjBlock, ast.getLineNo()); - } - else { - allObjBlocks.put(currObjBlock, ast.getLineNo()); + currentToken = currentToken.getNextSibling(); } } } diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties index 9944f687eaa..d6a556cf683 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Inner assignments should be avoided. avoid.clone.method=Avoid using clone method. avoid.double.brace.init=Avoid double brace initialization. avoid.finalizer.method=Avoid using finalizer method. -constructors.declaration.grouping=All constructors should be grouped together. Previous constructor was at line number ''{0}''. +constructors.declaration.grouping=All constructors should be grouped together. The constructors got separated at line ''{0}''. covariant.equals=covariant equals without overriding equals(java.lang.Object). declaration.order.access=Variable access definition in wrong order. declaration.order.constructor=Constructor definition in wrong order. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fi.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fi.properties index 5ac6bec22de..074d0ab5aaf 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fi.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fi.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Älä käytä sisäkkäisiä sijoituksia. avoid.clone.method=Vältä klooni menetelmää. avoid.double.brace.init=Vältä kaksinkertaista ahdintuen alustamista. avoid.finalizer.method=Vältä Finalizer menetelmää. -constructors.declaration.grouping=Kaikki rakentajat tulee ryhmitellä yhteen. Edellinen rakentaja oli rivillä ''{0}''. +constructors.declaration.grouping=Kaikki rakentajat tulee ryhmitellä yhteen. Rakentajat erotettiin riviltä ''{0}''. covariant.equals=covariant vastaa ilman painavaa tasavertaisten (java.lang.Object). declaration.order.access=Muuttuja pääsy määritelmä väärässä järjestyksessä. declaration.order.constructor=Rakentaja määritelmä väärässä järjestyksessä. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fr.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fr.properties index b67ce2cbcb1..d4b118e1943 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fr.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_fr.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Évitez d''affecter une valeur à une variable au sein d' avoid.clone.method=Évitez d''utiliser la méthode de clonage. avoid.double.brace.init=Évitez l''initialisation à double accolade. avoid.finalizer.method=Évitez d''utiliser la méthode de finalisation. -constructors.declaration.grouping=Tous les constructeurs doivent être regroupés. Le constructeur précédent se trouvait au numéro de ligne ''{0}''. +constructors.declaration.grouping=Tous les constructeurs doivent être regroupés. Les constructeurs ont été séparés à la ligne ''{0}''. covariant.equals=Votre méthode equals compare uniquement les objets de votre classe. N''oubliez pas de surcharger la méthode equals(java.lang.Object). declaration.order.access=La définition des variables n''est pas triée suivant leur portée. declaration.order.constructor=La définition des constructeurs n''apparaît pas dans le bon ordre. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ja.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ja.properties index 11e5ecbbab5..8b18e44d389 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ja.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ja.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=式内部での代入は避けるべきです。 avoid.clone.method=cloneメソッドを使用しないでください。 avoid.double.brace.init=二重中括弧を使った初期化は使用しないでください。 avoid.finalizer.method=ファイナライザメソッドを使用しないでください。 -constructors.declaration.grouping=すべてのコンストラクターはグループ化する必要があります。前のコンストラクターは行番号 ''{0}'' にありました。 +constructors.declaration.grouping=すべてのコンストラクターはグループ化する必要があります。コンストラクターは行 ''{0}'' で分離されました。 covariant.equals=equals(java.lang.Object) をオーバーライドせずに共変 な equals を定義しています。 declaration.order.access=変数アクセスの定義順序が間違っています。 declaration.order.constructor=コンストラクタの定義順序が間違っています。 diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_pt.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_pt.properties index 49f5ec71b56..814399104a4 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_pt.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_pt.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Atribuições aninhadas devem ser evitadas. avoid.clone.method=Evite o uso do método ''clone()''. avoid.double.brace.init=Evite a inicialização entre chaves. avoid.finalizer.method=Evite o uso do método ''finalize()''. -constructors.declaration.grouping=Todos os construtores devem ser agrupados. O construtor anterior estava no número de linha ''{0}''. +constructors.declaration.grouping=Todos os construtores devem ser agrupados. Os construtores foram separados na linha ''{0}''. covariant.equals="equals" covariante sem sobrescrever ''equals(java.lang.Object)''. declaration.order.access=Definição de acesso a variável em ordem errada. declaration.order.constructor=Definição de construtor em ordem errada. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ru.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ru.properties index 0fb299843bb..2d82157b976 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ru.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_ru.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Внутренние присвоения следует avoid.clone.method=Избегайте использования метода clone(). avoid.double.brace.init=Избегайте инициализации в двойных скобках. avoid.finalizer.method=Избегайте использования метода finalize(). -constructors.declaration.grouping=Все конструкторы должны быть сгруппированы вместе. Предыдущий конструктор находился на строке с номером ''{0}''. +constructors.declaration.grouping=Все конструкторы должны быть сгруппированы вместе. Конструкторы разделились на строке ''{0}''. covariant.equals=Ковариантный equals() без переопределения equals(java.lang.Object). declaration.order.access=Объявляйте переменные в порядке расширения доступа. declaration.order.constructor=Определение конструктора в неправильном порядке. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_tr.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_tr.properties index a16b83dc898..69a12e5439d 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_tr.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_tr.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=Dahili atamalar kullanılmamalıdır. avoid.clone.method=''clone'' metodu kullanılmamalıdır. avoid.double.brace.init=Çift ayraç başlatmadan kaçının. avoid.finalizer.method=''finalize'' metodu kullanılmamalıdır. -constructors.declaration.grouping=Tüm kurucular birlikte gruplandırılmalıdır. Önceki kurucu ''{0}'' satır numarasındaydı. +constructors.declaration.grouping=Tüm kurucular birlikte gruplandırılmalıdır. Yapıcılar ''{0}'' satırında ayrıldı. covariant.equals=java.lang.Object sınıfının ''equals'' metodundan başka bir ''equals'' metodu tanımlanmış, java.lang.Object sınıfından gelen ''equals'' metodu da ezilmelidir (override). declaration.order.access=Değişken, erişim seviyesine göre yanlış sırada tanımlanmış. declaration.order.constructor=''constructor'' tanımı yanlış sırada yapılmış. diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_zh.properties b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_zh.properties index d546d9db9dd..0fb96343fd1 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_zh.properties +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/checks/coding/messages_zh.properties @@ -3,7 +3,7 @@ assignment.inner.avoid=应避免在子表达式中赋值。 avoid.clone.method=避免重写 clone 方法。 avoid.double.brace.init=避免双括号初始化。 avoid.finalizer.method=避免重写finalize方法。 -constructors.declaration.grouping=所有构造函数应该组合在一起。先前的构造函数位于行号''{0}'' +constructors.declaration.grouping=所有构造函数应该组合在一起。构造函数在''{0}''行处分开。 covariant.equals=重写''equals()''方法时，必须确保重写了''equals(java.lang.Object)''方法。 declaration.order.access=属性访问器定义顺序错误。 declaration.order.constructor=构造器定义顺序错误。 diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/coding/ConstructorsDeclarationGroupingCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/coding/ConstructorsDeclarationGroupingCheck.xml index 4cd256e79bb..0063101a278 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/coding/ConstructorsDeclarationGroupingCheck.xml +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/coding/ConstructorsDeclarationGroupingCheck.xml @@ -8,7 +8,9 @@ Checks that all constructors are grouped together. If there is any code between the constructors then this check will give an error. - Comments between constructors are ignored. + The check identifies and flags any constructors that are not grouped together. + The error message will specify the line number from where the constructors are separated. + Comments between constructors are allowed. </p> diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheckTest.java index 2b55af8b1bb..effaaac8721 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ConstructorsDeclarationGroupingCheckTest.java @@ -22,17 +22,9 @@ import static com.google.common.truth.Truth.assertWithMessage; import static com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck.MSG_KEY; -import java.io.File; -import java.util.Map; -import java.util.Optional; - import org.junit.jupiter.api.Test; import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport; -import com.puppycrawl.tools.checkstyle.JavaParser; -import com.puppycrawl.tools.checkstyle.api.DetailAST; -import com.puppycrawl.tools.checkstyle.api.TokenTypes; -import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil; public class ConstructorsDeclarationGroupingCheckTest extends AbstractModuleTestSupport { @Override @@ -43,12 +35,17 @@ protected String getPackageLocation() { @Test public void testDefault() throws Exception { final String[] expected = { - "23:5: " + getCheckMessage(MSG_KEY, 19), - "27:5: " + getCheckMessage(MSG_KEY, 23), - "41:9: " + getCheckMessage(MSG_KEY, 37), - "50:13: " + getCheckMessage(MSG_KEY, 44), - "53:9: " + getCheckMessage(MSG_KEY, 41), - "56:5: " + getCheckMessage(MSG_KEY, 27), + "23:5: " + getCheckMessage(MSG_KEY, 21), + "27:5: " + getCheckMessage(MSG_KEY, 21), + "43:9: " + getCheckMessage(MSG_KEY, 39), + "52:13: " + getCheckMessage(MSG_KEY, 48), + "55:9: " + getCheckMessage(MSG_KEY, 39), + "58:5: " + getCheckMessage(MSG_KEY, 21), + "60:5: " + getCheckMessage(MSG_KEY, 21), + "78:7: " + getCheckMessage(MSG_KEY, 76), + "82:7: " + getCheckMessage(MSG_KEY, 76), + "84:7: " + getCheckMessage(MSG_KEY, 76), + "87:5: " + getCheckMessage(MSG_KEY, 21), }; verifyWithInlineConfigParser( getPath("InputConstructorsDeclarationGrouping.java"), expected); @@ -58,8 +55,10 @@ public void testDefault() throws Exception { public void testConstructorsDeclarationGroupingRecords() throws Exception { final String[] expected = { - "18:9: " + getCheckMessage(MSG_KEY, 12), - "34:9: " + getCheckMessage(MSG_KEY, 30), + "20:9: " + getCheckMessage(MSG_KEY, 16), + "22:9: " + getCheckMessage(MSG_KEY, 16), + "26:9: " + getCheckMessage(MSG_KEY, 16), + "42:9: " + getCheckMessage(MSG_KEY, 38), }; verifyWithInlineConfigParser( @@ -82,32 +81,4 @@ public void testTokensNotNull() { .isNotNull(); } - /** - * We cannot reproduce situation when visitToken is called and leaveToken is not. - * So, we have to use reflection to be sure that even in such situation - * state of the field will be cleared. - * - * @throws Exception when code tested throws exception - */ - @Test - @SuppressWarnings("unchecked") - public void testClearState() throws Exception { - final ConstructorsDeclarationGroupingCheck check = - new ConstructorsDeclarationGroupingCheck(); - final Optional ctorDef = TestUtil.findTokenInAstByPredicate( - JavaParser.parseFile(new File(getNonCompilablePath( - "InputConstructorsDeclarationGroupingRecords.java")), - JavaParser.Options.WITHOUT_COMMENTS), - ast -> ast.getType() == TokenTypes.CTOR_DEF); - - assertWithMessage("Ast should contain CTOR_DEF") - .that(ctorDef.isPresent()) - .isTrue(); - assertWithMessage("State is not cleared on beginTree") - .that(TestUtil.isStatefulFieldClearedDuringBeginTree(check, ctorDef.get(), - "allObjBlocks", - allObjBlocks -> ((Map) allObjBlocks).isEmpty())) - .isTrue(); - } - } diff --git a/src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGroupingRecords.java b/src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGroupingRecords.java index eff55817be6..5a0a8bd8d11 100644 --- a/src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGroupingRecords.java +++ b/src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGroupingRecords.java @@ -15,9 +15,15 @@ public MyRecord1(int a) { void foo() {} + void foo2() {} + public MyRecord1 {} // violation - public MyRecord1(int x, int y, int z) { + public MyRecord1(int a, int b, int c, int d) { // violation + this(a+b, c+d); + } + + public MyRecord1(int x, int y, int z) { // violation this(x+y, z); } } @@ -31,6 +37,20 @@ class MyClass { String[] str; + String[] str2; + MyClass(int a) {} // violation } + + public record MyRecord4(double d) { + public MyRecord4(double d) { + this(d); + } + + public MyRecord4 {} + + public MyRecord4(double a, double b) { + this(a+b); + } + } } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGrouping.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGrouping.java index f567fbc207f..f8cd5f4bfb9 100644 --- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGrouping.java +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/InputConstructorsDeclarationGrouping.java @@ -38,6 +38,8 @@ private enum Testing { String str; + String str2; + Testing(int x) {} // violation private abstract class Inner { @@ -55,6 +57,8 @@ private abstract class Inner { InputConstructorsDeclarationGrouping(float x) {} // violation + InputConstructorsDeclarationGrouping(long l) {} // violation + private class Inner { Inner() {} @@ -64,4 +68,29 @@ private class Inner { Inner(int x) {} } + private class Inner2 { + Inner2() {} + + Inner2(String str) {} + + int x; + + Inner2(int x) {} // violation + + String xx; + + Inner2(double d) {} // violation + + Inner2(float f) {} // violation + } + + InputConstructorsDeclarationGrouping(long l, double d) {} // violation + + InputConstructorsDeclarationGrouping annoynmous = new InputConstructorsDeclarationGrouping() { + int x; + + void test() {} + + void test2() {} + }; } diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example1.java b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example1.java index f9033c2fd1a..c9d43ffae3e 100644 --- a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example1.java +++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example1.java @@ -10,6 +10,7 @@ // xdoc section -- start public class Example1 { + int x; Example1() {} @@ -24,6 +25,7 @@ public class Example1 { void foo() {} private enum ExampleEnum { + ONE, TWO, THREE; ExampleEnum() {} diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example2.java b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example2.java index c6b4e402e4c..bd3c517e134 100644 --- a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example2.java +++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/coding/constructorsdeclarationgrouping/Example2.java @@ -21,9 +21,10 @@ void foo() {} Example2(int x) {} // violation - Example2(String s, int x) {} + Example2(String s, int x) {} // violation private enum ExampleEnum { + ONE, TWO, THREE; ExampleEnum() {} diff --git a/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml b/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml index 6f33d5b399b..8b07a43c618 100644 --- a/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml +++ b/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml @@ -7,13 +7,16 @@

-

Since Checkstyle 10.16.0

+

Since Checkstyle 10.17.0

Checks that all constructors are grouped together. If there is any code between the constructors then this check will give an error. - Comments between constructors are ignored. + The check identifies and flags any constructors that are not grouped together. + The error message will specify the line number + from where the constructors are separated. + Comments between constructors are allowed.

@@ -29,6 +32,7 @@

Example of correct grouping of constructors:

public class Example1 { + int x; Example1() {} @@ -43,6 +47,7 @@ public class Example1 { void foo() {} private enum ExampleEnum { + ONE, TWO, THREE; ExampleEnum() {} @@ -71,9 +76,10 @@ public class Example2 { Example2(int x) {} // violation - Example2(String s, int x) {} + Example2(String s, int x) {} // violation private enum ExampleEnum { + ONE, TWO, THREE; ExampleEnum() {} diff --git a/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml.template b/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml.template index 90de2bbf3ba..05acdd03d1d 100644 --- a/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml.template +++ b/src/xdocs/checks/coding/constructorsdeclarationgrouping.xml.template @@ -7,13 +7,16 @@
-

Since Checkstyle 10.16.0

+

Since Checkstyle 10.17.0

Checks that all constructors are grouped together. If there is any code between the constructors then this check will give an error. - Comments between constructors are ignored. + The check identifies and flags any constructors that are not grouped together. + The error message will specify the line number + from where the constructors are separated. + Comments between constructors are allowed.