From 28590ca2b9653e89caa8a5983f15ae29a87d3027 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= Date: Mon, 12 Jul 2021 17:01:12 +0200 Subject: [PATCH] Update AvoidUncheckedExceptionsInSignatures --- .ci/files/all-java.xml | 2 +- pmd-java/src/main/resources/category/java/design.xml | 8 +++----- .../design/AvoidUncheckedExceptionsInSignaturesTest.java | 1 - 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.ci/files/all-java.xml b/.ci/files/all-java.xml index b1005d2a2a..c251dc23af 100644 --- a/.ci/files/all-java.xml +++ b/.ci/files/all-java.xml @@ -126,7 +126,7 @@ - + diff --git a/pmd-java/src/main/resources/category/java/design.xml b/pmd-java/src/main/resources/category/java/design.xml index bd2c103f3c..1cb0981b79 100644 --- a/pmd-java/src/main/resources/category/java/design.xml +++ b/pmd-java/src/main/resources/category/java/design.xml @@ -286,8 +286,8 @@ public class Foo { class="net.sourceforge.pmd.lang.rule.XPathRule" externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_design.html#avoiduncheckedexceptionsinsignatures"> -A method or constructor should not explicitly declare unchecked exceptions in its -`throws` clause. Java doesn't force the caller to handle an unchecked exception, +Reports unchecked exceptions in the `throws` clause of a method or constructor. +Java doesn't force the caller to handle an unchecked exception, so it's unnecessary except for documentation. A better practice is to document the exceptional cases with a `@throws` Javadoc tag, which allows being more descriptive. @@ -296,9 +296,7 @@ exceptional cases with a `@throws` Javadoc tag, which allows being more descript diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/design/AvoidUncheckedExceptionsInSignaturesTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/design/AvoidUncheckedExceptionsInSignaturesTest.java index 9e2cc6b138..62c9c4e7e8 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/design/AvoidUncheckedExceptionsInSignaturesTest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/rule/design/AvoidUncheckedExceptionsInSignaturesTest.java @@ -6,7 +6,6 @@ package net.sourceforge.pmd.lang.java.rule.design; import net.sourceforge.pmd.testframework.PmdRuleTst; -@org.junit.Ignore("Rule has not been updated yet") public class AvoidUncheckedExceptionsInSignaturesTest extends PmdRuleTst { // no additional unit tests }