Class Design
Checks visibility of class members. Only static final members may be public; other class members must be private unless property protectedAllowed or packageAllowed is set.
Public members are not flagged if the name matches the public member regular expression (contains "^serialVersionUID$" by default). Note: Checkstyle 2 used to include "^f[A-Z][a-zA-Z0-9]*$" in the default pattern to allow CMP for EJB 1.1 with the default settings. With EJB 2.0 it is not longer necessary to have public access for persistent fields, hence the default has been changed.
Rationale: Enforce encapsulation.
| name | description | type | default value |
|---|---|---|---|
| packageAllowed | whether package visible members are allowed | boolean | false |
| protectedAllowed | whether protected members are allowed | boolean | false |
| publicMemberPattern | pattern for public members that should be ignored | regular expression | ^serialVersionUID$ |
To configure the check:
 |
|
|
|
<module name="VisibilityModifier"/> |
|
|
|
|
To configure the check so that it allows package visible members:
|
|
|
|
<module name="VisibilityModifier">
<property name="packageAllowed" value="true"/>
</module> |
|
|
|
|
To configure the check so that it allows no public members:
|
|
|
|
<module name="VisibilityModifier">
<property name="publicMemberPattern" value="^$"/>
</module> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Checks that a class which has only private constructors is declared as final.
To configure the check:
|
|
|
|
<module name="FinalClass"/> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
According to Bloch, an interface should describe a type. It is therefore inappropriate to define an interface that does not contain any methods but only constants. The Standard class javax.swing.SwingConstants is an example of a class that would be flagged by this check.
The check can be configured to also disallow marker interfaces like
java.io.Serializable, that do not contain methods or
constants at all.
| name | description | type | default value |
|---|---|---|---|
| allowMarkerInterfaces | Controls whether marker interfaces like Serializable are allowed. | Boolean | true |
To configure the check:
|
|
|
|
<module name="InterfaceIsType"/> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Make sure that utility classes (classes that contain only static methods or fields in their API) do not have a public constructor.
Rationale: Instantiating utility classes does not make sense. Hence the constructors should either be private or (if you want to allow subclassing) protected. A common mistake is forgetting to hide the default constructor.
If you make the constructor protected you may want to consider the following constructor implementation technique to disallow instantiating subclasses:
|
|
|
|
public class StringUtils // not final to allow subclassing
{
protected StringUtils() {
throw new UnsupportedOperationException(); // prevents calls from subclass
}
public static int count(char c, String s) {
// ...
}
} |
|
|
|
|
To configure the check:
|
|
|
|
<module name="HideUtilityClassConstructor"/> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Checks that classes are designed for extension. More specifically, it enforces a programming style where superclasses provide empty "hooks" that can be implemented by subclasses.
The exact rule is that nonprivate, nonstatic methods of classes that can be subclassed must either be
Rationale: This API design style protects superclasses against beeing broken by subclasses. The downside is that subclasses are limited in their flexibility, in particular they cannot prevent execution of code in the superclass, but that also means that subclasses cannot corrupt the state of the superclass by forgetting to call the super method.
None.
To configure the check:
|
|
|
|
<module name="DesignForExtension"/> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable. That is, have only final fields.
The current algorithm is very simple it checks that all members of exception are final. User can still mutates an exception's instance (e.g. Throwable has setStackTrace(StackTraceElement[] stackTrace) method which changes stack trace). But, at least, all information provided by this exception type is unchangable.
Rationale: Exception instances should represent an error condition. Having non final fields not only allows the state to be modified by accident and therefore mask the original condition but also allows developers to accidentally forget to initialise state thereby leading to code catching the exception to draw incorrect conclusions based on the state.
| name | description | type | default value |
|---|---|---|---|
| format | pattern for name of exception class. | regular expression | ^.*Exception$|^.*Error$ |
To configure the check:
|
|
|
|
<module name="MutableException"/> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design
Restricts throws statements to a specified count (default = 1).
Rationale: Exceptions form part of a methods interface. Declaring a method to throw too many differently rooted exceptions makes exception handling onerous and leads to poor programming practices such as catch (Exception). This check forces developers to put exceptions into a heirachy such that in the simplest case, only one type of exception need be checked for by a caller but allows any sub-classes to be caught specifically if necessary.
| name | description | type | default value |
|---|---|---|---|
| max | maximum allowed number of throws statments | Integer | 1 |
To configure the check so that it doesn't allow more than two throws per method:
|
|
|
|
<module name="ThrowsCount">
<property name="max" value="2"/>
</module> |
|
|
|
|
com.puppycrawl.tools.checkstyle.checks.design