diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/ArrayTypeStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/ArrayTypeStyleCheck.java index 742de3fc1..3db654edc 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/ArrayTypeStyleCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/ArrayTypeStyleCheck.java @@ -37,7 +37,7 @@ public class ArrayTypeStyleCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.ARRAY_DECLARATOR}; + return getAcceptableTokens(); } @Override @@ -45,6 +45,11 @@ public class ArrayTypeStyleCheck extends Check { return new int[] {TokenTypes.ARRAY_DECLARATOR}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final DetailAST typeAST = ast.getParent(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AvoidEscapedUnicodeCharactersCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AvoidEscapedUnicodeCharactersCheck.java index 777ad784d..4954254d2 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AvoidEscapedUnicodeCharactersCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AvoidEscapedUnicodeCharactersCheck.java @@ -192,7 +192,7 @@ public class AvoidEscapedUnicodeCharactersCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.STRING_LITERAL, TokenTypes.CHAR_LITERAL}; + return getAcceptableTokens(); } @Override @@ -200,6 +200,11 @@ public class AvoidEscapedUnicodeCharactersCheck return new int[] {TokenTypes.STRING_LITERAL, TokenTypes.CHAR_LITERAL}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java index b97076092..73b539df0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java @@ -220,6 +220,11 @@ public class DescendantTokenCheck extends Check { return ArrayUtils.EMPTY_INT_ARRAY; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { //reset counts diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/FileContentsHolder.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/FileContentsHolder.java index eaaa2d5e5..e1000c086 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/FileContentsHolder.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/FileContentsHolder.java @@ -44,9 +44,19 @@ public class FileContentsHolder @Override public int[] getDefaultTokens() { + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { return ArrayUtils.EMPTY_INT_ARRAY; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST rootAST) { FILE_CONTENTS.set(getFileContents()); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/FinalParametersCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/FinalParametersCheck.java index 23fae8a97..21a82e8c8 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/FinalParametersCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/FinalParametersCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks; import java.util.Set; +import org.apache.commons.lang3.ArrayUtils; + import com.google.common.collect.ImmutableSet; import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -104,6 +106,11 @@ public class FinalParametersCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { // don't flag interfaces diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java index 0a1a99bc1..fb5346243 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java @@ -48,10 +48,7 @@ public class OuterTypeFilenameCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, - TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, - }; + return getAcceptableTokens(); } @Override @@ -62,6 +59,11 @@ public class OuterTypeFilenameCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST ast) { fileName = getFileName(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolder.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolder.java index 8f1248ba8..a0bc3879d 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolder.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/SuppressWarningsHolder.java @@ -168,9 +168,19 @@ public class SuppressWarningsHolder @Override public int[] getDefaultTokens() { + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { return new int[] {TokenTypes.ANNOTATION}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST rootAST) { ENTRIES.set(new LinkedList()); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java index 2966295d7..888dce27c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java @@ -89,7 +89,7 @@ public class TodoCommentCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.COMMENT_CONTENT }; + return getAcceptableTokens(); } @Override @@ -97,6 +97,11 @@ public class TodoCommentCheck return new int[] {TokenTypes.COMMENT_CONTENT }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final String[] lines = ast.getText().split("\n"); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java index d95e79da8..cb713429c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java @@ -133,6 +133,16 @@ public class TrailingCommentCheck extends AbstractFormatCheck { return ArrayUtils.EMPTY_INT_ARRAY; } + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { throw new IllegalStateException("visitToken() shouldn't be called."); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java index 610e126f2..d324b0df2 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java @@ -57,7 +57,7 @@ public class UpperEllCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.NUM_LONG}; + return getAcceptableTokens(); } @Override @@ -65,6 +65,11 @@ public class UpperEllCheck extends Check { return new int[] {TokenTypes.NUM_LONG}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (Utils.endsWithChar(ast.getText(), 'l')) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationLocationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationLocationCheck.java index 5dd3d8328..210e4d70b 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationLocationCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationLocationCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.annotation; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -199,6 +201,11 @@ public class AnnotationLocationCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST modifiersNode = ast.findFirstToken(TokenTypes.MODIFIERS); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java index 8350e88f8..0bd0b2ec3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java @@ -136,6 +136,11 @@ public final class MissingDeprecatedCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(final DetailAST ast) { final TextBlock javadoc = diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java index 451fababa..0c7968ec3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.annotation; import java.util.regex.Matcher; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.AnnotationUtility; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -136,6 +138,11 @@ public class SuppressWarningsCheck extends AbstractFormatCheck { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(final DetailAST ast) { final DetailAST annotation = getSuppressWarnings(ast); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.java index 2cc30c70b..bac9957a4 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.java @@ -100,7 +100,7 @@ public class AvoidNestedBlocksCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.SLIST}; + return getAcceptableTokens(); } @Override @@ -108,6 +108,11 @@ public class AvoidNestedBlocksCheck extends Check { return new int[] {TokenTypes.SLIST}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final DetailAST parent = ast.getParent(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyBlockCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyBlockCheck.java index d9f3b65e9..5f5daa4d9 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyBlockCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyBlockCheck.java @@ -19,6 +19,7 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; +import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -120,6 +121,11 @@ public class EmptyBlockCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST slistToken = ast.findFirstToken(TokenTypes.SLIST); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyCatchBlockCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyCatchBlockCheck.java index a071c1f5c..0662155cf 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyCatchBlockCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyCatchBlockCheck.java @@ -174,9 +174,7 @@ public class EmptyCatchBlockCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.LITERAL_CATCH, - }; + return getAcceptableTokens(); } @Override @@ -186,6 +184,11 @@ public class EmptyCatchBlockCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public boolean isCommentNodesRequired() { return true; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java index 2605ccd39..a2925d098 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -139,26 +141,7 @@ public class LeftCurlyCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, - TokenTypes.ANNOTATION_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.ENUM_CONSTANT_DEF, - TokenTypes.LITERAL_WHILE, - TokenTypes.LITERAL_TRY, - TokenTypes.LITERAL_CATCH, - TokenTypes.LITERAL_FINALLY, - TokenTypes.LITERAL_SYNCHRONIZED, - TokenTypes.LITERAL_SWITCH, - TokenTypes.LITERAL_DO, - TokenTypes.LITERAL_IF, - TokenTypes.LITERAL_ELSE, - TokenTypes.LITERAL_FOR, - TokenTypes.STATIC_INIT, - }; + return getAcceptableTokens(); } @Override @@ -185,6 +168,11 @@ public class LeftCurlyCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { DetailAST startToken; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/NeedBracesCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/NeedBracesCheck.java index 1ff57006b..bc1e5cdb8 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/NeedBracesCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/NeedBracesCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -145,6 +147,11 @@ public class NeedBracesCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST slistAST = ast.findFirstToken(TokenTypes.SLIST); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyCheck.java index 1149e61ec..b18f63160 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.ScopeUtils; import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -150,6 +152,11 @@ public class RightCurlyCheck extends AbstractOptionCheck { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final Details details = getDetails(ast); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodCheck.java index b829ab795..296b493ef 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodCheck.java @@ -46,7 +46,7 @@ public abstract class AbstractIllegalMethodCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF}; + return getAcceptableTokens(); } @Override @@ -54,6 +54,11 @@ public abstract class AbstractIllegalMethodCheck extends Check { return new int[] {TokenTypes.METHOD_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST aAST) { final DetailAST mid = aAST.findFirstToken(TokenTypes.IDENT); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.java index cded73e15..50b09a4d3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.java @@ -49,7 +49,7 @@ public class ArrayTrailingCommaCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.ARRAY_INIT}; + return getAcceptableTokens(); } @Override @@ -57,6 +57,11 @@ public class ArrayTrailingCommaCheck extends Check { return new int[] {TokenTypes.ARRAY_INIT}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST arrayInit) { final DetailAST rcurly = arrayInit.findFirstToken(TokenTypes.RCURLY); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java index 93d28f4a2..ccb4ad938 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java @@ -160,12 +160,7 @@ public class DeclarationOrderCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.CTOR_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.MODIFIERS, - TokenTypes.OBJBLOCK, - }; + return getAcceptableTokens(); } @Override @@ -178,6 +173,11 @@ public class DeclarationOrderCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final int parentType = ast.getParent().getType(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java index 718c9335a..ac4a54b71 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java @@ -52,7 +52,7 @@ public class EmptyStatementCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.EMPTY_STAT}; + return getAcceptableTokens(); } @Override @@ -60,6 +60,11 @@ public class EmptyStatementCheck extends Check { return new int[] {TokenTypes.EMPTY_STAT}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java index 1775281d0..4589b964c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java @@ -67,7 +67,7 @@ public class EqualsHashCodeCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF}; + return getAcceptableTokens(); } @Override @@ -75,6 +75,11 @@ public class EqualsHashCodeCheck return new int[] {TokenTypes.METHOD_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST rootAST) { objBlockEquals.clear(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java index bcf843246..17bf16ecf 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java @@ -149,12 +149,7 @@ public final class IllegalTypeCheck extends AbstractFormatCheck { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.VARIABLE_DEF, - TokenTypes.PARAMETER_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.IMPORT, - }; + return getAcceptableTokens(); } @Override @@ -167,6 +162,11 @@ public final class IllegalTypeCheck extends AbstractFormatCheck { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { switch (ast.getType()) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java index 4c8511c8a..e72f969f9 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java @@ -105,20 +105,7 @@ public class InnerAssignmentCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.ASSIGN, // '=' - TokenTypes.DIV_ASSIGN, // "/=" - TokenTypes.PLUS_ASSIGN, // "+=" - TokenTypes.MINUS_ASSIGN, //"-=" - TokenTypes.STAR_ASSIGN, // "*=" - TokenTypes.MOD_ASSIGN, // "%=" - TokenTypes.SR_ASSIGN, // ">>=" - TokenTypes.BSR_ASSIGN, // ">>>=" - TokenTypes.SL_ASSIGN, // "<<=" - TokenTypes.BXOR_ASSIGN, // "^=" - TokenTypes.BOR_ASSIGN, // "|=" - TokenTypes.BAND_ASSIGN, // "&=" - }; + return getAcceptableTokens(); } @Override @@ -139,6 +126,11 @@ public class InnerAssignmentCheck }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (isInContext(ast, ALLOWED_ASSIGMENT_CONTEXT)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MagicNumberCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MagicNumberCheck.java index 276ffccbf..fc3cec023 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MagicNumberCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MagicNumberCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.coding; import java.util.Arrays; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.ScopeUtils; import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.Check; @@ -200,6 +202,11 @@ public class MagicNumberCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { if (ignoreAnnotation && isChildOf(ast, TokenTypes.ANNOTATION)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCheck.java index 43ff2dac1..ea72bb3c2 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCheck.java @@ -115,7 +115,7 @@ public class MultipleStringLiteralsCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.STRING_LITERAL}; + return getAcceptableTokens(); } @Override @@ -123,6 +123,11 @@ public class MultipleStringLiteralsCheck extends Check { return new int[] {TokenTypes.STRING_LITERAL}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (isInIgnoreOccurrenceContext(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/OverloadMethodsDeclarationOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/OverloadMethodsDeclarationOrderCheck.java index f2bf11728..bc36e4a2c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/OverloadMethodsDeclarationOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/OverloadMethodsDeclarationOrderCheck.java @@ -57,9 +57,7 @@ public class OverloadMethodsDeclarationOrderCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.OBJBLOCK, - }; + return getAcceptableTokens(); } @Override @@ -69,6 +67,11 @@ public class OverloadMethodsDeclarationOrderCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final int parentType = ast.getParent().getType(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityCheck.java index 6d16d12dd..671c79c1e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityCheck.java @@ -47,7 +47,7 @@ public class StringLiteralEqualityCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.EQUAL, TokenTypes.NOT_EQUAL}; + return getAcceptableTokens(); } @Override @@ -55,6 +55,11 @@ public class StringLiteralEqualityCheck extends Check { return new int[] {TokenTypes.EQUAL, TokenTypes.NOT_EQUAL}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { // no need to check for nulls here, == and != always have two children diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java index 3a951bf68..09ef3cdb0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java @@ -246,7 +246,7 @@ public class VariableDeclarationUsageDistanceCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.VARIABLE_DEF}; + return getAcceptableTokens(); } @Override @@ -254,6 +254,11 @@ public class VariableDeclarationUsageDistanceCheck extends Check { return new int[] {TokenTypes.VARIABLE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final int parentType = ast.getParent().getType(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java index 052c82ee6..4e8cef65b 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java @@ -66,7 +66,7 @@ public class DesignForExtensionCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF}; + return getAcceptableTokens(); } @Override @@ -74,6 +74,11 @@ public class DesignForExtensionCheck extends Check { return new int[] {TokenTypes.METHOD_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { // nothing to do for Interfaces diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java index 789a4fc61..7bba62391 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java @@ -54,7 +54,7 @@ public class FinalClassCheck @Override public int[] getDefaultTokens() { - return new int[]{TokenTypes.CLASS_DEF, TokenTypes.CTOR_DEF}; + return getAcceptableTokens(); } @Override @@ -62,6 +62,11 @@ public class FinalClassCheck return new int[]{TokenTypes.CLASS_DEF, TokenTypes.CTOR_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java index de76b9d0e..a610765d4 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java @@ -43,7 +43,7 @@ public class HideUtilityClassConstructorCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.CLASS_DEF}; + return getAcceptableTokens(); } @Override @@ -51,6 +51,11 @@ public class HideUtilityClassConstructorCheck extends Check { return new int[] {TokenTypes.CLASS_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (isAbstract(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/InnerTypeLastCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/InnerTypeLastCheck.java index 43c921bba..e7bc19f0a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/InnerTypeLastCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/InnerTypeLastCheck.java @@ -45,7 +45,7 @@ public class InnerTypeLastCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF}; + return getAcceptableTokens(); } @Override @@ -53,6 +53,11 @@ public class InnerTypeLastCheck extends Check { return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { // First root class diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java index 7b6084511..b64f2ffee 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java @@ -23,6 +23,8 @@ import java.util.Map; import java.util.SortedMap; import java.util.TreeMap; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -108,7 +110,12 @@ public class OneTopLevelClassCheck extends Check { // ZERO tokens as Check do Traverse of Tree himself, he does not need to subscribed to Tokens @Override public int[] getAcceptableTokens() { - return new int[] {}; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.java index 9ef4ab4cb..8247596fc 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.java @@ -395,6 +395,11 @@ public class VisibilityModifierCheck }; } + @Override + public int[] getRequiredTokens() { + return getDefaultTokens(); + } + @Override public void beginTree(DetailAST rootAst) { immutableClassShortNames.clear(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.java index e3b2cccb1..52a40ce15 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.java @@ -78,7 +78,7 @@ public class AvoidStaticImportCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.STATIC_IMPORT}; + return getAcceptableTokens(); } @Override @@ -86,6 +86,11 @@ public class AvoidStaticImportCheck return new int[] {TokenTypes.STATIC_IMPORT}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + /** * Sets the list of classes or static members to be exempt from the check. * @param excludes a list of fully-qualified class names/specific diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java index cca8cc27e..b3129e834 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java @@ -408,11 +408,7 @@ public class CustomImportOrderCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.IMPORT, - TokenTypes.STATIC_IMPORT, - TokenTypes.PACKAGE_DEF, - }; + return getAcceptableTokens(); } @Override @@ -424,6 +420,11 @@ public class CustomImportOrderCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST rootAST) { importToGroupList.clear(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java index 420d2c442..d2be9072b 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java @@ -86,7 +86,7 @@ public class IllegalImportCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT}; + return getAcceptableTokens(); } @Override @@ -94,6 +94,11 @@ public class IllegalImportCheck return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final FullIdent imp; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java index ee7f6efde..7d852a2da 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java @@ -76,8 +76,7 @@ public class ImportControlCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.PACKAGE_DEF, TokenTypes.IMPORT, - TokenTypes.STATIC_IMPORT, }; + return getAcceptableTokens(); } @Override @@ -86,6 +85,11 @@ public class ImportControlCheck extends Check { TokenTypes.STATIC_IMPORT, }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(final DetailAST rootAST) { currentLeaf = null; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheck.java index a2f0bd3d5..05e01ea7a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheck.java @@ -303,7 +303,7 @@ public class ImportOrderCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT}; + return getAcceptableTokens(); } @Override @@ -311,6 +311,11 @@ public class ImportOrderCheck return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT}; } + @Override + public int[] getRequiredTokens() { + return new int[] {TokenTypes.IMPORT}; + } + @Override public void beginTree(DetailAST rootAST) { lastGroup = Integer.MIN_VALUE; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java index 2e913b1f2..428add90b 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java @@ -88,10 +88,7 @@ public class RedundantImportCheck @Override public int[] getDefaultTokens() { - return new int[] - {TokenTypes.IMPORT, - TokenTypes.STATIC_IMPORT, - TokenTypes.PACKAGE_DEF, }; + return getAcceptableTokens(); } @Override @@ -102,6 +99,11 @@ public class RedundantImportCheck TokenTypes.PACKAGE_DEF, }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (ast.getType() == TokenTypes.PACKAGE_DEF) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java index b39647f78..8b948449c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java @@ -262,9 +262,19 @@ public class IndentationCheck extends Check { @Override public int[] getDefaultTokens() { + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { return handlerFactory.getHandledTypes(); } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST ast) { handlerFactory.clearCreatedHandlers(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java index 51550f546..d686440cf 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java @@ -131,6 +131,16 @@ public class AtclauseOrderCheck extends AbstractJavadocCheck { }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN}; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { final int parentType = getParentType(getBlockCommentAst()); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocParagraphCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocParagraphCheck.java index aa23f058f..da317c324 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocParagraphCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocParagraphCheck.java @@ -22,6 +22,7 @@ package com.puppycrawl.tools.checkstyle.checks.javadoc; import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.DetailNode; import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** * Checks that: @@ -121,6 +122,16 @@ public class JavadocParagraphCheck extends AbstractJavadocCheck { }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN}; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { if (ast.getType() == JavadocTokenTypes.NEWLINE && isEmptyLine(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java index 0db7637cd..a537747ae 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java @@ -112,18 +112,7 @@ public class JavadocStyleCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, - TokenTypes.ANNOTATION_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.VARIABLE_DEF, - TokenTypes.ENUM_CONSTANT_DEF, - TokenTypes.ANNOTATION_FIELD_DEF, - TokenTypes.PACKAGE_DEF, - }; + return getAcceptableTokens(); } @Override @@ -142,6 +131,11 @@ public class JavadocStyleCheck }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (shouldCheck(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java index d4feaba0a..f14a7b33a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTagContinuationIndentationCheck.java @@ -24,6 +24,7 @@ import java.util.List; import com.puppycrawl.tools.checkstyle.api.DetailNode; import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** *

@@ -70,6 +71,16 @@ public class JavadocTagContinuationIndentationCheck extends AbstractJavadocCheck return new int[] {JavadocTokenTypes.DESCRIPTION }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { if (isInlineDescription(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java index 4c3f07a2f..b5564c6cc 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java @@ -156,12 +156,7 @@ public class JavadocTypeCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.ANNOTATION_DEF, - }; + return getAcceptableTokens(); } @Override @@ -174,6 +169,11 @@ public class JavadocTypeCheck }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (shouldCheck(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.java index 539e5672a..d0a8e4236 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.java @@ -80,10 +80,7 @@ public class JavadocVariableCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.VARIABLE_DEF, - TokenTypes.ENUM_CONSTANT_DEF, - }; + return getAcceptableTokens(); } @Override @@ -94,6 +91,17 @@ public class JavadocVariableCheck }; } + /* + * Skipping enum values is requested. + * Checkstyle's issue #1669: https://github.com/checkstyle/checkstyle/issues/1669 + */ + @Override + public int[] getRequiredTokens() { + return new int[] { + TokenTypes.VARIABLE_DEF, + }; + } + @Override public void visitToken(DetailAST ast) { if (shouldCheck(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java index 7647b40a9..85f17b678 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java @@ -21,6 +21,7 @@ package com.puppycrawl.tools.checkstyle.checks.javadoc; import com.puppycrawl.tools.checkstyle.api.DetailNode; import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** * Checks that the at-clause tag is followed by description . @@ -61,6 +62,16 @@ public class NonEmptyAtclauseDescriptionCheck extends AbstractJavadocCheck { }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { if (isEmptyTag(ast.getParent())) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java index 2c4a567b5..4138e2225 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java @@ -25,6 +25,7 @@ import java.util.List; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.DetailNode; import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** * Checks that a JavaDoc block can fit on a single line and doesn't @@ -102,6 +103,16 @@ public class SingleLineJavadocCheck extends AbstractJavadocCheck { }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { if (isSingleLineJavadoc(getBlockCommentAst()) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java index d3a6b9a17..47892d0b7 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java @@ -25,6 +25,7 @@ import com.google.common.base.CharMatcher; import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.DetailNode; import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** *

@@ -105,6 +106,16 @@ public class SummaryJavadocCheck extends AbstractJavadocCheck { }; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitJavadocToken(DetailNode ast) { String firstSentence = getFirstSentence(ast); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/WriteTagCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/WriteTagCheck.java index 2ee661d73..dd1637020 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/WriteTagCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/WriteTagCheck.java @@ -22,6 +22,8 @@ package com.puppycrawl.tools.checkstyle.checks.javadoc; import java.util.regex.Matcher; import java.util.regex.Pattern; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -147,6 +149,11 @@ public class WriteTagCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final FileContents contents = getFileContents(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.java index 6632dac29..a918ead19 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.java @@ -90,7 +90,7 @@ public class ModifierOrderCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.MODIFIERS}; + return getAcceptableTokens(); } @Override @@ -98,6 +98,11 @@ public class ModifierOrderCheck return new int[] {TokenTypes.MODIFIERS}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final List mods = Lists.newArrayList(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java index a8edba0ec..7e35db3b3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java @@ -25,6 +25,8 @@ import java.util.LinkedList; import java.util.List; import java.util.Set; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -191,6 +193,11 @@ public class AbbreviationAsWordInNameCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCheck.java index 18e323a5c..91116a700 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCheck.java @@ -53,6 +53,13 @@ public class ClassTypeParameterNameCheck super("^[A-Z]$"); } + @Override + public int[] getRequiredTokens() { + return new int[] { + TokenTypes.TYPE_PARAMETER, + }; + } + @Override protected final int getLocation() { return TokenTypes.CLASS_DEF; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ConstantNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ConstantNameCheck.java index 71bded1e1..cfcb2ed68 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ConstantNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ConstantNameCheck.java @@ -62,7 +62,7 @@ public class ConstantNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.VARIABLE_DEF}; + return getAcceptableTokens(); } @Override @@ -70,6 +70,11 @@ public class ConstantNameCheck return new int[] {TokenTypes.VARIABLE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override protected final boolean mustCheckName(DetailAST ast) { boolean retVal = false; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/InterfaceTypeParameterNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/InterfaceTypeParameterNameCheck.java index c42a60c89..69b712d5c 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/InterfaceTypeParameterNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/InterfaceTypeParameterNameCheck.java @@ -53,6 +53,11 @@ public class InterfaceTypeParameterNameCheck super("^[A-Z]$"); } + @Override + public int[] getRequiredTokens() { + return new int[] {TokenTypes.TYPE_PARAMETER}; + } + @Override protected final int getLocation() { return TokenTypes.INTERFACE_DEF; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCheck.java index 11ea37d7e..ec044d6d0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.naming; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.ScopeUtils; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -58,10 +60,7 @@ public class LocalFinalVariableNameCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.VARIABLE_DEF, - TokenTypes.PARAMETER_DEF, - }; + return getAcceptableTokens(); } @Override @@ -72,6 +71,11 @@ public class LocalFinalVariableNameCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override protected final boolean mustCheckName(DetailAST ast) { final DetailAST modifiersAST = diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java index 0873a0d72..d41d56699 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.naming; import java.util.regex.Pattern; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.ScopeUtils; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -92,10 +94,7 @@ public class LocalVariableNameCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.VARIABLE_DEF, - TokenTypes.PARAMETER_DEF, - }; + return getAcceptableTokens(); } @Override @@ -106,6 +105,11 @@ public class LocalVariableNameCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override protected final boolean mustCheckName(DetailAST ast) { if (allowOneCharVarInForLoop && isForLoopVariable(ast)) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MemberNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MemberNameCheck.java index be3017c9b..c8931168e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MemberNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MemberNameCheck.java @@ -58,7 +58,7 @@ public class MemberNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.VARIABLE_DEF}; + return getAcceptableTokens(); } @Override @@ -66,6 +66,11 @@ public class MemberNameCheck return new int[] {TokenTypes.VARIABLE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override protected final boolean mustCheckName(DetailAST ast) { final DetailAST modifiersAST = diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodNameCheck.java index 022d3e654..1ad6286e4 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodNameCheck.java @@ -100,7 +100,7 @@ public class MethodNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF, }; + return getAcceptableTokens(); } @Override @@ -108,6 +108,11 @@ public class MethodNameCheck return new int[] {TokenTypes.METHOD_DEF, }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { if (!AnnotationUtility.containsAnnotation(ast, OVERRIDE) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameCheck.java index 7836ed683..ae0c6ac0e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameCheck.java @@ -53,6 +53,13 @@ public class MethodTypeParameterNameCheck super("^[A-Z]$"); } + @Override + public int[] getRequiredTokens() { + return new int[] { + TokenTypes.TYPE_PARAMETER, + }; + } + @Override protected final int getLocation() { return TokenTypes.METHOD_DEF; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/PackageNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/PackageNameCheck.java index 0ad597691..56c3d8869 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/PackageNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/PackageNameCheck.java @@ -74,7 +74,7 @@ public class PackageNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.PACKAGE_DEF}; + return getAcceptableTokens(); } @Override @@ -82,6 +82,11 @@ public class PackageNameCheck return new int[] {TokenTypes.PACKAGE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final DetailAST nameAST = ast.getLastChild().getPreviousSibling(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java index 3628d1374..862bd5489 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java @@ -59,7 +59,7 @@ public class ParameterNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.PARAMETER_DEF}; + return getAcceptableTokens(); } @Override @@ -67,6 +67,11 @@ public class ParameterNameCheck return new int[] {TokenTypes.PARAMETER_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override protected boolean mustCheckName(DetailAST ast) { return ast.getParent().getType() != TokenTypes.LITERAL_CATCH; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.java index d170a51ca..d7093fcba 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.java @@ -56,7 +56,7 @@ public class StaticVariableNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.VARIABLE_DEF}; + return getAcceptableTokens(); } @Override @@ -64,6 +64,11 @@ public class StaticVariableNameCheck return new int[] {TokenTypes.VARIABLE_DEF}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override protected final boolean mustCheckName(DetailAST ast) { final DetailAST modifiersAST = diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java index ecec8d0a4..8f50c0bf5 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.naming; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** @@ -62,11 +64,7 @@ public class TypeNameCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.CLASS_DEF, - TokenTypes.INTERFACE_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.ANNOTATION_DEF, - }; + return getAcceptableTokens(); } @Override @@ -77,4 +75,9 @@ public class TypeNameCheck TokenTypes.ANNOTATION_DEF, }; } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } } diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java index d9e610e02..6b1ba7a1a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java @@ -22,6 +22,8 @@ package com.puppycrawl.tools.checkstyle.checks.regexp; import java.util.regex.Matcher; import java.util.regex.Pattern; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.FileContents; import com.puppycrawl.tools.checkstyle.api.FileText; @@ -172,7 +174,17 @@ public class RegexpCheck extends AbstractFormatCheck { @Override public int[] getDefaultTokens() { - return new int[0]; + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java index 094176be1..dda7542a2 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.regexp; import java.util.Arrays; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -39,7 +41,17 @@ public class RegexpSinglelineJavaCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[0]; + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java index 1f95ee95c..0573935cc 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java @@ -72,7 +72,7 @@ public class AnonInnerLengthCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.LITERAL_NEW}; + return getAcceptableTokens(); } @Override @@ -80,6 +80,11 @@ public class AnonInnerLengthCheck extends Check { return new int[] {TokenTypes.LITERAL_NEW}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void visitToken(DetailAST ast) { final DetailAST openingBrace = ast.findFirstToken(TokenTypes.OBJBLOCK); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/LineLengthCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/LineLengthCheck.java index 1cdcadf14..3c99907ba 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/LineLengthCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/LineLengthCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.sizes; import java.util.regex.Pattern; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -99,7 +101,17 @@ public class LineLengthCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[0]; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java index 7f36141db..a93588785 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java @@ -85,13 +85,7 @@ public final class MethodCountCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.CLASS_DEF, - TokenTypes.ENUM_CONSTANT_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.INTERFACE_DEF, - TokenTypes.METHOD_DEF, - }; + return getAcceptableTokens(); } @Override @@ -105,6 +99,11 @@ public final class MethodCountCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return new int[] {TokenTypes.METHOD_DEF}; + } + @Override public void visitToken(DetailAST ast) { if (ast.getType() == TokenTypes.METHOD_DEF) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodLengthCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodLengthCheck.java index a0b7486f1..080cb3e8f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodLengthCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodLengthCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.sizes; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.FileContents; @@ -73,7 +75,7 @@ public class MethodLengthCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF}; + return getAcceptableTokens(); } @Override @@ -81,6 +83,11 @@ public class MethodLengthCheck extends Check { return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF}; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST openingBrace = ast.findFirstToken(TokenTypes.SLIST); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java index b23a09de3..7c5473fca 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java @@ -44,8 +44,7 @@ public class OuterTypeNumberCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, - TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, }; + return getAcceptableTokens(); } @Override @@ -54,6 +53,11 @@ public class OuterTypeNumberCheck extends Check { TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, }; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST ast) { currentDepth = 0; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java index 10b39e772..c86a7f586 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.sizes; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.AnnotationUtility; import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -105,7 +107,7 @@ public class ParameterNumberCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF}; + return getAcceptableTokens(); } @Override @@ -113,6 +115,11 @@ public class ParameterNumberCheck return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF}; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java index 93614de9c..5e866979f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java @@ -70,14 +70,17 @@ public class EmptyForInitializerPadCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.FOR_INIT, - }; + return getAcceptableTokens(); } @Override public int[] getAcceptableTokens() { - return new int[] {TokenTypes.FOR_INIT, - }; + return new int[] {TokenTypes.FOR_INIT}; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForIteratorPadCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForIteratorPadCheck.java index e86e2b075..2d0f9d37b 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForIteratorPadCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForIteratorPadCheck.java @@ -70,14 +70,17 @@ public class EmptyForIteratorPadCheck @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.FOR_ITERATOR, - }; + return getAcceptableTokens(); } @Override public int[] getAcceptableTokens() { - return new int[] {TokenTypes.FOR_ITERATOR, - }; + return new int[] {TokenTypes.FOR_ITERATOR}; + } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); } @Override diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java index 31a8ec123..ad4b93600 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -184,18 +186,7 @@ public class EmptyLineSeparatorCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.PACKAGE_DEF, - TokenTypes.IMPORT, - TokenTypes.CLASS_DEF, - TokenTypes.INTERFACE_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.STATIC_INIT, - TokenTypes.INSTANCE_INIT, - TokenTypes.METHOD_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.VARIABLE_DEF, - }; + return getAcceptableTokens(); } @Override @@ -214,6 +205,11 @@ public class EmptyLineSeparatorCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST nextToken = ast.getNextSibling(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java index 3556d5b1b..28600db69 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java @@ -98,7 +98,7 @@ public class GenericWhitespaceCheck extends Check { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.GENERIC_START, TokenTypes.GENERIC_END}; + return getAcceptableTokens(); } @Override @@ -106,6 +106,11 @@ public class GenericWhitespaceCheck extends Check { return new int[] {TokenTypes.GENERIC_START, TokenTypes.GENERIC_END}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void beginTree(DetailAST rootAST) { // Reset for each tree, just incase there are errors in preceeding diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/MethodParamPadCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/MethodParamPadCheck.java index cf62d7a80..d2d9d867e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/MethodParamPadCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/MethodParamPadCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.Utils; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -96,13 +98,7 @@ public class MethodParamPadCheck @Override public int[] getDefaultTokens() { - return new int[] { - TokenTypes.CTOR_DEF, - TokenTypes.LITERAL_NEW, - TokenTypes.METHOD_CALL, - TokenTypes.METHOD_DEF, - TokenTypes.SUPER_CTOR_CALL, - }; + return getAcceptableTokens(); } @Override @@ -116,6 +112,11 @@ public class MethodParamPadCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST parenAST; diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoLineWrapCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoLineWrapCheck.java index 87b559d62..e1ce81104 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoLineWrapCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoLineWrapCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -90,6 +92,11 @@ public class NoLineWrapCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { if (ast.getLineNo() != ast.getLastChild().getLineNo()) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceAfterCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceAfterCheck.java index 339a40d27..e0cac2630 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceAfterCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceAfterCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -104,6 +106,11 @@ public class NoWhitespaceAfterCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final DetailAST astNode = getPreceded(ast); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceBeforeCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceBeforeCheck.java index c2d3f805c..a1a4412eb 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceBeforeCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoWhitespaceBeforeCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -88,6 +90,11 @@ public class NoWhitespaceBeforeCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final String line = getLine(ast.getLineNo() - 1); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/OperatorWrapCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/OperatorWrapCheck.java index 628fb568c..790cdae51 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/OperatorWrapCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/OperatorWrapCheck.java @@ -19,6 +19,7 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; import com.puppycrawl.tools.checkstyle.Utils; @@ -181,6 +182,11 @@ public class OperatorWrapCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { if (ast.getType() == TokenTypes.COLON) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/ParenPadCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/ParenPadCheck.java index 05d5af998..fbc47a53a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/ParenPadCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/ParenPadCheck.java @@ -21,6 +21,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; import java.util.Arrays; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -98,7 +100,7 @@ public class ParenPadCheck extends AbstractParenPadCheck { @Override public int[] getDefaultTokens() { - return getAcceptableTokens(); + return makeAcceptableTokens(); } @Override @@ -106,6 +108,11 @@ public class ParenPadCheck extends AbstractParenPadCheck { return makeAcceptableTokens(); } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { switch (ast.getType()) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/SeparatorWrapCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/SeparatorWrapCheck.java index c82bab69d..037195b6a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/SeparatorWrapCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/SeparatorWrapCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck; @@ -122,6 +124,11 @@ public class SeparatorWrapCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final String text = ast.getText(); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAfterCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAfterCheck.java index 524a2499b..6074e1a96 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAfterCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAfterCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -81,6 +83,11 @@ public class WhitespaceAfterCheck }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + @Override public void visitToken(DetailAST ast) { final String line = getLine(ast.getLineNo() - 1); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java index f0a20ef36..bb43768f5 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java @@ -19,6 +19,8 @@ package com.puppycrawl.tools.checkstyle.checks.whitespace; +import org.apache.commons.lang3.ArrayUtils; + import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; @@ -293,6 +295,11 @@ public class WhitespaceAroundCheck extends Check { }; } + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + /** * Sets whether or not empty method bodies are allowed. * @param allow {@code true} to allow empty method bodies. diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/TreeWalkerTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/TreeWalkerTest.java index 6564dad14..47fbb0f14 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/TreeWalkerTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/TreeWalkerTest.java @@ -297,7 +297,18 @@ public class TreeWalkerTest extends BaseCheckTestSupport { public static class BadJavaDocCheck extends Check { @Override public int[] getDefaultTokens() { + return getAcceptableTokens(); + } + + @Override + public int[] getAcceptableTokens() { return new int[]{TokenTypes.SINGLE_LINE_COMMENT}; } + + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } } + } diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/api/AbstractViolationReporterTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/api/AbstractViolationReporterTest.java index a84f1d1c9..ef414fc6a 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/api/AbstractViolationReporterTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/api/AbstractViolationReporterTest.java @@ -23,6 +23,7 @@ import static org.junit.Assert.assertEquals; import java.util.SortedSet; +import org.apache.commons.lang3.ArrayUtils; import org.junit.Assert; import org.junit.Test; @@ -38,7 +39,17 @@ public class AbstractViolationReporterTest extends BaseCheckTestSupport { private final Check emptyCheck = new Check() { @Override public int[] getDefaultTokens() { - return new int[0]; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; } }; diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/api/CheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/api/CheckTest.java index 09432c919..aa1136d54 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/api/CheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/api/CheckTest.java @@ -19,6 +19,7 @@ package com.puppycrawl.tools.checkstyle.api; +import org.apache.commons.lang3.ArrayUtils; import org.junit.Assert; import org.junit.Test; @@ -29,7 +30,17 @@ public class CheckTest { Check check = new Check() { @Override public int[] getDefaultTokens() { - return new int[0]; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; } }; // Eventually it will become clear abstract method @@ -41,7 +52,17 @@ public class CheckTest { Check check = new Check() { @Override public int[] getDefaultTokens() { - return new int[0]; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; } }; // Eventually it will become clear abstract method diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java index d5f52b897..41a83b744 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java @@ -31,6 +31,7 @@ import com.puppycrawl.tools.checkstyle.Checker; import com.puppycrawl.tools.checkstyle.DefaultConfiguration; import com.puppycrawl.tools.checkstyle.TreeWalker; import com.puppycrawl.tools.checkstyle.api.DetailNode; +import com.puppycrawl.tools.checkstyle.api.TokenTypes; public class AbstractJavadocCheckTest extends BaseCheckTestSupport { @@ -87,6 +88,16 @@ public class AbstractJavadocCheckTest extends BaseCheckTestSupport { return null; } + @Override + public int[] getAcceptableTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + + @Override + public int[] getRequiredTokens() { + return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN }; + } + @Override public void visitJavadocToken(DetailNode ast) { // do nothing diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllBlockCommentsTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllBlockCommentsTest.java index cea443a9d..d943c223a 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllBlockCommentsTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllBlockCommentsTest.java @@ -55,7 +55,7 @@ public class AllBlockCommentsTest extends BaseCheckTestSupport { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN}; + return getAcceptableTokens(); } @Override @@ -63,6 +63,11 @@ public class AllBlockCommentsTest extends BaseCheckTestSupport { return new int[] {TokenTypes.BLOCK_COMMENT_BEGIN}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void init() { allComments.addAll(Arrays.asList("0", "1", "2", "3", "4", "5", diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllSinglelineCommentsTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllSinglelineCommentsTest.java index e9b6023a7..b94100fe1 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllSinglelineCommentsTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/comments/AllSinglelineCommentsTest.java @@ -54,7 +54,7 @@ public class AllSinglelineCommentsTest extends BaseCheckTestSupport { @Override public int[] getDefaultTokens() { - return new int[] {TokenTypes.SINGLE_LINE_COMMENT}; + return getAcceptableTokens(); } @Override @@ -62,6 +62,11 @@ public class AllSinglelineCommentsTest extends BaseCheckTestSupport { return new int[] {TokenTypes.SINGLE_LINE_COMMENT}; } + @Override + public int[] getRequiredTokens() { + return getAcceptableTokens(); + } + @Override public void init() { int lines = 63; diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/comments/CompareTreesWithComments.java b/src/test/java/com/puppycrawl/tools/checkstyle/comments/CompareTreesWithComments.java index 30345e8eb..0aca3a34b 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/comments/CompareTreesWithComments.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/comments/CompareTreesWithComments.java @@ -1,5 +1,6 @@ package com.puppycrawl.tools.checkstyle.comments; +import org.apache.commons.lang3.ArrayUtils; import org.junit.Assert; import com.puppycrawl.tools.checkstyle.api.Check; @@ -15,7 +16,17 @@ public class CompareTreesWithComments extends Check { @Override public int[] getDefaultTokens() { - return new int[]{}; + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getAcceptableTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; + } + + @Override + public int[] getRequiredTokens() { + return ArrayUtils.EMPTY_INT_ARRAY; } @Override