Abstract class for checks that verify Bean implementation.
Abstract implementation of a CellEditor.
Base class for coupling calculation.
Creates new instance of the check.
Ensures that the names of abstract classes conforming to some
regular expression.
Creates new instance of the check.
Base class for checks the calculate complexity based around methods.
Provides common functionality for many FileSetChecks.
Creates a new AbstractFormatCheck
instance.
Creates a new AbstractFormatCheck
instance.
Abstract super class for header checks.
Support for checks that look for usage of illegal types.
Abstract class for checking interface requirements.
Abstract class for J2ee component checking.
Contains the common implementation of a loader, for loading a configuration
from an XML file.
Abstract class for checking that names conform to a specified format.
Creates a new AbstractNameCheck
instance.
Abstract class which provides helpers functionality for nestedchecks.
Creates new instance of checks.
Abstract class that represents options.
Creates a new AbstractOption
instance.
Abstract class for checks with options.
Creates a new AbstractOptionCheck
instance.
Abstract class for checking that an overriding method with no parameters
invokes the super method.
Abstract class that endeavours to maintain type information for the Java
file being checked.
Serves as an abstract base class for all modules that report inspection
findings.
Determines whether or not a filtered AuditEvent is accepted.
Checks if given indentation is accaptable.
Logs a message to be reported.
Adds one more acceptable indentation level.
Adds one more acceptable indentation level.
Adds an attribute to this configuration.
Makes a configuration a child of this configuration.
Notify that an audit error was discovered on a specific file.
Print an Emacs compliant line on the error stream.
Notify that an exception happened while performing audit.
Adds a set of files (nested fileset attribute).
Adds a FileSetCheck to the list of FileSetChecks
that is executed in process().
Adds a filter to the end of the audit event filter chain.
Adds a Filter to the set.
Add a line to this set of lines.
Add the listener that will be used to receive events from the audit.
Add an override property.
Represents the policy that the brace must be alone on the line.
An annotation of a package, type, field, parameter or variable.
An annotation array member initialisation.
An annotation declaration.
An annotation field declaration.
An initialisation of an annotation member with a value.
A collection of annotations on a package or enum constant.
ANONINNER - static field in class com.puppycrawl.tools.checkstyle.api.
Scope anon inner scope.
Checks for long anonymous inner classes.
Handler for array initialization blocks.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Checks if array initialization contains optional trailing comma.
Checks the style of array type definitions.
The =
(assignment) operator.
Handler for assignements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
AT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes An 'at' symbol - signifying an annotation instance or the prefix
to the interface literal signifying the definition of an annotation
declaration.
Creates a new AuditEvent
instance.
Creates a new AuditEvent
instance.
Notify that the audit is finished.
Listener in charge of receiving events from the Checker.
Notify that the audit is about to start.
A Java Bean that implements the component lifecycle interfaces by
calling the bean's setters for all configration attributes.
Detects inline conditionals.
Check that finds import statements that use the * notation.
Handler for case statements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Handler for catch blocks.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Check - class com.puppycrawl.tools.checkstyle.api.
Check The base class for checks.
Checks a bean class requirements.
Check the indent level of the children of the specified parent
expression.
Checks that every ejbCreate method has a matching ejbPostCreate method.
Checks whether an ejbCreate<METHOD>(...) method of a
bean satisfies requirements.
Checks whether an ejbCreate<METHOD>(...) method of an
entity bean satisfies requirements.
Checks create<METHOD>(...) method requirements.
This class provides the functionality to check a set of files.
Creates a new Checker
instance.
Check the indentation level for an expression subtree.
Checks whether an ejbHome<METHOD>(...) method of an
entity bean satisfies requirements.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the expression we are handling.
Check the indentation of the left curly brace.
Check the indentation of consecutive lines for the expression we are
handling.
Check the indentation of the left parenthesis.
Checks whether a method satisfies component requirements.
Checks whether a method satisfies public, non-static, and final
requirements.
Checks that the methods of a component satisfy requirements.
Check the indentation level of modifiers.
Checks that the throws clause of a method definition does no include an
Exception.
Checks whether an ejbPostCreate<METHOD>(...) method of an
entity bean satisfies requirements.
Check the indentation of the right curly brace.
Check the indentation of the right parenthesis.
Checks whether an ejbSelect<METHOD>(...) method of an
entity bean satisfies requirements.
Name of resource bundle for Checkstyle.
Represents an error condition within Checkstyle.
Creates a new CheckstyleException
instance.
Creates a new CheckstyleException
instance
that was caused by another exception.
An implementation of a ANT task for calling checkstyle.
Checks that the throws clause of a method definition includes an
Exception.
Check the indent of the top level token.
Check the indent of the top level token.
Check the indentation of the top level token.
Contains utility methods for the checks.
Determines if child elements within the expression may be nested.
Determines if child elements within the expression may be nested.
This metric measures the number of instantiations of other classes
within the given class.
Creates bew instance of the check.
Handler for class definitions.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
The number of other classes a given class relies on.
Creates new instance of this check.
Creates new instance of class inforamtion object.
Utility class to resolve a class name to an actual class.
Creates a new ClassResolver
instance.
Flushes the output streams and closes them if needed.
COLON - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The :
(colon) operator.
Contains the implementation of the Checkstyle framework.
Contains the core API to be used to implement checks.
Contains the checks that are bundled with the main distribution.
Contains the Block checks that are bundled with the main distribution.
Contains the Coding checks that are bundled with the main distribution.
Contains the Class Design checks that are bundled with the main distribution.
Duplicate code detection tools.
Contains the Imports checks that are bundled with the main distribution.
Contains all classes required for the indentation check.
Contains the Javadoc checks that are bundled with the main distribution.
Contains the Metrics checks that are bundled with the main distribution.
Contains the modifier checks that are bundled with the main distribution.
Contains the Naming conventions checks that are bundled with the main distribution.
Contains the Size Violations checks that are bundled with the main distribution.
Contains the Whitespace checks that are bundled with the main distribution.
Contains the filters that are bundled with the main distribution.
Contains the grammar used by the Checkstyle framework.
User interface classes for CheckStyle.
COMMA - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ,
(comma) operator.
This interface is used to be notified by parser about comments
in the parsed code.
Compares the position of this tag in the file
with the position of another tag.
A component that can be configured.
A Configuration is used to configure a Configurable component.
Loads a configuration from a standard configuration XML file.
Implements the Configurable interface using bean introspection.
Configures this component.
Checks that constant names conform to a format specified
by the format property.
Creates a new ConstantNameCheck
instance.
Builds the dotted name String representation of the object contained
within an AST.
Represents the container-managed persistence policy.
Checks methods of entity beans with container-managed persistence.
Constructs a ContainerManagedMethodChecker for a entity bean check.
A context to be used in subcomponents.
A Component that needs context information from it's container to work.
Implements the Contextualizable interface using bean introspection.
Sets the context for this Component.
Checks that if a class defines a covariant method equals,
then it defines method equals(java.lang.Object).
Mac-style line separators.
Creates class info for given name.
Creates a new FullIdent starting from the specified node.
Creates a new FullIdent starting from the child of the specified node.
Creates FullIdent
for given type node.
Abstract factory method to create an unconfigured
header info bean.
Creates a listener for the formatter.
Creates a new instance of a class from a given name.
Helper method to create a regular expression.
Windows-style line separators.
A FileSetCheck similar to
RegexpHeaderCheck
,
but works for all text files, not just java code.
Creates a new instance and initializes the file extentions
to the default value, which represents most of the typical
text files that require a copyright header.
A constructor declaration.
Checks cyclomatic complexity against a specified limit.
Checks for fall through in switch statements
Finds locations where a case contains Java code -
but lacks a break, return, throw or continue statement.
Creates new instance of the check.
Represents the contents of a file.
Creates a new FileContents
instance.
Holds the current file contents for global access when configured
as a TreeWalker sub-module.
Notify that audit is finished on a specific file.
Checks for long source files.
This method is called when files have been successfully dropped.
Interface for Checking a set of files for some criteria.
Notify that audit is about to start on a specific file.
Filter - interface com.puppycrawl.tools.checkstyle.api.
Filter An interface for filtering AuditEvents.
Determines the set of files this FileSetCheck is interested in.
Filter a set of files by their extension.
A filter set applies filters to AuditEvents.
FINAL - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The final
keyword.
Checks that class which has only private ctors
is declared as final.
Ensures that local variables that never get their values changed,
must be declared final.
Handler for finally blocks.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Check that method/constructor/catch/foreach parameters are final.
Checks that all static fields are declared final.
Looking if a given name is alias.
Returns the first child token that makes a specified type.
Find the set of lines for a given subtree.
Checks that required args were specified.
Provides a hook to finish the part of this compoent's setup that
was not handled by the bean introspection.
Checks that required args were specified.
Called after finished processing a tree.
notify all listeners about the audit end
notify all listeners about the audit start
Notify all listeners about the errors in a file.
notify all listeners about the errors in a file.
Notify all listeners about the errors in a file.
Notify all listeners about the end of a file audit.
Notify all listeners about the end of a file audit.
Notify all listeners about the beginning of a file audit.
Notify all listeners about the beginning of a file audit.
Get the line number of the first line.
Get the starting column for the first line.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Details about a formatter to be used.
Poor mans enumeration for the formatter types.
Represents a full identifier, including dots, with associated
position information.
GE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >=
(greater than or equal) operator.
Java 1.5 Recognizer
This grammar is in the PUBLIC DOMAIN
'>' symbol signifying the end of type arguments or type parameters.
'<' symbol signifying the start of type arguments or type parameters.
A generic check for code problems, the user can search for any pattern.
Instantiates an new GenericIllegalRegexpCheck.
Searches for the value with the specified attribute key in this context.
The configurable token set.
Prevent user from changing tokens in the configuration.
Prevent user from changing tokens in the configuration.
The attribute value for an attribute name.
The set of attribute names.
Returns the names of all atttributes of this context.
A shortcut for IndentationCheck
property.
A shortcut for IndentationCheck
property.
Get the brace adjustment amount.
Get the case indentation level.
Returns a map of all C style comments.
Returns array of token types which should be checked among childrens.
Returns the number of child nodes one level below this node.
Returns the number of direct child tokens that have the specified type.
The set of child configurations.
Returns the class loader associated with the tree.
Determines the column number of the tag in the source file.
Returns the type for column number column
.
Returns the type for column number column
.
Returns the type for column number column
.
Returns the number ofs availible column.
Returns the number ofs availible column.
Returns the name for column number column
.
Returns the name for column number column
.
Returns the configuration that was used to configure this component.
Returns the number of counted events since audit started.
Returns a map of all the C++ style comments.
Returns the default token a check is interested in.
Get the tokens that this check will handle.
The column in the inputfile where the text block ends.
The last line of the text block in the inputfile.
Accessor for shared instance of logger which should be
used to log all exceptions occured during FileSetCheck
work (debug()
should be used).
Returns the file contents associated with the tree.
Returns the loaded filter chain.
Returns the Filters of the filter set.
Get the first line for a given expression.
Finds sub-node for given node minimal (line, column) pair.
Gets list of registered handler types.
Get the handler for an AST.
Return the header info to check against.
Return the header lines to check against.
Returns the identifier of the reporter.
Get the list of ignored method names.
Get the list of illegal variable types.
Accessor for the IndentCheck attribute.
SeverityLevel factory method.
Returns the Javadoc comment before the specified line.
Returns the message key to locate the translation, can also be used
in IDE plugins to map error messages to corrective actions.
Get the left curly brace portion of the expression we are handling.
Get the left curly brace portion of the expression we are handling.
Get the left curly brace portion of the expression we are handling.
Get the left curly brace portion of the expression we are handling.
Get the left curly brace portion of the expression we are handling.
Get the left curly brace portion of the expression we are handling.
Get the list of legal abstract class names.
Get the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
Compute the indentation amount for this handler.
return the line number on the source file where the event occurred.
Returns the lines associated with the tree.
Loads the contents of a file in a String array.
Loads the contents of a file in a String array using
the named charset.
Get the start of the line for the given expression.
Get the start of the specified line.
Get the child element representing the list of statements.
Get the child element representing the list of statements.
Get the child element representing the list of statements.
Get the child element representing the list of statements.
Get the child element representing the list of statements.
There is no list of statements child for this handler.
Return the list of listeners set in this task.
Get the left parenthesis portion of the expression we are handling.
Accessor for the MainAst attribute.
Getter for maximum allowed nesting depth.
Getter for maximum allowed complexity.
Gets the maximum threshold.
return the message associated to the event.
Getter for message property.
Getter for message property.
Returns the message bundle name resourcebundle that contains the messages
used by this module.
Returns the collector for violation messages.
A message dispatcher is used to fire violation messages to
interested audit listeners.
Gets the method checker for this component check.
Returns the name of the overriding method.
The name of this configuration.
Get the child element that is not a list of statements.
Get the child element that is not a list of statements.
Get the child element that is not a list of statements.
There is no child element that is not a list of statements.
Returns the parent token.
Accessor for the Parent attribute.
Returns the set of directories for a set of files.
This is a factory method to return an Pattern object for the specified
regular expression.
This is a factory method to return an Pattern object for the specified
regular expression and compile flags.
Returns the set PersistenceOption
.
Returns the previous sibling or null if no such sibling exists.
Get the right curly brace portion of the expression we are handling.
Get the right curly brace portion of the expression we are handling.
Get the right curly brace portion of the expression we are handling.
Get the right curly brace portion of the expression we are handling.
Get the right curly brace portion of the expression we are handling.
Get the right curly brace portion of the expression we are handling.
Provides typesafe access to the subclass specific HeaderInfo.
The tokens that this check must be registered for.
Get the right parenthesis portion of the expression we are handling.
Returns the Scope specified by the modifier set.
Get the severity level's name.
Returns the severity level of the messages generated by this module.
Returns the short description of a token for a given name.
The column in the inputfile where the text block starts.
Get the starting column for a given line number.
The line in the inputfile where the text block starts.
Create a stripped down version of a filename.
Returns the map from string representations to options.
Returns the scope of the surrounding "block".
The text content of the text block.
Returns the ID of a token for a given name.
Returns the name of a token for a given ID.
Returns the tokens registered for the check.
There is no top level expression for this handler.
Get the top level expression being managed by this handler.
There is no top level expression for this handler.
There is no top level expression for this handler.
There is no top level expression for this handler.
There is no top level expression for this handler.
Retrieves the names of the type parameters to the node.
Retrieves the type parameters to the node.
Returns the value to be displayed for node node
,
at column number column
.
Returns the value to be displayed for node node
,
at column number column
.
Determines the EJB version.
GT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >
(greater than) operator.
IDENT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes An identifier.
Handler for if statements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
Creates new instance of the check.
Checks for imports from a set of illegal packages.
Creates a new IllegalImportCheck
instance.
Checks for illegal instantiations where a factory method is preferred.
Throwing java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
Creates new instance of the check.
Checks for illegal tokens.
Checks for illegal token text.
Checks that particular class are never used as types in variable
declarations, return values or parameters.
Creates new instance of the check.
Determines whether an AST node is in the definition of a
class that implements javax.ejb.EntityBean.
Determines whether an AST node is in the definition of a
class that implements javax.ejb.SessionBean.
Check that controls what packages can be imported in each package.
Handler for import statements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Class to check the ordering/grouping of imports.
Returns whether a node is directly contained within an annotation block.
INC - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ++
(prefix increment) operator.
Returns whether the scope of a node is restricted to a code block.
Increments the current value by a specified amount.
Checks correct indentation of Java Code.
Creates a new instance of IndentationCheck.
Encapsulates representation of notion of expected indentation levels.
Creates new instance for nested structure.
Creates new instance with one accaptable indentation level.
The array index operator.
Returns whether a node is directly contained within an enum block.
Severity level: informational.
Returns whether a node is directly contained within an interface block.
Returns whether a node is directly contained within an interface or
annotation block.
init() - method in class com.puppycrawl.tools.checkstyle.api.
Check Initialse the check.
Checks for assignments in subexpressions, such as in
String s = Integer.toString(i = 2);
.
An interface declaration.
Implements Bloch, Effective Java, Item 17 -
Use Interfaces only to define types.
Checks if this comment intersects with a specified
part of the file.
Determines whether an AST defines an abstract element.
Overridden to return false, and if the event is a mouse event
it is forwarded to the tree.
By default, make the column with the Tree in it the only editable one.
Indicates whether the the value for node node
,
at column number column
is editable.
Check if given name is a name for class field in current environment.
Check if given name is a name for declafred variable/parameter/member in
current environment.
Returns whether a token represents an ELSE as part of an ELSE / IF set.
isEmpty() - method in class com.puppycrawl.tools.checkstyle.checks.indentation.
LineSet Determines if this set of lines is empty.
Tests whether a method definition AST defines an equals covariant.
Determines whether an AST defines a final element.
Returns true if this type (form TokenTypes) is handled.
Checks if given class is illegal.
Checks if this scope is a subscope of another scope.
Determines whether an AST node is in the definition of an
EJB class.
Determines whether a node is a local variable definition.
Determines whether the source of an audit event
matches the text of this tag.
Checks if a code line matches the required header line.
The JavadocMethodCheck is about to report a missing Javadoc.
Checks wether we have more than one level.
Determines whether the suppression turns checkstyle reporting on or
off.
Returns whether a node is contained in the outer most type block.
Determines whether an AST defines a public element.
Determines whether an AST node defines a public method.
Determines whether an AST node defines a public method.
Determines whether an AST node defines a public method.
Determines whether an AST defines a static element.
Checks if one class is subclass of another
Is exception is unchecked (subclass of RuntimeException
or Error
Determines whether an AST defines a void method.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
LAND - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The &&
(conditional AND) operator.
lastLine() - method in class com.puppycrawl.tools.checkstyle.checks.indentation.
LineSet Get the line number of the last line.
A left (curly) brace ({
).
LE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <=
(less than or equal) operator.
Called when exiting an AST.
Called after all the child nodes have been process.
Hook called when leaving a token.
Checks the placement of left curly braces on types, methods and
other blocks:
LITERAL_CATCH
,
LITERAL_DO
,
LITERAL_ELSE
,
LITERAL_FINALLY
,
LITERAL_FOR
,
LITERAL_IF
,
LITERAL_SWITCH
,
LITERAL_SYNCHRONIZED
,
LITERAL_TRY
,
LITERAL_WHILE
.
Creates a default instance and sets the policy to EOL.
Represents the options for placing the left curly brace '{'
.
Returns the length of a String prefix with tabs expanded.
Returns the length of a string ignoring all trailing whitespace.
Unix-style line separators.
Checks if the specified line is blank.
Checks if the specified line is a single-line comment without code.
Creates a new LineLengthCheck
instance.
Represents the options for line separator settings.
LineSet - class com.puppycrawl.tools.checkstyle.checks.indentation.
LineSet Represents a set of lines.
Represents a custom listener.
Implement this inner interface to listen for when files are dropped.
The synchronized
keyword.
LNOT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The !
(logical complement) operator.
Returns the module configurations from a specified input stream.
Returns the module configurations in a specified file.
Returns the module configurations in a specified file.
Returns the default list of package names.
Returns the package names in a specified file.
Returns the suppression filters in a specified file.
Checks that local final variable names conform to a format specified
by the format property.
Creates a new LocalFinalVariableNameCheck
instance.
Checks the local home interface requirements:
- every method must not throw the
java.rmi.RemoteException
Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 9.6.2.
Constructs a LocalHomeInterfaceCheck
.
Checks the local home interface requirements:
- every method must not throw the
java.rmi.RemoteException
Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 9.6.2.
Constructs a method checker for a local home interface check.
Checks the methods of a local interface.
Constructs a LocalInterfaceCheck
.
Checks methods of a local interface.
Constructs a LocalInterfaceMethodChecker
for a local
interface check.
Represents a message that can be localised.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Checks that local, non-final variable names conform to a format specified
by the format property.
Creates a new LocalVariableNameCheck
instance.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage for an AST.
Logs an error message for a method.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Log a message that has column information.
Helper method to log a LocalizedMessage.
Log a message that has no column information.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Log an indentation error.
Log an indentation error.
Logs error if unable to load class information.
Logs error if unable to load class information.
Logs error if unable to load class information.
Common implementation for logLoadError() method.
Helper method to log a LocalizedMessage for an AST.
Logs an error message for a method, including the method name.
LOR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ||
(conditional OR) operator.
LT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <
(less than) operator.
Checks for magic numbers.
Main - class com.puppycrawl.tools.checkstyle.
Main Wrapper command line program for the Checker.
Main - class com.puppycrawl.tools.checkstyle.gui.
Main Entry point for starting the checkstyle GUI.
Loops over the files specified checking them for errors.
Handler for member definitions.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Checks that instance variable names conform to a format specified
by the format property.
Creates a new MemberNameCheck
instance.
Checks that a MessageBean implementation satisfies MessageBean
requirements.
Constructs a MessageBeanCheck
.
Checks the methods of a message bean.
Constructs a MessageBeanMethodChecker
.
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
Handler for method calls.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Root class for method checks for a client Check.
Constructs a MethodChecker
.
Handler for method definitions.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Checks that method names conform to a format specified
by the format property.
Creates a new MethodNameCheck
instance.
Checks the padding between the identifier of a method definition,
constructor definition, method call, or constructor invocation;
and the left parenthesis of the parameter list.
Sets the pad otion to nospace.
MINUS - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The -
(subtraction) operator.
The -=
(subtraction assignment) operator.
Checks that classes (except abstract one) define a ctor and don't rely
on the default one.
Creates new instance of the check.
Checks that switch statement has "default" clause.
Creates new instance of the check.
Represents the policy that the persistence management may be
bean-managed or container-managed.
MOD - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The %
(remainder) operator.
The %=
(remainder assignment) operator.
Check for ensuring that for loop control variables are not modified
inside the for block.
Modifiers for type, method, and field declarations.
A module factory creates Objects from a given name.
Checks for multiple occurrences of the same string literal within a
single file.
Construct an instance with default values.
Checks that each variable declaration is in its own statement
and on its own line.
Creates new instance of the check.
Decides whether the name of an AST should be checked against
the format regexp.
Ensures that exceptions (defined as any class name conforming
to some regular expression) are immutable.
Creates new instance of the check.
PACKAGE - static field in class com.puppycrawl.tools.checkstyle.api.
Scope package scope.
Ensures there is a package declaration.
Handler for package definitions.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Checks that all packages have a package documentation.
Creates a new PackageHtmlCheck
instance.
Checks that package names conform to a format specified
by the format property.
Creates a new PackageNameCheck
instance.
Loads a list of package names from a package name XML file.
Represents the options for whitespace around parentheses.
Disallow assignment of parameters.
Checks that parameter names conform to a format specified
by the format property.
Creates a new ParameterNameCheck
instance.
Checks the number of parameters that a method or constructor has.
A list of parameters to a method or constructor.
Checks the padding of parentheses; that is whether a space is required
after a left parenthesis and before a right parenthesis, or such spaces are
forbidden, with the exception that it does
not check for padding of the right parenthesis at an empty for iterator.
Static helper method to parses a Java source file.
Returns the value represented by the specified string of the specified
type.
Parses a file and returns the parse tree.
Returns the value represented by the specified string of the specified
type.
Parses the specified input source.
Parses the string argument as a signed integer in the radix specified by
the second argument.
Parses the string argument as a signed long in the radix specified by
the second argument.
Displays information about a parse tree.
Create a new ParseTreeInfoPanel instance.
The model that backs the parse tree in the GUI.
Represents the policy for checking entity bean restrictions according
to whether persistence is bean-managed, container-managed, or mixed.
PLUS - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The +
(addition) operator.
The +=
(addition assignment) operator.
The --
(postfix decrement) operator.
The ++
(postfix increment) operator.
Construct an instance of this handler with the given indentation check.
PRIVATE - static field in class com.puppycrawl.tools.checkstyle.api.
Scope private scope.
Processes a set of files with all FileSetChecks.
Processes a set of files and fires errors to the MessageDispatcher.
Checks that each java file in the fileset has a package.html sibling
and fires errors for the missing files.
This method searches for property files in the specified file array
and checks whether the key usage is consistent.
Called to process an AST when visiting it.
Checks Javadoc comments for a method or constructor.
Checks exceptions declared in throws for a method or constructor.
Resolves external properties from an
underlying Properties
object.
Creates a new PropertiesExpander.
Represents a property that consists of a key and value.
Resolves properties in module configurations.
PROTECTED - static field in class com.puppycrawl.tools.checkstyle.api.
Scope protected scope.
PUBLIC - static field in class com.puppycrawl.tools.checkstyle.api.
Scope public scope.
Push the current value on the stack
Will load a specified class is such a way that it will NOT be
initialised.
Represents the policy that the brace must be on the same line as the
next statement.
Tests whether two method definition ASTs have the same parameter lists
according to type.
returns the list of files (full path name) to process.
Scope - class com.puppycrawl.tools.checkstyle.api.
Scope Represents a Java visibility scope.
Contains utility methods for working on scope.
SEMI - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The statement terminator (;
).
Checks that a SessionBean implementation satisfies SessionBean
requirements.
Constructs a SessionBeanCheck
.
Checks the methods of a session bean.
Creates a method checker for a session bean check.
Sets whether to accept or reject on matching severity level.
Sets the maximum allowed duplicates of a string.
Sets whether or now empty constructor bodies are allowed.
Sets whether or now empty method bodies are allowed.
Setter for allowInSwitchCase property.
Control whether whitespace is flagged at linebreaks.
Control whether whitespace is flagged at linebreaks.
Control whether whitespace is flagged at linebreaks.
Controls whether marker interfaces like Serializable are allowed.
Controls whether to ignore errors when there is no javadoc.
controls whether to allow a method which has parameters to omit matching
param tags in the javadoc.
Controls whether to allow a type which has type parameters to
omit matching param tags in the javadoc.
Controls whether to ignore errors when there is no javadoc for a
property accessor (setter/getter methods).
controls whether to allow a method which returns non-void type to omit
the return tag in the javadoc.
controls whether to allow a method which declares that it throws
exceptions to omit matching throws tags in the javadoc.
Getter for allowSubclasses property.
controls whether to allow documented exception that are subclass of one
of declared exceptions.
Getter for allowUnchecked property.
controls whether to allow documented exceptions that are not declared if
they are a subclass of java.lang.RuntimeException.
Sets whether we should apply the check to package-private members.
Sets whether we should apply the check to private members.
Sets whether we should apply the check to protected members.
Sets whether we should apply the check to public members.
Set the author tag pattern.
Adjusts brace indentation (positive offset).
Set the case indentation level.
Sets whether string comparision should be case sensitive
or not.
Set whether to look in C comments.
Set whether to look in C++ comments.
Sets the flag that determines if empty JavaDoc checking should be done.
Setter for checkFields property.
Sets the flag that determines if the first sentence is checked for
proper end of sentence punctuation.
Set the format for a check.
Sets the flag that determines if HTML checking is to be performed.
Configures whether we need to check last case group or not.
Setter for checkMethods property.
Set the check class pattern.
Sets the classes that are illegal to instantiate.
Set the class loader associated with the tree.
Sets the classloader that is used to contextualize filesetchecks.
Sets the maximum ncss for a class.
Set the class path from a reference defined elsewhere.
Sets the CSV values and ranges for column number filtering.
Set the compile flags for the regular expression.
Sets the maximum number of instances of required pattern allowed.
Sets the limit on the number of errors to report.
Set the excluded classes pattern.
Sets the list of packages to exempt from the check.
Tells this task to set the named property to "true" when there
is a violation.
Set the parameter for the file containing the import control
configuration.
Loads the suppressions for a file.
Set the file contents associated with the tree.
Set the FileContents for this filter.
Sets the file extensions that identify the files that pass the
filter of this FileSetCheck.
Sets the maximum ncss for a file.
Sets this AST's first Child.
Set the format to the specified regular expression.
sets the list of package groups and the order they should
occur in the file.
Set the header to check against.
Set the header to check against.
Set the header file to check against.
Set the header file to check against.
Sets the identifer of the reporter.
Set whether to ignore parameters of abstract methods.
Set whether or not the match is case sensitive.
Sets if comments should be ignored.
Sets if matches within comments should be ignored.
Set whether to ignore constructor parameters.
Set the list of ignore method names.
Set the ignore format to the specified regular expression.
Set the lines numbers to ignore in the header check.
Sets the numbers to ignore in the check.
Set whether to ignore the parameter of a property setter method.
Sets regexp pattern for ignored strings.
Set the list of illegal classes.
Set the list of illegal variable types.
Sets if pattern is illegal, otherwise pattern is required.
Set the list of illegal packages.
Controls whether to check for Java or C style.
Set the list of legal abstract class names.
Sets patter for legal trailing comments.
Sets the tokens which occurance as descendant is limited.
Sets the CSV values and ranges for line number filtering.
Sets the line separator to one of 'crlf', 'lf' or 'cr'.
Controls whether to log class loading errors to the checkstyle report
instead of throwing a RTE.
Sets maximul allowed complexity.
Set the maximum threshold allowed.
Setter for maximum allowed nesting depth.
Setter for maximum allowed complexity.
Sets the maximum threshold.
Sets the maximum number of allowed parameters.
Sets the maximum number of errors allowed.
Sets the maximum depth for descendant counts.
Sets the error message for maximum count exceeded.
Sets a maximum count for descendants.
Sets the maximum line length used in calculating the placement of the
left curly brace.
Sets the maximum number of warings allowed.
Setter for message property.
Setter for message property.
Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
Set the format for a message.
Set the global object used to collect messages.
Sets the method checker for this component check.
Sets the maximum ncss for a method.
Sets the minimum number of lines that must be equivalent
before the check complains.
Sets the mimimum depth for descendant counts.
Sets the error message for minimum count not reached.
Sets a minimum count for descendants.
Sets the factory for creating submodules.
Sets the module factory for creating child modules (Checks).
Set the module id for filtering.
Set the lines numbers to repeat in the header check.
Set the lines numbers to repeat in the header check.
Set the format for a comment that turns off reporting.
Set the format for a comment that turns on reporting.
Set the option to enforce.
Sets whether or not imports should be ordered within any one
group of imports.
Set whether package visible members are allowed.
Set the persistence option to enforce.
Sets a properties file for use instead
of individually setting them.
Set whether protected members are allowed.
Set the pattern for public members to ignore.
Overridden to pass the new rowHeight to the tree.
Sets whether or not groups of imports must be separated from
one another by at least one blank line.
Does the check need to check if rcurly starts line.
Controls whether to show class loading errors in the checkstyle report.
Set the tab width to report errors with.
Sets the tag severity level.
Set the file to output to.
Adds a set of tokens the check is interested in.
Set the type of the formatter.
Called by configure() for every child of this component's Configuration.
Instantiates, configures and registers a child AbstractFilter
or FileSetCheck
that is specified in the provided configuration.
Instantiates, configures and registers a Check that is specified
in the provided configuration.
Sets whether or not we write to a file if it is provided.
Sets the value for node node
,
at column number column
.
Sets the value for node node
,
at column number column
.
Sets the value for node node
,
at column number column
.
Set the version format pattern.
Severity level for a check violation.
An audit listener that counts how many
AuditEvents
of a given severity have been generated.
This is a very simple filter based on severity matching.
Checks for overly complicated boolean expressions.
Checks for overly complicated boolean return statements.
SL - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <<
(shift left) operator.
The <<=
(left shift assignment) operator.
SLIST - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes A list of statements.
Handler for a list of statements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
SPACE - static field in class com.puppycrawl.tools.checkstyle.checks.whitespace.
PadOption Represents mandatory spacing following a left parenthesis
and preceeing a right one.
SR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >>
(signed shift right) operator.
The >>=
(signed right shift assignment)
operator.
STAR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The *
(multiplication or wildcard) operator.
The *=
(multiplication assignment) operator.
Determines if the given expression is at the start of a line.
A static import declaration.
A static initialization block.
Handler for static initialization blocks.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
Checks that static, non-final variable names conform to a format specified
by the format property.
Creates a new StaticVariableNameCheck
instance.
STMT - static field in class com.puppycrawl.tools.checkstyle.checks.blocks.
BlockOption Represents the policy that there is a statement in the block.
Performs a line-by-line comparison of all code lines and reports
duplicate code if a sequence of lines differs only in
indentation.
Creates a new instance of this class.
Checks that string literals are not used with
==
or !=
.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
Indentation level suggested for a child element.
A super constructor call.
Checks that an overriding clone() method invokes super.clone().
Checks that an overriding finalize() method invokes super.finalize().
This filter processes
AuditEvent
objects based on the criteria of file, check, module id, line, and
column.
Constructs a SuppressElement
for a
file name pattern.
A filter that uses comments to suppress audit events.
Constructs a SuppressionCommentFilter.
This filter accepts AuditEvents according to file, check, line, and
column, as specified in a suppression file.
Loads a filter chain of suppressions.
Handler for switch statements.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
System default line separators.
Reports tab characters ('\t') in the source code.
A Tag holds a suppression comment and its location, and determines
whether the supression turns checkstyle reporting on or off.
TEXT - static field in class com.puppycrawl.tools.checkstyle.checks.blocks.
BlockOption Represents the policy that there is some text in the block.
A block of text from an inputfile that does not necessarily
have any grammatical structure.
Checks that 'this' is not a parameter of any method calls
or constructors for a bean.
Checks that 'this' is not returned by a bean method.
Restricts throws statements to a specified count (default = 1).
Creates new instance of the check.
A check for TODO comments.
Creates a new TodoCommentCheck
instance.
Represents text element with location in the text.
Converts FullIdent to Token.
Contains the constants for all the tokens contained in the Abstract
Syntax Tree.
Determines if the top level token must start the line.
Determines if the top level token must start the line.
Determines if the top level token must start the line.
Determines if the top level token must start the line.
toString() - method in class com.puppycrawl.tools.checkstyle.checks.indentation.
LineSet
The check to ensure that requires that comments be the only thing on a line.
Creates new instance of the check.
The TranslationCheck class helps to ensure the correct translation of code by
checking property files for consistency regarding their keys.
Creates a new TranslationCheck
instance.
TreeTableCellEditor implementation.
TreeTableModel is the model used by a JTreeTable.
This is a wrapper class takes a TreeTableModel and implements
the table model interface.
Responsible for walking an abstract syntax tree and notifying interested
checks at each each node.
Creates a new TreeWalker
instance.
Construct an instance of this handler with the given indentation check,
abstract syntax tree, and parent handler.
TYPE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes A type.
A type arguments to a type reference or a method/ctor invocation.
A list of type arguments to a type reference or
a method/ctor invocation.
'&' symbol when used in a generic upper or lower bounds constrain
e.g.
A lower bounds on a wildcard type argument.
A type parameter to a class, interface or method definition.
A list of type parameters to a class, interface or
method definition.
An upper bounds on a wildcard type argument or type parameter.
Checks the padding of parentheses for typecasts.
Checks that type names conform to a format specified
by the format property.
Creates a new TypeNameCheck
instance.