From 055aa0cf9da3dc844ca9cc4956570c47bc3e23b2 Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Sun, 20 Mar 2005 10:08:28 +0000 Subject: [PATCH] Updated setter/getter support to handle accessor of the format 'isSomething' --- .../checkstyle/checks/javadoc/JavadocMethodCheck.java | 5 +++-- .../tools/checkstyle/javadoc/InputSetterGetter.java | 4 ++++ .../checks/javadoc/JavadocMethodCheckTest.java | 9 ++++++--- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java index accc72a6c..60c7ca13b 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java @@ -812,10 +812,11 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck return false; } - // Check the name matches format getX... + // Check the name matches format of getX or isX. Technically I should + // check that the format isX is only used with a boolean type. final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE); final String name = type.getNextSibling().getText(); - if (!name.matches("^get[A-Z].*")) { // Depends on JDK 1.4 + if (!name.matches("^(is|get)[A-Z].*")) { // Depends on JDK 1.4 return false; } diff --git a/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/InputSetterGetter.java b/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/InputSetterGetter.java index 85648b585..156eb0546 100755 --- a/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/InputSetterGetter.java +++ b/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/InputSetterGetter.java @@ -43,4 +43,8 @@ public class InputSetterGetter return 666; } + public boolean isSomething() + { + return false; + } } diff --git a/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java b/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java index df98c6f18..0445e17f8 100644 --- a/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java +++ b/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java @@ -10,7 +10,8 @@ public class JavadocMethodCheckTest extends BaseCheckTestCase { public void testTags() throws Exception { - final DefaultConfiguration checkConfig = createCheckConfig(JavadocMethodCheck.class); + final DefaultConfiguration checkConfig = + createCheckConfig(JavadocMethodCheck.class); final String[] expected = { "14:5: Missing a Javadoc comment.", "18: Unused @param tag for 'unused'.", @@ -137,7 +138,8 @@ public class JavadocMethodCheckTest extends BaseCheckTestCase public void testScopeAnonInnerPrivate() throws Exception { - final DefaultConfiguration checkConfig = createCheckConfig(JavadocMethodCheck.class); + final DefaultConfiguration checkConfig = + createCheckConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PRIVATE.getName()); final String[] expected = {}; verify(checkConfig, getPath("InputScopeAnonInner.java"), expected); @@ -324,7 +326,8 @@ public class JavadocMethodCheckTest extends BaseCheckTestCase "26:5: Missing a Javadoc comment.", "30:5: Missing a Javadoc comment.", "35:5: Missing a Javadoc comment.", - "41:5: Missing a Javadoc comment.", }; + "41:5: Missing a Javadoc comment.", + "46:5: Missing a Javadoc comment.", }; verify(checkConfig, getPath("javadoc" + File.separator + "InputSetterGetter.java"), expected); }