<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />
<meta name="author" content="Oliver Burn">
<meta name="email" content="$au.getAttributeValue("email")">
<title>Checkstyle - Property Types</title>
<style type="text/css" media="all">
@import url("./css/cs-layout.css");
@import url("./css/cs-style.css");
</style>
</head>
<body>
<div class="csTopBar">
<div class="csTopBarContents">
<div class="csLeft">
<h1>Property Types</h1>
</div>
<div class="csRight">
<a href="http://checkstyle.sourceforge.net/">
<img src="images/logo.png" alt="Checkstyle Logo" height="70"/>
</a>
</div>
</div>
</div>
<div class="csMiddleContainer">
<div class="csLeftBar">
<div class="csLeftBarContents">
<!-- ============================================================ -->
<!-- start makeNavigationBar -->
<ul>
<li>
<strong>About</strong>
</li>
<li> <a href="./index.html">Checkstyle</a>
</li>
<li>
<strong>Documentation</strong>
</li>
<li> <a href="./releasenotes.html">Release Notes</a>
</li>
<li> <a href="./config.html">Configuration</a>
</li>
<li><b> <a href="./property_types.html"> Property Types</a>
</b></li>
<li><a href="#integer"> integer</a></li>
<li><a href="#string"> string</a></li>
<li><a href="#boolean"> boolean</a></li>
<li><a href="#stringSet"> stringSet</a></li>
<li><a href="#intSet"> intSet</a></li>
<li><a href="#regexp"> regexp</a></li>
<li><a href="#parenPad"> parenPad</a></li>
<li><a href="#wrapOp"> wrapOp</a></li>
<li><a href="#block"> block</a></li>
<li><a href="#lcurly"> lcurly</a></li>
<li><a href="#rcurly"> rcurly</a></li>
<li><a href="#scope"> scope</a></li>
<li><a href="#severity"> severity</a></li>
<li><a href="#persistence"> persistence</a></li>
<li> <a href="./running.html">Running</a>
</li>
<li> <a href="./anttask.html"> Ant Task</a>
</li>
<li> <a href="./cmdline.html"> Command Line</a>
</li>
<li> <a href="./availablechecks.html">Available Checks</a>
</li>
<li> <a href="./checks.html">Standard Checks</a>
</li>
<li> <a href="./config_javadoc.html"> Javadoc Comments</a>
</li>
<li> <a href="./config_naming.html"> Naming Conventions</a>
</li>
<li> <a href="./config_header.html"> Headers</a>
</li>
<li> <a href="./config_imports.html"> Imports</a>
</li>
<li> <a href="./config_sizes.html"> Size Violations</a>
</li>
<li> <a href="./config_whitespace.html"> Whitespace</a>
</li>
<li> <a href="./config_modifier.html"> Modifiers</a>
</li>
<li> <a href="./config_blocks.html"> Block Checks</a>
</li>
<li> <a href="./config_coding.html"> Coding</a>
</li>
<li> <a href="./config_design.html"> Class Design</a>
</li>
<li> <a href="./config_duplicates.html"> Duplicate Code</a>
</li>
<li> <a href="./config_metrics.html"> Metrics</a>
</li>
<li> <a href="./config_misc.html"> Miscellaneous</a>
</li>
<li> <a href="./optional.html">Optional Checks</a>
</li>
<li> <a href="./config_j2ee.html"> J2EE Checks</a>
</li>
<li> <a href="./extending.html">Extending Checkstyle</a>
</li>
<li> <a href="./writingchecks.html"> Writing checks</a>
</li>
<li> <a href="./writingfilters.html"> Writing filters</a>
</li>
<li> <a href="./writinglisteners.html"> Writing listeners</a>
</li>
<li> <a href="./api/index.html">Javadoc</a>
</li>
<li>
<strong>SourceForge</strong>
</li>
<li> <a href="http://sourceforge.net/mail/?group_id=29721">Mailing Lists</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397078&group_id=29721&func=browse">Bug Database</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397081&group_id=29721&func=browse">Feature Requests</a>
</li>
<li>
<strong>Developers</strong>
</li>
<li> <a href="http://sourceforge.net/projects/checkstyle">Project Page</a>
</li>
<li> <a href="http://checkstyle.svn.sourceforge.net/viewvc/checkstyle/">SVN Repository</a>
</li>
<li> <a href="./contributing.html">Contributing</a>
</li>
</ul>
<ul>
<li>
<strong>Hosted by:</strong>
<div align="center">
<p><a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=29721&type=1" width="88" height="31" alt="SourceForge Logo"/></a>
</p>
</div>
</li>
</ul>
<!-- end makeNavigationBar -->
<!-- ============================================================ -->
</div>
</div>
<div class="csMain">
<p>
Checkstyle is configured using properties, which are string
representations. This document describes how these string
representations are mapped to typed properties.
</p>
<a id="integer"></a>
<h2>integer</h2>
<p>
This property represents an integer. The string representation is
parsed using the <span class="code">java.lang.Integer</span> class.
</p>
<a id="string"></a>
<h2>string</h2>
<p>
This property represents a string. The literal string representation
is used.
</p>
<a id="boolean"></a>
<h2>boolean</h2>
<p>
This property represents a boolean. The default value is <span class="code">false</span>. The following string representations will
map to <span class="code">true</span>:
</p>
<ul>
<li><span class="code">yes</span></li>
<li><span class="code">true</span></li>
<li><span class="code">on</span></li>
</ul>
<p>Anything else will map to <span class="code">false</span>.</p>
<a id="stringSet"></a>
<h2>stringSet</h2>
<p>
This property represents a set of strings. The string representation
is parsed as a set of comma (',') separated strings.
</p>
<a id="intSet"></a>
<h2>intSet</h2>
<p>
This property represents a set of integers. The string representation
is parsed as a set of comma (',') separated integers that are parsed
using the <span class="code">java.lang.Integer</span> class.
</p>
<a id="regexp"></a>
<h2>regexp</h2>
<p>
This property represents a regular expression. The string
representation is parsed using <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/package-summary.html">java.util.regex
package</a>.
</p>
<a id="parenPad"></a>
<h2>parenPad</h2>
<p>
This property represents the policy for padding with white space. The
following table describes the valid options:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Do not pad. For example, <span class="code">method(a, b);</span>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Ensure padding. For example,
<span class="code">method( a, b );</span>
</td>
</tr>
</table>
<a id="wrapOp"></a>
<h2>wrapOp</h2>
<p>
This property represents the policy for wrapping lines on
operators. The following table describes the valid options:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
The operator must be on a new line. For example:
<pre>
someVariable = aBigVariableNameToMakeThings + "this may work"
+ lookVeryInteresting;
</pre>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
The operator must be at the end of the line. For example:
<pre>
someVariable = aBigVariableNameToMakeThings + "this may work" +
lookVeryInteresting;
</pre>
</td>
</tr>
</table>
<a id="block"></a>
<h2>block</h2>
<p>
This property represents the policy for checking block statements. The
following table describes the valid options:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Require that there is some text in the block. For example:
<pre>
catch (Exception ex) {
// This is a bad coding practice
}
</pre>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Require that there is a statement in the block. For example:
<pre>
finally {
lock.release();
}
</pre>
</td>
</tr>
</table>
<a id="lcurly"></a>
<h2>lcurly</h2>
<p>
This property represents the policy for checking the placement of a
left curly brace (<span class="code">'{'</span>). The following table
describes the valid options:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
The brace must always be on the end of the line. For example:
<pre>
if (condition) {
...
</pre>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
The brace must always be on a new line. For example:
<pre>
if (condition)
{
...
</pre>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
If the brace will fit on the first line of the statement, taking
into account maximum line length, then apply <span class="code">eol</span> rule. Otherwise apply the <span class="code">nl</span> rule. <span class="code">nlow</span> is a
mnemonic for "new line on wrap". For the example above Checkstyle
will enforce:
<pre>
if (condition) {
...
</pre>
But for a statement spanning multiple lines, Checkstyle will
enforce:
<pre>
if (condition1 && condition2 &&
condition3 && condition4)
{
...
</pre>
</td>
</tr>
</table>
<a id="rcurly"></a>
<h2>rcurly</h2>
<p>
This property represents the policy for checking the placement of a
right curly brace (<span class="code">'}'</span>). The following table
describes the valid options:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
The brace must be on the same line as the next statement. For
example:
<pre>
try {
...
} finally {
</pre>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
The brace must be alone on the line. For example:
<pre>
try {
...
}
finally {
</pre>
</td>
</tr>
</table>
<a id="scope"></a>
<h2>scope</h2>
<p>This property represents a Java scope. The scope is treated
inclusevly (as javadoc does): 'package' means all 'package', 'protected'
and 'public' methods/fields/classes. The valid options are:</p>
<ul>
<li><span class="default">nothing</span></li>
<li><span class="default">public</span></li>
<li><span class="default">protected</span></li>
<li><span class="default">package</span></li>
<li><span class="default">private</span></li>
<li><span class="default">anoninner</span></li>
</ul>
<a id="severity"></a>
<h2>severity</h2>
<p>
This property represents the severity level of a check violation. The
valid options are:
</p>
<ul>
<li><span class="default">ignore</span></li>
<li><span class="default">info</span></li>
<li><span class="default">warning</span></li>
<li><span class="default">error</span></li>
</ul>
<a id="persistence"></a>
<h2>persistence</h2>
<p>
This property represents the policy for checking entity beans
according to whether the beans have bean-managed persistence,
container-managed persistence, or mixed persistence:
</p>
<table>
<tr class="even">
<td class="even"
>
Option
</td>
<td class="even"
>
Definition
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
The beans have bean-managed persistence.
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
The beans have container-managed persistence.
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
The beans have mixed bean-managed and container-managed
persistence.
</td>
</tr>
</table>
</div>
</div>
<div class="csBottomBar">
<div class="csBottomBarContents">
Copyright © 2001-2007, Oliver Burn
</div>
</div>
</body>
</html>
<!-- end the processing -->
