A B C D E F G H I J L M N P R S T W X

A

addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

Print an Emacs compliant line on the error stream.

addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that an audit error was discovered on a specific file

addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

addException(AuditEvent, Throwable) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that an exception happened while performing audit

addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Adds a set of files (nested fileset attribute).

addFormatter(CheckStyleTask.Formatter) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Add a formatter

addListener(AuditListener) - Method in class com.puppycrawl.tools.checkstyle.Checker

Add the listener that will be used to receive events from the audit

addProperty(CheckStyleTask.Property) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Add an override property

ALL_BLOCK_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the block properties

ALL_BOOLEAN_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the properties that are a boolean.

ALL_INT_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the integer properties

ALL_LCURLY_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the LeftCurlyOption properties

ALL_PATTERN_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the properties that are a regulare expression

ALL_STRING_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the String properties

ALL_STRING_SET_PROPS - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

All the String Set properties.

ALLOW_NO_AUTHOR_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for allowing no author

ALLOW_PACKAGE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for allowing package data

ALLOW_PROTECTED_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for allowing protected data

ALLOW_TABS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for allowing tabs

ALONE - Static variable in class com.puppycrawl.tools.checkstyle.RightCurlyOption

represents placing the brace alone on a line

AuditEvent - class com.puppycrawl.tools.checkstyle.AuditEvent.

Raw event for audit.

AuditEvent(Object) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent

Creates a new instance.

AuditEvent(Object, String) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent

Creates a new AuditEvent instance.

AuditEvent(Object, String, LocalizedMessage) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent

Creates a new AuditEvent instance.

auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that the audit is finished

AuditListener - interface com.puppycrawl.tools.checkstyle.AuditListener.

Listener in charge of receiving events from the Checker.

auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that the audit is about to start

B

BASEDIR_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the base directory

BlockOption - class com.puppycrawl.tools.checkstyle.BlockOption.

Represents the options for a block.

C

CACHE_FILE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for cache file

CATCH_BLOCK_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for catch block options

Checker - class com.puppycrawl.tools.checkstyle.Checker.

This class provides the functionality to check a set of files.

Checker(Configuration) - Constructor for class com.puppycrawl.tools.checkstyle.Checker

Constructs the object.

CheckStyleTask - class com.puppycrawl.tools.checkstyle.CheckStyleTask.

An implementation of a ANT task for calling checkstyle.

CheckStyleTask.Formatter - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter.

Details about a formatter to be used.

CheckStyleTask.Formatter() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter

CheckStyleTask.FormatterType - class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType.

Poor mans enumeration for the formatter types.

CheckStyleTask.FormatterType() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType

CheckStyleTask.Property - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property.

Represents a property that consists of a key and value.

CheckStyleTask.Property() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

CheckStyleTask() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask

closeStreams() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

Flushes the output streams and closes them if needed.

com.puppycrawl.tools.checkstyle - package com.puppycrawl.tools.checkstyle

compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.Scope

compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage

Configuration - class com.puppycrawl.tools.checkstyle.Configuration.

Represents the configuration that checkstyle uses when checking.

Configuration() - Constructor for class com.puppycrawl.tools.checkstyle.Configuration

Creates a new Configuration instance.

Configuration(Properties, PrintStream) - Constructor for class com.puppycrawl.tools.checkstyle.Configuration

Creates a new Configuration instance.

CONST_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the static final variable pattern

createClasspath() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

createListener(Task) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter

Creates a listener for the formatter.

D

decode(String) - Static method in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

Returns the LeftCurlyOption specified by a string representation.

decode(String) - Static method in class com.puppycrawl.tools.checkstyle.WrapOpOption

Returns the option specified by a string representation.

decode(String) - Static method in class com.puppycrawl.tools.checkstyle.PadOption

Returns the option specified by a string representation.

decode(String) - Static method in class com.puppycrawl.tools.checkstyle.RightCurlyOption

Returns the RightCurlyOption specified by a string representation.

decode(String) - Static method in class com.puppycrawl.tools.checkstyle.BlockOption

Returns the BlockOption specified by a string representation.

DefaultLogger - class com.puppycrawl.tools.checkstyle.DefaultLogger.

Simple plain logger for text output.

DefaultLogger(OutputStream, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger

Creates a new DefaultLogger instance.

DefaultLogger(OutputStream, boolean, OutputStream, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger

Creates a new DefaultLogger instance.

Defn - interface com.puppycrawl.tools.checkstyle.Defn.

Contains definitions common to the package.

destroy() - Method in class com.puppycrawl.tools.checkstyle.Checker

Cleans up the object

E

encode(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

Escape <, > & ' and " as their entities.

EOL - Static variable in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

represents placing the brace at the end of line

EOL - Static variable in class com.puppycrawl.tools.checkstyle.WrapOpOption

represents operator at end of line

execute() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Actually checks the files specified.

F

fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

fileFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that audit is finished on a specific file

fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger

fileStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener

notify that audit is about to start on a specific file

FINALLY_BLOCK_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for finally block options

fireAuditFinished() - Method in class com.puppycrawl.tools.checkstyle.Checker

notify all listeners about the audit end

fireAuditStarted() - Method in class com.puppycrawl.tools.checkstyle.Checker

notify all listeners about the audit start

fireErrors(String, LocalizedMessage[]) - Method in class com.puppycrawl.tools.checkstyle.Checker

notify all listeners about the errors in a file.

fireFileFinished(String) - Method in class com.puppycrawl.tools.checkstyle.Checker

notify all listeners about the end of a file audit

fireFileStarted(String) - Method in class com.puppycrawl.tools.checkstyle.Checker

notify all listeners about the beginning of a file audit

G

getColumn() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent

getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage

getFileName() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent

getKey() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

getLine() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent

return the line number on the source file where the event occurred.

getLineNo() - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage

getListeners() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Return the list of listeners set in this task.

getLocalizedMessage() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent

getMessage() - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage

getMessage() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent

return the message associated to the event.

getPackagePat() - Method in class com.puppycrawl.tools.checkstyle.Configuration

getPackageRegexp() - Method in class com.puppycrawl.tools.checkstyle.Configuration

getProperties() - Method in class com.puppycrawl.tools.checkstyle.Configuration

getValue() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

getValues() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType

H

HEADER_FILE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for header file

HEADER_IGNORE_LINE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for line in header file to ignore

HEADER_LINES_REGEXP_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for header file line interpretation as regexps

I

IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

represents ignoring the placement

IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.WrapOpOption

represents ignoring the wrapping

IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.PadOption

represents ignoring the spacing

IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.RightCurlyOption

represents ignoring the placement

IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.BlockOption

represents ignoring blocks

IGNORE_BRACES_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring braces

IGNORE_CAST_WHITESPACE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring whitespace after casts

IGNORE_IMPORT_LENGTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring line length of import statements

IGNORE_IMPORTS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring import statements

IGNORE_LINE_LENGTH_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the line length check exclusion pattern

IGNORE_LONG_ELL_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring long 'L'

IGNORE_PUBLIC_IN_INTERFACE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring 'public' in interface definitions

IGNORE_WHITESPACE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for ignoring whitespace

ILLEGAL_IMPORTS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for illegal import statements

ILLEGAL_INSTANTIATIONS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for illegal instantiations

isReference(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger

J

JAVADOC_CHECK_UNUSED_THROWS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for checking for Runtime @throws in Javadoc

JAVADOC_CHECKSCOPE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for visibility scope where Javadoc is checked

L

LCURLY_METHOD_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for lcurly placement for methods

LCURLY_OTHER_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for lcurly placement for others

LCURLY_TYPE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for lcurly placement for types

LeftCurlyOption - class com.puppycrawl.tools.checkstyle.LeftCurlyOption.

Represents the options for placing the left curly brace '{'.

LOCAL_FINAL_VAR_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the method local final variable pattern

LOCAL_VAR_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the method local variable pattern

LOCALE_COUNTRY_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the locale country for reporting

LOCALE_LANGUAGE_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the locale language for reporting

LocalizedMessage - class com.puppycrawl.tools.checkstyle.LocalizedMessage.

Represents message that can be localised.

M

Main - class com.puppycrawl.tools.checkstyle.Main.

Wrapper command line program for the Checker.

Main() - Constructor for class com.puppycrawl.tools.checkstyle.Main

main(String[]) - Static method in class com.puppycrawl.tools.checkstyle.Main

Loops over the files specified checking them for errors.

MAX_CONSTRUCTOR_LENGTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for length of constructors

MAX_FILE_LENGTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for length of files

MAX_LINE_LENGTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the maximum line length

MAX_METHOD_LENGTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for length of methods

MAX_PARAMETERS_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for maximum number of parameters

MEMBER_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the member variable pattern

METHOD_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the method local variable pattern

N

NL - Static variable in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

represents placing on a new line

NL - Static variable in class com.puppycrawl.tools.checkstyle.WrapOpOption

represents operator on a new line

NLOW - Static variable in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

represents placing on the end of the line if it fits on the first line, otherwise placing on a new line.

NOSPACE - Static variable in class com.puppycrawl.tools.checkstyle.PadOption

represents no spacing

P

PACKAGE_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the package name pattern

PadOption - class com.puppycrawl.tools.checkstyle.PadOption.

Represents the options for whitespace around parenthesis.

PARAMETER_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the parameter pattern

PAREN_PAD_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for padding around parenthesis

process(String[]) - Method in class com.puppycrawl.tools.checkstyle.Checker

Processes a set of files.

PUBLIC_MEMBER_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the public member variable pattern

R

RCURLY_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for rcurly placement

REQUIRE_PACKAGE_HTML_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for requiring package documentation

REQUIRE_VERSION_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for requiring a version tag

RightCurlyOption - class com.puppycrawl.tools.checkstyle.RightCurlyOption.

Represents the options for placing the right curly brace '}'.

S

SAME - Static variable in class com.puppycrawl.tools.checkstyle.RightCurlyOption

represents placing the brace on the same line

scanFileSets() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

returns the list of files (full path name) to process.

Scope - class com.puppycrawl.tools.checkstyle.Scope.

Represents a Java visibility scope.

setClassLoader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.Configuration

Set the class loader for locating classes.

setClasspath(Path) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Set the class path.

setFailOnViolation(boolean) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

setFailureProperty(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Tells this task to set the named property to "true" when there is a violation.

setFile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

setFile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

setKey(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

setProperties(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask

Sets a properties file for use instead of individually setting them.

setTofile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter

Set the file to output to.

setType(CheckStyleTask.FormatterType) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter

Set the type of the formatter.

setValue(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property

SPACE - Static variable in class com.puppycrawl.tools.checkstyle.PadOption

represents mandatory spacing

STATIC_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the static variable pattern

STMT - Static variable in class com.puppycrawl.tools.checkstyle.BlockOption

represents requiring a statement in the block

T

TAB_WIDTH_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for allowing protected data

TEXT - Static variable in class com.puppycrawl.tools.checkstyle.BlockOption

represents requiring some text in the block

TODO_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the to-do pattern

toString() - Method in class com.puppycrawl.tools.checkstyle.LeftCurlyOption

toString() - Method in class com.puppycrawl.tools.checkstyle.WrapOpOption

toString() - Method in class com.puppycrawl.tools.checkstyle.PadOption

toString() - Method in class com.puppycrawl.tools.checkstyle.RightCurlyOption

toString() - Method in class com.puppycrawl.tools.checkstyle.Scope

toString() - Method in class com.puppycrawl.tools.checkstyle.BlockOption

TRY_BLOCK_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for try block options

TYPE_PATTERN_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for the type pattern

W

WRAP_OP_PROP - Static variable in interface com.puppycrawl.tools.checkstyle.Defn

property name for wrapping lines on operators

WrapOpOption - class com.puppycrawl.tools.checkstyle.WrapOpOption.

Represents the options for wrapping on operators.

X

XMLLogger - class com.puppycrawl.tools.checkstyle.XMLLogger.

Simple XML logger.

XMLLogger(OutputStream, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.XMLLogger

Creates a new XMLLogger instance.

A B C D E F G H I J L M N P R S T W X