Class IllegalThrowsCheck

Checks that specified types are not declared to be thrown. Declaring that a method throws java.lang.Error or java.lang.RuntimeException is almost never acceptable.

• Property illegalClassNames - Specify throw class names to reject. Type is java.lang.String[]. Default value is Error, RuntimeException, Throwable, java.lang.Error, java.lang.RuntimeException, java.lang.Throwable.
• Property ignoredMethodNames - Specify names of methods to ignore. Type is java.lang.String[]. Default value is finalize.
• Property ignoreOverriddenMethods - allow to ignore checking overridden methods (marked with Override or java.lang.Override annotation). Type is boolean. Default value is true.

To configure the check:

 <module name="IllegalThrows"/>
 

Example:

 public class Test {
   public void func1() throws RuntimeException {} // violation
   public void func2() throws Exception {}  // ok
   public void func3() throws Error {}  // violation
   public void func4() throws Throwable {} // violation
   public void func5() throws NullPointerException {} // ok
   @Override
   public void toString() throws Error {} // ok
 }
 

To configure the check rejecting throws NullPointerException from methods:

 <module name="IllegalThrows">
   <property name="illegalClassNames" value="NullPointerException"/>
 </module>
 

Example:

 public class Test {
   public void func1() throws RuntimeException {} // ok
   public void func2() throws Exception {}  // ok
   public void func3() throws Error {}  // ok
   public void func4() throws Throwable {} // ok
   public void func5() throws NullPointerException {} // violation
   @Override
   public void toString() throws Error {} // ok
 }
 

To configure the check ignoring method named "func1()":

 <module name="IllegalThrows">
   <property name="ignoredMethodNames" value="func1"/>
 </module>
 

Example:

 public class Test {
   public void func1() throws RuntimeException {} // ok
   public void func2() throws Exception {}  // ok
   public void func3() throws Error {}  // violation
   public void func4() throws Throwable {} // violation
   public void func5() throws NullPointerException {} // ok
   @Override
   public void toString() throws Error {} // ok
 }
 

To configure the check to warn on overridden methods:

 <module name="IllegalThrows">
   <property name="ignoreOverriddenMethods" value="false"/>
 </module>
 

Example:

 public class Test {
   public void func1() throws RuntimeException {} // violation
   public void func2() throws Exception {}  // ok
   public void func3() throws Error {}  // violation
   public void func4() throws Throwable {} // violation
   public void func5() throws NullPointerException {} // ok
   @Override
   public void toString() throws Error {} // violation
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• illegal.throw