Property Types

Checkstyle is configured using properties, which are string representations. This document describes how these string representations are mapped to typed properties.

Integer

This property represents an integer. The string representation is parsed using the java.lang.Integer class.

String

This property represents a string. The literal string representation is used.

Boolean

This property represents a boolean. The default value is false. The following string representations will map to true:

Anything else will map to false.

String Set

This property represents a set of strings. The string representation is parsed as a set of comma (',') separated strings.

Integer Set

This property represents a set of integers. The string representation is parsed as a set of comma (',') separated integers that are parsed using the java.lang.Integer class.

Regular Expression

This property represents a regular expression. The string representation is parsed using the excellent Jakarta Regexp library.

Pad Parenthesis Policy

This property represents the policy for padding parenthesises. The following table describes the valid options:

Option Definition
ignore Ignore the padding.
nospace Do not pad. For example, method(a, b);
space Ensure padding. For example, method( a, b );

Operator Wrap Policy

This property represents the policy for wrapping lines on operators. The following table describes the valid options:

Option Definition
ignore Ignore wrapping on an operator.
nl The operator must be on a new line. For example: 
    someVariable = aBigVariableNameToMakeThings + "this may work"
                   + lookVeryInteresting;

Scope

This property represents a Java scope. The valid options are: