<!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="Checkstyle Development Team">
<meta name="email" content="$au.getAttributeValue("email")">
<title>Checkstyle - Modifiers</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>Modifiers</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> <a href="./property_types.html"> Property Types</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><b> <a href="./config_modifier.html"> Modifiers</a>
</b></li>
<li><a href="#ModifierOrder"> ModifierOrder</a></li>
<li><a href="#RedundantModifier"> RedundantModifier</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">
<a id="ModifierOrder"></a>
<h2>ModifierOrder</h2>
<h3>Description</h3>
<p>
Checks that the order of modifiers conforms to the suggestions in
the <a href="http://java.sun.com/docs/books/jls/second_edition/html/classes.doc.html">Java
Language specification, sections 8.1.1, 8.3.1 and 8.4.3</a>. The
correct order is:
</p>
<ol>
<li>
<span class="code">public</span>
</li>
<li>
<span class="code">protected</span>
</li>
<li>
<span class="code">private</span>
</li>
<li>
<span class="code">abstract</span>
</li>
<li>
<span class="code">static</span>
</li>
<li>
<span class="code">final</span>
</li>
<li>
<span class="code">transient</span>
</li>
<li>
<span class="code">volatile</span>
</li>
<li>
<span class="code">synchronized</span>
</li>
<li>
<span class="code">native</span>
</li>
<li>
<span class="code">strictfp</span>
</li>
</ol>
<h3>Example</h3>
<p> To configure the check: </p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre><module name="ModifierOrder"/></pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<h3>Package</h3>
<p> com.puppycrawl.tools.checkstyle.checks.modifier </p>
<h3>Parent Module</h3>
<p>
<a href="config.html#treewalker">TreeWalker</a>
</p>
<a id="RedundantModifier"></a>
<h2>RedundantModifier</h2>
<h3>Description</h3>
<p>
Checks for redundant modifiers in interface and annotation
definitions. Also checks for redundant final modifiers on
methods of final classes.
</p>
<p>
Rationale: The Java Language Specification strongly
discourages the usage of "public" and "abstract" for method
declarations in interface definitions as a matter of style.
</p>
<p>
Variables in interfaces and annotations are automatically
public, static and final, so these modifiers are redundant as
well.
</p>
<p>
As annotations are a form of interface, their fields are also
automatically public, static and final just as their
annotation fields are automatically public and abstract.
</p>
<p>
Final classes by definition can not be extended so the final
modifier on the method of a final class is redundant.
</p>
<h3>Properties</h3>
<table>
<tr class="even">
<th valign="top" align="left"
>
name
</th>
<th valign="top" align="left"
>
description
</th>
<th valign="top" align="left"
>
type
</th>
<th valign="top" align="left"
>
default value
</th>
</tr>
<tr class="odd">
<td class="odd"
>
tokens
</td>
<td class="odd"
>
tokens to check
</td>
<td class="odd"
>
subset of tokens <a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>,
<a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>
</td>
<td class="odd"
>
<a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>,
<a href="api/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>
</td>
</tr>
</table>
<h3>Example</h3>
<p> To configure the check: </p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre><module name="RedundantModifier"/></pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
To configure the check to check only methods and not variables:
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre><module name="RedundantModifier">
<property name="tokens" value="METHOD_DEF"/>
</module></pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<h3>Package</h3>
<p> com.puppycrawl.tools.checkstyle.checks.modifier </p>
<h3>Parent Module</h3>
<p>
<a href="config.html#treewalker">TreeWalker</a>
</p>
</div>
</div>
<div class="csBottomBar">
<div class="csBottomBarContents">
Copyright © 2001-2007, Oliver Burn
</div>
</div>
</body>
</html>
<!-- end the processing -->
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
253d50e0122b162d839c0c787af1f0d6
>
files
>
17
