Uses of Interface
com.puppycrawl.tools.checkstyle.api.Contextualizable

Packages that use Contextualizable

Package	Description
com.puppycrawl.tools.checkstyle	Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api	Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks	Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.annotation	Contains the Annotation checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.blocks	Contains the Block checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.coding	Contains the Coding checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.design	Contains the Class Design checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.header	File Header checks.
com.puppycrawl.tools.checkstyle.checks.imports	Contains the Imports checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.indentation	Contains all classes required for the indentation check.
com.puppycrawl.tools.checkstyle.checks.javadoc	Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.metrics	Contains the Metrics checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.modifier	Contains the modifier checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.naming	Contains the Naming conventions checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.regexp	Contains the regular expression checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.sizes	Contains the Size Violations checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.whitespace	Contains the Whitespace checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filters	Contains the filters that are bundled with the main distribution.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle

Classes in com.puppycrawl.tools.checkstyle that implement Contextualizable

Modifier and Type	Class and Description
class	Checker This class provides the functionality to check a set of files.
class	DefaultLogger Simple plain logger for text output.
class	TreeWalker Responsible for walking an abstract syntax tree and notifying interested checks at each each node.
class	XMLLogger Simple XML logger.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.api

Subinterfaces of Contextualizable in com.puppycrawl.tools.checkstyle.api

Modifier and Type	Interface and Description
interface	FileSetCheck Interface for Checking a set of files for some criteria.

Classes in com.puppycrawl.tools.checkstyle.api that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractFileSetCheck Provides common functionality for many FileSetChecks.
class	AbstractViolationReporter Serves as an abstract base class for all modules that report inspection findings.
class	AutomaticBean A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.
class	Check The base class for checks.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks

Classes in com.puppycrawl.tools.checkstyle.checks that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractFormatCheck Abstract class for checks that verify strings using a regular expression.
class	AbstractOptionCheck<T extends Enum<T>> Abstract class for checks with a parameter named option, where the option is identified by a Enum.
class	AbstractTypeAwareCheck Deprecated. Checkstyle is not type aware tool and all Checks derived from this class are potentially unstable.
class	ArrayTypeStyleCheck Checks the style of array type definitions.
class	AvoidEscapedUnicodeCharactersCheck Restrict using Unicode escapes (e.g.
class	DeclarationCollector Abstract class for checks which need to collect information about declared members/parameters/variables.
class	DescendantTokenCheck Checks for restricted tokens beneath other tokens.
class	FileContentsHolder Holds the current file contents for global access when configured as a TreeWalker sub-module.
class	FinalParametersCheck Check that method/constructor/catch/foreach parameters are final.
class	NewlineAtEndOfFileCheck Checks that there is a newline at the end of each file.
class	OuterTypeFilenameCheck Checks that the outer type name and the file name match.
class	RegexpCheck A check that makes sure that a specified pattern exists (or not) in the file.
class	SuppressWarningsHolder Maintains a set of check suppressions from SuppressWarnings annotations.
class	TodoCommentCheck A check for TODO comments.
class	TrailingCommentCheck The check to ensure that requires that comments be the only thing on a line.
class	TranslationCheck The TranslationCheck class helps to ensure the correct translation of code by checking property files for consistency regarding their keys.
class	UncommentedMainCheck Detects uncommented main methods.
class	UniquePropertiesCheck Checks the uniqueness of property keys (left from equal sign) in the properties file.
class	UpperEllCheck Checks that long constants are defined with an upper ell.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.annotation

Classes in com.puppycrawl.tools.checkstyle.checks.annotation that implement Contextualizable

Modifier and Type	Class and Description
class	AnnotationLocationCheck Check location of annotation on language elements.
class	AnnotationUseStyleCheck This check controls the style with the usage of annotations.
class	MissingDeprecatedCheck This class is used to verify that both the Deprecated annotation and the deprecated javadoc tag are present when either one is present.
class	MissingOverrideCheck This class is used to verify that the Override annotation is present when the inheritDoc javadoc tag is present.
class	PackageAnnotationCheck This check makes sure that all package annotations are in the package-info.java file.
class	SuppressWarningsCheck This check allows you to specify what warnings that SuppressWarnings is not allowed to suppress.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.blocks

Classes in com.puppycrawl.tools.checkstyle.checks.blocks that implement Contextualizable

Modifier and Type	Class and Description
class	AvoidNestedBlocksCheck Finds nested blocks.
class	EmptyBlockCheck Checks for empty blocks.
class	LeftCurlyCheck 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.
class	NeedBracesCheck Checks for braces around code blocks.
class	RightCurlyCheck Checks the placement of right curly braces.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.coding

Classes in com.puppycrawl.tools.checkstyle.checks.coding that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractIllegalCheck Support for checks that look for usage of illegal types.
class	AbstractIllegalMethodCheck Provide support for checking for a method with a specified name and no arguments.
class	AbstractNestedDepthCheck Abstract class which provides helpers functionality for nested checks.
class	AbstractSuperCheck Abstract class for checking that an overriding method with no parameters invokes the super method.
class	ArrayTrailingCommaCheck Checks if array initialization contains optional trailing comma.
class	AvoidInlineConditionalsCheck Detects inline conditionals.
class	CovariantEqualsCheck Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).
class	DeclarationOrderCheck Checks that the parts of a class or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.
class	DefaultComesLastCheck Check that the default is after all the cases in a switch statement.
class	EmptyStatementCheck Detects empty statements (standalone ';').
class	EqualsAvoidNullCheck Checks that any combination of String literals with optional assignment is on the left side of an equals() comparison.
class	EqualsHashCodeCheck Checks that classes that override equals() also override hashCode().
class	ExplicitInitializationCheck Checks if any class or object member explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean.
class	FallThroughCheck Checks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.
class	FinalLocalVariableCheck Ensures that local variables that never get their values changed, must be declared final.
class	HiddenFieldCheck Checks that a local variable or a parameter does not shadow a field that is defined in the same class.
class	IllegalCatchCheck Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException is almost never acceptable.
class	IllegalInstantiationCheck Checks for illegal instantiations where a factory method is preferred.
class	IllegalThrowsCheck Throwing java.lang.Error or java.lang.RuntimeException is almost never acceptable.
class	IllegalTokenCheck Checks for illegal tokens.
class	IllegalTokenTextCheck Checks for illegal token text.
class	IllegalTypeCheck Checks that particular class are never used as types in variable declarations, return values or parameters.
class	InnerAssignmentCheck Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.
class	MagicNumberCheck Checks for magic numbers.
class	MissingCtorCheck Checks that classes (except abstract one) define a ctor and don't rely on the default one.
class	MissingSwitchDefaultCheck Checks that switch statement has "default" clause.
class	ModifiedControlVariableCheck Check for ensuring that for loop control variables are not modified inside the for block.
class	MultipleStringLiteralsCheck Checks for multiple occurrences of the same string literal within a single file.
class	MultipleVariableDeclarationsCheck Checks that each variable declaration is in its own statement and on its own line.
class	NestedForDepthCheck Check the number of nested for -statements.
class	NestedIfDepthCheck Restricts nested if-else blocks to a specified depth (default = 1).
class	NestedTryDepthCheck Restricts nested try-catch-finally blocks to a specified depth (default = 1).
class	NoCloneCheck Checks that the clone method is not overridden from the Object class.
class	NoFinalizerCheck Checks that no method having zero parameters is defined using the name finalize.
class	OneStatementPerLineCheck Restricts the number of statements per line to one.
class	OverloadMethodsDeclarationOrderCheck Checks that overload methods are grouped together.
class	PackageDeclarationCheck Ensures there is a package declaration.
class	ParameterAssignmentCheck Disallow assignment of parameters.
class	RequireThisCheck Checks that code doesn't rely on the "this" default.
class	ReturnCountCheck Restricts return statements to a specified count (default = 2).
class	SimplifyBooleanExpressionCheck Checks for overly complicated boolean expressions.
class	SimplifyBooleanReturnCheck Checks for overly complicated boolean return statements.
class	StringLiteralEqualityCheck Checks that string literals are not used with == or !=.
class	SuperCloneCheck Checks that an overriding clone() method invokes super.clone().
class	SuperFinalizeCheck Checks that an overriding finalize() method invokes super.finalize().
class	UnnecessaryParenthesesCheck Checks if unnecessary parentheses are used in a statement or expression.
class	VariableDeclarationUsageDistanceCheck Checks the distance between declaration of variable and its first usage.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.design

Classes in com.puppycrawl.tools.checkstyle.checks.design that implement Contextualizable

Modifier and Type	Class and Description
class	DesignForExtensionCheck Checks that classes are designed for inheritance.
class	FinalClassCheck Checks that class which has only private ctors is declared as final.
class	HideUtilityClassConstructorCheck Make sure that utility classes (classes that contain only static methods) do not have a public constructor.
class	InnerTypeLastCheck Check nested (internal) classes/interfaces are declared at the bottom of the class after all method and field declarations.
class	InterfaceIsTypeCheck Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
class	MutableExceptionCheck Ensures that exceptions (classes with names conforming to some regular expression and explicitly extending classes with names conforming to other regular expression) are immutable.
class	OneTopLevelClassCheck Checks that each top-level class, interface or enum resides in a source file of its own.
class	ThrowsCountCheck Restricts throws statements to a specified count (default = 1).
class	VisibilityModifierCheck Checks visibility of class members.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.header

Classes in com.puppycrawl.tools.checkstyle.checks.header that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractHeaderCheck Abstract super class for header checks.
class	HeaderCheck Checks the header of the source against a fixed header file.
class	RegexpHeaderCheck Checks the header of the source against a header file that contains a regular expression for each line of the source header.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.imports

Classes in com.puppycrawl.tools.checkstyle.checks.imports that implement Contextualizable

Modifier and Type	Class and Description
class	AvoidStarImportCheck Check that finds import statements that use the * notation.
class	AvoidStaticImportCheck Check that finds static imports.
class	CustomImportOrderCheck Checks that the groups of import declarations appear in the order specified by the user.
class	IllegalImportCheck Checks for imports from a set of illegal packages.
class	ImportControlCheck Check that controls what packages can be imported in each package.
class	ImportOrderCheck groups imports: ensures that groups of imports come in a specific order (e.g., java.
class	RedundantImportCheck Checks for imports that are redundant.
class	UnusedImportsCheck Checks for unused import statements.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.indentation

Classes in com.puppycrawl.tools.checkstyle.checks.indentation that implement Contextualizable

Modifier and Type	Class and Description
class	IndentationCheck Checks correct indentation of Java Code.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.javadoc

Classes in com.puppycrawl.tools.checkstyle.checks.javadoc that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractJavadocCheck Base class for Checks that process Javadoc comments.
class	AtclauseOrderCheck Checks the order of at-clauses.
class	JavadocMethodCheck Checks the Javadoc of a method or constructor.
class	JavadocPackageCheck Checks that all packages have a package documentation.
class	JavadocParagraphCheck Checks that: There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present. Each paragraph but the first has <p> immediately before the first word, with no space after.
class	JavadocStyleCheck Custom Checkstyle Check to validate Javadoc.
class	JavadocTagContinuationIndentationCheck Checks the indentation of the continuation lines in at-clauses.
class	JavadocTypeCheck Checks the Javadoc of a type.
class	JavadocVariableCheck Checks that a variable has Javadoc comment.
class	NonEmptyAtclauseDescriptionCheck Checks that the at-clause tag is followed by description .
class	SingleLineJavadocCheck Checks that a JavaDoc block which can fit on a single line and doesn't contain at-clauses.
class	SummaryJavadocCheck Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.
class	WriteTagCheck Outputs a JavaDoc tag as information.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.metrics

Classes in com.puppycrawl.tools.checkstyle.checks.metrics that implement Contextualizable

Modifier and Type	Class and Description
class	AbstractClassCouplingCheck Base class for coupling calculation.
class	AbstractComplexityCheck Base class for checks the calculate complexity based around methods.
class	BooleanExpressionComplexityCheck Restricts nested boolean operators (&&, ||, &, | and ^) to a specified depth (default = 3).
class	ClassDataAbstractionCouplingCheck This metric measures the number of instantiations of other classes within the given class.
class	ClassFanOutComplexityCheck The number of other classes a given class relies on.
class	CyclomaticComplexityCheck Checks cyclomatic complexity against a specified limit.
class	JavaNCSSCheck This check calculates the Non Commenting Source Statements (NCSS) metric for java source files and methods.
class	NPathComplexityCheck Checks the npath complexity against a specified limit (default = 200).

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.modifier

Classes in com.puppycrawl.tools.checkstyle.checks.modifier that implement Contextualizable

Modifier and Type	Class and Description
class	ModifierOrderCheck Checks that the order of modifiers conforms to the suggestions in the Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3.
class	RedundantModifierCheck Checks for redundant modifiers in interface and annotation definitions.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.naming

Classes in com.puppycrawl.tools.checkstyle.checks.naming that implement Contextualizable

Modifier and Type	Class and Description
class	AbbreviationAsWordInNameCheck The Check validate abbreviations(consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.
class	AbstractAccessControlNameCheck Abstract class for checking a class member (field/method)'s name conforms to a format specified by the format property.
class	AbstractClassNameCheck Ensures that the names of abstract classes conforming to some regular expression and check that abstract modifier exists.
class	AbstractNameCheck Abstract class for checking that names conform to a specified format.
class	AbstractTypeParameterNameCheck Abstract class for checking if a class/method type parameter's name conforms to a format specified by the format property.
class	ClassTypeParameterNameCheck Checks that class type parameter names conform to a format specified by the format property.
class	ConstantNameCheck Checks that constant names conform to a format specified by the format property.
class	InterfaceTypeParameterNameCheck Checks that interface type parameter names conform to a format specified by the format property.
class	LocalFinalVariableNameCheck Checks that local final variable names conform to a format specified by the format property.
class	LocalVariableNameCheck Checks that local, non-final variable names conform to a format specified by the format property.
class	MemberNameCheck Checks that instance variable names conform to a format specified by the format property.
class	MethodNameCheck Checks that method names conform to a format specified by the format property.
class	MethodTypeParameterNameCheck Checks that class type parameter names conform to a format specified by the format property.
class	PackageNameCheck Checks that package names conform to a format specified by the format property.
class	ParameterNameCheck Checks that parameter names conform to a format specified by the format property.
class	StaticVariableNameCheck Checks that static, non-final variable names conform to a format specified by the format property.
class	TypeNameCheck Checks that type names conform to a format specified by the format property.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.regexp

Classes in com.puppycrawl.tools.checkstyle.checks.regexp that implement Contextualizable

Modifier and Type	Class and Description
class	RegexpMultilineCheck Implementation of a check that looks that matches across multiple lines in any file type.
class	RegexpSinglelineCheck Implementation of a check that looks for a single line in any file type.
class	RegexpSinglelineJavaCheck Implementation of a check that looks for a single line in Java files.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.sizes

Classes in com.puppycrawl.tools.checkstyle.checks.sizes that implement Contextualizable

Modifier and Type	Class and Description
class	AnonInnerLengthCheck Checks for long anonymous inner classes.
class	ExecutableStatementCountCheck Restricts the number of executable statements to a specified limit (default = 30).
class	FileLengthCheck Checks for long source files.
class	LineLengthCheck Checks for long lines.
class	MethodCountCheck Counts the methods of the type-definition and checks whether this count is higher than the configured limit.
class	MethodLengthCheck Checks for long methods.
class	OuterTypeNumberCheck Checks for the number of defined types at the "outer" level.
class	ParameterNumberCheck Checks the number of parameters that a method or constructor has.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.checks.whitespace

Classes in com.puppycrawl.tools.checkstyle.checks.whitespace that implement Contextualizable

Modifier and Type	Class and Description
class	EmptyForInitializerPadCheck Checks the padding of an empty for initializer; that is whether a space is required at an empty for initializer, or such spaces are forbidden.
class	EmptyForIteratorPadCheck Checks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden.
class	EmptyLineSeparatorCheck Checks for empty line separators after header, package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.
class	FileTabCharacterCheck Checks to see if a file contains a tab character.
class	GenericWhitespaceCheck Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.
class	MethodParamPadCheck 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.
class	NoLineWrapCheck Checks that chosen statements are not line-wrapped.
class	NoWhitespaceAfterCheck Checks that there is no whitespace after a token.
class	NoWhitespaceBeforeCheck Checks that there is no whitespace before a token.
class	OperatorWrapCheck Checks line wrapping for operators.
class	ParenPadCheck 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.
class	SeparatorWrapCheck Checks line wrapping with separators.
class	TypecastParenPadCheck Checks the padding of parentheses for typecasts.
class	WhitespaceAfterCheck Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.
class	WhitespaceAroundCheck Checks that a token is surrounded by whitespace.

Uses of Contextualizable in com.puppycrawl.tools.checkstyle.filters

Classes in com.puppycrawl.tools.checkstyle.filters that implement Contextualizable

Modifier and Type	Class and Description
class	SeverityMatchFilter This is a very simple filter based on severity matching.
class	SuppressionCommentFilter A filter that uses comments to suppress audit events.
class	SuppressionFilter This filter accepts AuditEvents according to file, check, line, and column, as specified in a suppression file.
class	SuppressWarningsFilter A filter that suppresses warnings using the SuppressWarnings annotation.
class	SuppressWithNearbyCommentFilter A filter that uses nearby comments to suppress audit events.