@Override public String toString() { return getName(); }
@Test public void testScopeAnonInnerPrivate() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PRIVATE.getName()); final String[] expected = CommonUtil.EMPTY_STRING_ARRAY; verify(checkConfig, getPath("InputJavadocMethodScopeAnonInner.java"), expected); }
@Test public void testAnother2() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocVariableCheck.class); checkConfig.addAttribute("scope", Scope.PUBLIC.getName()); final String[] expected = CommonUtil.EMPTY_STRING_ARRAY; verify(checkConfig, getPath("InputJavadocVariableInner.java"), expected); }
@Test public void testNoJavadoc() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.NOTHING.getName()); final String[] expected = CommonUtil.EMPTY_STRING_ARRAY; verify(checkConfig, getPath("InputJavadocMethodPublicOnly.java"), expected); }
@Test public void testProtected() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "7: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypePublicOnly.java"), expected); }
@Test public void testAnother4() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocVariableCheck.class); checkConfig.addAttribute("scope", Scope.PUBLIC.getName()); final String[] expected = { "46:5: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocVariablePublicOnly.java"), expected); }
@Test public void testEclipse() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute( "scope", Scope.PUBLIC.getName()); final String[] expected = { "18: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeScopeInnerClasses.java"), expected); }
@Test public void testPublic() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute("scope", Scope.PUBLIC.getName()); final String[] expected = { "7: " + getCheckMessage(MSG_JAVADOC_MISSING), "38: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeScopeInnerInterfaces.java"), expected); }
@Test public void testScopeInnerInterfacesPublic() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PUBLIC.getName()); final String[] expected = { "43:9: " + getCheckMessage(MSG_JAVADOC_MISSING), "44:9: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocMethodScopeInnerInterfaces.java"), expected); }
@Test public void testScopes2() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "3: " + getCheckMessage(MSG_JAVADOC_MISSING), "15: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeNoJavadoc.java"), expected); }
@Test public void testMisc() { final Scope scope = Scope.getInstance("public"); assertNotNull("Scope must not be null", scope); assertEquals("Invalid scope toString", "public", scope.toString()); assertEquals("Invalid scope name", "public", scope.getName()); try { Scope.getInstance("unknown"); fail("exception expected"); } catch (IllegalArgumentException ex) { assertEquals("Invalid error message", "No enum constant com.puppycrawl.tools.checkstyle.api.Scope.UNKNOWN", ex.getMessage()); } }
@Test public void testScopeAnonInnerAnonInner() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.ANONINNER.getName()); final String[] expected = { "26:9: " + getCheckMessage(MSG_JAVADOC_MISSING), "39:17: " + getCheckMessage(MSG_JAVADOC_MISSING), "53:17: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocMethodScopeAnonInner.java"), expected); }
@Test public void testPkg() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute( "scope", Scope.PACKAGE.getName()); final String[] expected = { "18: " + getCheckMessage(MSG_JAVADOC_MISSING), "20: " + getCheckMessage(MSG_JAVADOC_MISSING), "22: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeScopeInnerClasses.java"), expected); }
@Test public void testScopes2() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "10:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "11:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "21:9: " + getCheckMessage(MSG_JAVADOC_MISSING), "22:9: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocMethodNoJavadoc.java"), expected); }
@Test public void testRelaxedJavadoc() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "59:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "64:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "79:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "84:5: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocMethodPublicOnly.java"), expected); }
@Test public void testExcludeScope() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute("scope", Scope.PRIVATE.getName()); checkConfig.addAttribute("excludeScope", Scope.PROTECTED.getName()); final String[] expected = { "27: " + getCheckMessage(MSG_JAVADOC_MISSING), "39: " + getCheckMessage(MSG_JAVADOC_MISSING), "52: " + getCheckMessage(MSG_JAVADOC_MISSING), "63: " + getCheckMessage(MSG_JAVADOC_MISSING), "75: " + getCheckMessage(MSG_JAVADOC_MISSING), "87: " + getCheckMessage(MSG_JAVADOC_MISSING), "99: " + getCheckMessage(MSG_JAVADOC_MISSING), "111: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeNoJavadoc.java"), expected); }
@Test public void testScopes2() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocVariableCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "5:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "6:5: " + getCheckMessage(MSG_JAVADOC_MISSING), "16:9: " + getCheckMessage(MSG_JAVADOC_MISSING), "17:9: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocVariableNoJavadoc.java"), expected); }
@Test public void testProtest() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocTypeCheck.class); checkConfig.addAttribute("scope", Scope.PROTECTED.getName()); final String[] expected = { "7: " + getCheckMessage(MSG_JAVADOC_MISSING), "29: " + getCheckMessage(MSG_JAVADOC_MISSING), "38: " + getCheckMessage(MSG_JAVADOC_MISSING), "65: " + getCheckMessage(MSG_JAVADOC_MISSING), }; verify(checkConfig, getPath("InputJavadocTypeScopeInnerInterfaces.java"), expected); }
@Test public void testExcludeScope() throws Exception { final DefaultConfiguration checkConfig = createModuleConfig(JavadocMethodCheck.class); checkConfig.addAttribute("scope", Scope.PRIVATE.getName()); checkConfig.addAttribute("excludeScope", Scope.PROTECTED.getName()); final String[] expected = { "10:5: " + getCheckMessage(MSG_JAVADOC_MISSING),