com.puppycrawl.tools.checkstyle
Interface Defn

All Known Implementing Classes:

Checker

public interface Defn

Contains definitions common to the package. Very important that all boolean properties default to false.

Author:

Oliver Burn

Field Summary

static java.lang.String[]	ALL_BLOCK_PROPS All the block properties
static java.lang.String[]	ALL_BOOLEAN_PROPS All the properties that are a boolean.
static java.lang.String[]	ALL_INT_PROPS All the integer properties
static java.lang.String[]	ALL_LCURLY_PROPS All the LeftCurlyOption properties
static java.lang.String[]	ALL_PATTERN_PROPS All the properties that are a regulare expression
static java.lang.String[]	ALL_STRING_PROPS All the String properties
static java.lang.String[]	ALL_STRING_SET_PROPS All the String Set properties.
static java.lang.String	ALLOW_NO_AUTHOR_PROP property name for allowing no author
static java.lang.String	ALLOW_PACKAGE_PROP property name for allowing package data
static java.lang.String	ALLOW_PROTECTED_PROP property name for allowing protected data
static java.lang.String	ALLOW_TABS_PROP property name for allowing tabs
static java.lang.String	BASEDIR_PROP property name for the base directory
static java.lang.String	CACHE_FILE_PROP property name for cache file
static java.lang.String	CATCH_BLOCK_PROP property name for catch block options
static java.lang.String	CONST_PATTERN_PROP property name for the static final variable pattern
static java.lang.String	FINALLY_BLOCK_PROP property name for finally block options
static java.lang.String	HEADER_FILE_PROP property name for header file
static java.lang.String	HEADER_IGNORE_LINE_PROP property name for line in header file to ignore
static java.lang.String	HEADER_LINES_REGEXP_PROP property name for header file line interpretation as regexps
static java.lang.String	IGNORE_BRACES_PROP property name for ignoring braces
static java.lang.String	IGNORE_CAST_WHITESPACE_PROP property name for ignoring whitespace after casts
static java.lang.String	IGNORE_IMPORT_LENGTH_PROP property name for ignoring line length of import statements
static java.lang.String	IGNORE_IMPORTS_PROP property name for ignoring import statements
static java.lang.String	IGNORE_LINE_LENGTH_PATTERN_PROP property name for the line length check exclusion pattern
static java.lang.String	IGNORE_LONG_ELL_PROP property name for ignoring long 'L'
static java.lang.String	IGNORE_PUBLIC_IN_INTERFACE_PROP property name for ignoring 'public' in interface definitions
static java.lang.String	IGNORE_WHITESPACE_PROP property name for ignoring whitespace
static java.lang.String	ILLEGAL_IMPORTS_PROP property name for illegal import statements
static java.lang.String	ILLEGAL_INSTANTIATIONS_PROP property name for illegal instantiations
static java.lang.String	JAVADOC_CHECK_UNUSED_THROWS_PROP property name for checking for Runtime @throws in Javadoc
static java.lang.String	JAVADOC_CHECKSCOPE_PROP property name for visibility scope where Javadoc is checked
static java.lang.String	LCURLY_METHOD_PROP property name for lcurly placement for methods
static java.lang.String	LCURLY_OTHER_PROP property name for lcurly placement for others
static java.lang.String	LCURLY_TYPE_PROP property name for lcurly placement for types
static java.lang.String	LOCAL_FINAL_VAR_PATTERN_PROP property name for the method local final variable pattern
static java.lang.String	LOCAL_VAR_PATTERN_PROP property name for the method local variable pattern
static java.lang.String	LOCALE_COUNTRY_PROP property name for the locale country for reporting
static java.lang.String	LOCALE_LANGUAGE_PROP property name for the locale language for reporting
static java.lang.String	MAX_CONSTRUCTOR_LENGTH_PROP property name for length of constructors
static java.lang.String	MAX_FILE_LENGTH_PROP property name for length of files
static java.lang.String	MAX_LINE_LENGTH_PROP property name for the maximum line length
static java.lang.String	MAX_METHOD_LENGTH_PROP property name for length of methods
static java.lang.String	MAX_PARAMETERS_PROP property name for maximum number of parameters
static java.lang.String	MEMBER_PATTERN_PROP property name for the member variable pattern
static java.lang.String	METHOD_PATTERN_PROP property name for the method local variable pattern
static java.lang.String	PACKAGE_PATTERN_PROP property name for the package name pattern
static java.lang.String	PARAMETER_PATTERN_PROP property name for the parameter pattern
static java.lang.String	PAREN_PAD_PROP property name for padding around parenthesis
static java.lang.String	PUBLIC_MEMBER_PATTERN_PROP property name for the public member variable pattern
static java.lang.String	RCURLY_PROP property name for rcurly placement
static java.lang.String	REQUIRE_PACKAGE_HTML_PROP property name for requiring package documentation
static java.lang.String	REQUIRE_VERSION_PROP property name for requiring a version tag
static java.lang.String	STATIC_PATTERN_PROP property name for the static variable pattern
static java.lang.String	TAB_WIDTH_PROP property name for allowing protected data
static java.lang.String	TODO_PATTERN_PROP property name for the to-do pattern
static java.lang.String	TRY_BLOCK_PROP property name for try block options
static java.lang.String	TYPE_PATTERN_PROP property name for the type pattern
static java.lang.String	WRAP_OP_PROP property name for wrapping lines on operators

Field Detail

TODO_PATTERN_PROP

public static final java.lang.String TODO_PATTERN_PROP

property name for the to-do pattern

See Also:

Constant Field Values

PARAMETER_PATTERN_PROP

public static final java.lang.String PARAMETER_PATTERN_PROP

property name for the parameter pattern

See Also:

Constant Field Values

STATIC_PATTERN_PROP

public static final java.lang.String STATIC_PATTERN_PROP

property name for the static variable pattern

See Also:

Constant Field Values

CONST_PATTERN_PROP

public static final java.lang.String CONST_PATTERN_PROP

property name for the static final variable pattern

See Also:

Constant Field Values

MEMBER_PATTERN_PROP

public static final java.lang.String MEMBER_PATTERN_PROP

property name for the member variable pattern

See Also:

Constant Field Values

PUBLIC_MEMBER_PATTERN_PROP

public static final java.lang.String PUBLIC_MEMBER_PATTERN_PROP

property name for the public member variable pattern

See Also:

Constant Field Values

TYPE_PATTERN_PROP

public static final java.lang.String TYPE_PATTERN_PROP

property name for the type pattern

See Also:

Constant Field Values

LOCAL_VAR_PATTERN_PROP

public static final java.lang.String LOCAL_VAR_PATTERN_PROP

property name for the method local variable pattern

See Also:

Constant Field Values

LOCAL_FINAL_VAR_PATTERN_PROP

public static final java.lang.String LOCAL_FINAL_VAR_PATTERN_PROP

property name for the method local final variable pattern

See Also:

Constant Field Values

METHOD_PATTERN_PROP

public static final java.lang.String METHOD_PATTERN_PROP

property name for the method local variable pattern

See Also:

Constant Field Values

PACKAGE_PATTERN_PROP

public static final java.lang.String PACKAGE_PATTERN_PROP

property name for the package name pattern

See Also:

Constant Field Values

MAX_LINE_LENGTH_PROP

public static final java.lang.String MAX_LINE_LENGTH_PROP

property name for the maximum line length

See Also:

Constant Field Values

MAX_METHOD_LENGTH_PROP

public static final java.lang.String MAX_METHOD_LENGTH_PROP

property name for length of methods

See Also:

Constant Field Values

MAX_CONSTRUCTOR_LENGTH_PROP

public static final java.lang.String MAX_CONSTRUCTOR_LENGTH_PROP

property name for length of constructors

See Also:

Constant Field Values

MAX_FILE_LENGTH_PROP

public static final java.lang.String MAX_FILE_LENGTH_PROP

property name for length of files

See Also:

Constant Field Values

MAX_PARAMETERS_PROP

public static final java.lang.String MAX_PARAMETERS_PROP

property name for maximum number of parameters

See Also:

Constant Field Values

ALLOW_TABS_PROP

public static final java.lang.String ALLOW_TABS_PROP

property name for allowing tabs

See Also:

Constant Field Values

TAB_WIDTH_PROP

public static final java.lang.String TAB_WIDTH_PROP

property name for allowing protected data

See Also:

Constant Field Values

ALLOW_PROTECTED_PROP

public static final java.lang.String ALLOW_PROTECTED_PROP

property name for allowing protected data

See Also:

Constant Field Values

ALLOW_PACKAGE_PROP

public static final java.lang.String ALLOW_PACKAGE_PROP

property name for allowing package data

See Also:

Constant Field Values

ALLOW_NO_AUTHOR_PROP

public static final java.lang.String ALLOW_NO_AUTHOR_PROP

property name for allowing no author

See Also:

Constant Field Values

HEADER_FILE_PROP

public static final java.lang.String HEADER_FILE_PROP

property name for header file

See Also:

Constant Field Values

HEADER_IGNORE_LINE_PROP

public static final java.lang.String HEADER_IGNORE_LINE_PROP

property name for line in header file to ignore

See Also:

Constant Field Values

HEADER_LINES_REGEXP_PROP

public static final java.lang.String HEADER_LINES_REGEXP_PROP

property name for header file line interpretation as regexps

See Also:

Constant Field Values

JAVADOC_CHECKSCOPE_PROP

public static final java.lang.String JAVADOC_CHECKSCOPE_PROP

property name for visibility scope where Javadoc is checked

See Also:

Constant Field Values

JAVADOC_CHECK_UNUSED_THROWS_PROP

public static final java.lang.String JAVADOC_CHECK_UNUSED_THROWS_PROP

property name for checking for Runtime @throws in Javadoc

See Also:

Constant Field Values

REQUIRE_PACKAGE_HTML_PROP

public static final java.lang.String REQUIRE_PACKAGE_HTML_PROP

property name for requiring package documentation

See Also:

Constant Field Values

REQUIRE_VERSION_PROP

public static final java.lang.String REQUIRE_VERSION_PROP

property name for requiring a version tag

See Also:

Constant Field Values

IGNORE_IMPORTS_PROP

public static final java.lang.String IGNORE_IMPORTS_PROP

property name for ignoring import statements

See Also:

Constant Field Values

ILLEGAL_IMPORTS_PROP

public static final java.lang.String ILLEGAL_IMPORTS_PROP

property name for illegal import statements

See Also:

Constant Field Values

ILLEGAL_INSTANTIATIONS_PROP

public static final java.lang.String ILLEGAL_INSTANTIATIONS_PROP

property name for illegal instantiations

See Also:

Constant Field Values

IGNORE_LINE_LENGTH_PATTERN_PROP

public static final java.lang.String IGNORE_LINE_LENGTH_PATTERN_PROP

property name for the line length check exclusion pattern

See Also:

Constant Field Values

IGNORE_WHITESPACE_PROP

public static final java.lang.String IGNORE_WHITESPACE_PROP

property name for ignoring whitespace

See Also:

Constant Field Values

IGNORE_CAST_WHITESPACE_PROP

public static final java.lang.String IGNORE_CAST_WHITESPACE_PROP

property name for ignoring whitespace after casts

See Also:

Constant Field Values

IGNORE_BRACES_PROP

public static final java.lang.String IGNORE_BRACES_PROP

property name for ignoring braces

See Also:

Constant Field Values

IGNORE_LONG_ELL_PROP

public static final java.lang.String IGNORE_LONG_ELL_PROP

property name for ignoring long 'L'

See Also:

Constant Field Values

IGNORE_PUBLIC_IN_INTERFACE_PROP

public static final java.lang.String IGNORE_PUBLIC_IN_INTERFACE_PROP

property name for ignoring 'public' in interface definitions

See Also:

Constant Field Values

CACHE_FILE_PROP

public static final java.lang.String CACHE_FILE_PROP

property name for cache file

See Also:

Constant Field Values

IGNORE_IMPORT_LENGTH_PROP

public static final java.lang.String IGNORE_IMPORT_LENGTH_PROP

property name for ignoring line length of import statements

See Also:

Constant Field Values

LCURLY_METHOD_PROP

public static final java.lang.String LCURLY_METHOD_PROP

property name for lcurly placement for methods

See Also:

Constant Field Values

LCURLY_TYPE_PROP

public static final java.lang.String LCURLY_TYPE_PROP

property name for lcurly placement for types

See Also:

Constant Field Values

LCURLY_OTHER_PROP

public static final java.lang.String LCURLY_OTHER_PROP

property name for lcurly placement for others

See Also:

Constant Field Values

RCURLY_PROP

public static final java.lang.String RCURLY_PROP

property name for rcurly placement

See Also:

Constant Field Values

PAREN_PAD_PROP

public static final java.lang.String PAREN_PAD_PROP

property name for padding around parenthesis

See Also:

Constant Field Values

TRY_BLOCK_PROP

public static final java.lang.String TRY_BLOCK_PROP

property name for try block options

See Also:

Constant Field Values

CATCH_BLOCK_PROP

public static final java.lang.String CATCH_BLOCK_PROP

property name for catch block options

See Also:

Constant Field Values

FINALLY_BLOCK_PROP

public static final java.lang.String FINALLY_BLOCK_PROP

property name for finally block options

See Also:

Constant Field Values

BASEDIR_PROP

public static final java.lang.String BASEDIR_PROP

property name for the base directory

See Also:

Constant Field Values

WRAP_OP_PROP

public static final java.lang.String WRAP_OP_PROP

property name for wrapping lines on operators

See Also:

Constant Field Values

LOCALE_LANGUAGE_PROP

public static final java.lang.String LOCALE_LANGUAGE_PROP

property name for the locale language for reporting

See Also:

Constant Field Values

LOCALE_COUNTRY_PROP

public static final java.lang.String LOCALE_COUNTRY_PROP

property name for the locale country for reporting

See Also:

Constant Field Values

ALL_BOOLEAN_PROPS

public static final java.lang.String[] ALL_BOOLEAN_PROPS

All the properties that are a boolean. They all must default to false

ALL_PATTERN_PROPS

public static final java.lang.String[] ALL_PATTERN_PROPS

All the properties that are a regulare expression

ALL_INT_PROPS

public static final java.lang.String[] ALL_INT_PROPS

All the integer properties

ALL_BLOCK_PROPS

public static final java.lang.String[] ALL_BLOCK_PROPS

All the block properties

ALL_STRING_PROPS

public static final java.lang.String[] ALL_STRING_PROPS

All the String properties

ALL_LCURLY_PROPS

public static final java.lang.String[] ALL_LCURLY_PROPS

All the LeftCurlyOption properties

ALL_STRING_SET_PROPS

public static final java.lang.String[] ALL_STRING_SET_PROPS

All the String Set properties. That is, set of String values that are seperated by a ",".