## Uses of Interface
com.puppycrawl.tools.checkstyle.api.Configurable

Packages that use Configurable
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.duplicates: Duplicate code detection tools.
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 Configurable in com.puppycrawl.tools.checkstyle

Classes in com.puppycrawl.tools.checkstyle that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.api

Subinterfaces of Configurable in com.puppycrawl.tools.checkstyle.api
`interface` `FileSetCheck` Interface for Checking a set of files for some criteria.

Classes in com.puppycrawl.tools.checkstyle.api that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks

Classes in com.puppycrawl.tools.checkstyle.checks that implement Configurable
`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` Abstract class that endeavours to maintain type information for the Java file being checked.
`class` `ArrayTypeStyleCheck` Checks the style of array type definitions.
`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` `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` `UpperEllCheck` Checks that long constants are defined with an upper ell.

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

Classes in com.puppycrawl.tools.checkstyle.checks.annotation that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.blocks

Classes in com.puppycrawl.tools.checkstyle.checks.blocks that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.coding

Classes in com.puppycrawl.tools.checkstyle.checks.coding that implement Configurable
`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 nestedchecks.
`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 `case`s in a `switch` statement.
`class` `DoubleCheckedLockingCheck` Detect the double-checked locking idiom, a technique that tries to avoid synchronization overhead but is incorrect because of subtle artifacts of the java memory model.
`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` `JUnitTestCaseCheck` Ensures that the setUp(), tearDown()methods are named correctly, have no arguments, return void and are either public or protected.
`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` `PackageDeclarationCheck` Ensures there is a package declaration.
`class` `ParameterAssignmentCheck` Disallow assignment of parameters.
`class` `RedundantThrowsCheck` Checks for redundant exceptions declared in throws clause such as duplicates, unchecked exceptions or subclasses of another declared exception.
`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.

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

Classes in com.puppycrawl.tools.checkstyle.checks.design that implement Configurable
`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 (defined as any class name conforming to some regular expression) are immutable.
`class` `ThrowsCountCheck` Restricts throws statements to a specified count (default = 1).
`class` `VisibilityModifierCheck` Checks visibility of class members.

Uses of Configurable in com.puppycrawl.tools.checkstyle.checks.duplicates

Classes in com.puppycrawl.tools.checkstyle.checks.duplicates that implement Configurable
`class` `StrictDuplicateCodeCheck` Performs a line-by-line comparison of all code lines and reports duplicate code if a sequence of lines differs only in indentation.

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

Classes in com.puppycrawl.tools.checkstyle.checks.header that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.imports

Classes in com.puppycrawl.tools.checkstyle.checks.imports that implement Configurable
`class` `AvoidStarImportCheck` Check that finds import statements that use the * notation.
`class` `AvoidStaticImportCheck` Check that finds static imports.
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.indentation

Classes in com.puppycrawl.tools.checkstyle.checks.indentation that implement Configurable
`class` `IndentationCheck` Checks correct indentation of Java Code.

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

Classes in com.puppycrawl.tools.checkstyle.checks.javadoc that implement Configurable
`class` `JavadocMethodCheck` Checks the Javadoc of a method or constructor.
`class` `JavadocPackageCheck` Checks that all packages have a package documentation.
`class` `JavadocStyleCheck` Custom Checkstyle Check to validate Javadoc.
`class` `JavadocTypeCheck` Checks the Javadoc of a type.
`class` `JavadocVariableCheck` Checks that a variable has Javadoc comment.
`class` `WriteTagCheck` Outputs a JavaDoc tag as information.

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

Classes in com.puppycrawl.tools.checkstyle.checks.metrics that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.modifier

Classes in com.puppycrawl.tools.checkstyle.checks.modifier that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.naming

Classes in com.puppycrawl.tools.checkstyle.checks.naming that implement Configurable
`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` `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 Configurable in com.puppycrawl.tools.checkstyle.checks.regexp

Classes in com.puppycrawl.tools.checkstyle.checks.regexp that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.sizes

Classes in com.puppycrawl.tools.checkstyle.checks.sizes that implement Configurable
`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 Configurable in com.puppycrawl.tools.checkstyle.checks.whitespace

Classes in com.puppycrawl.tools.checkstyle.checks.whitespace that implement Configurable
`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` `FileTabCharacterCheck` Checks to see if a file contains a tab character.
`class` `GenericWhitespaceCheck` Checks that the whitespace around the Generic tokens < 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` `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` `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 Configurable in com.puppycrawl.tools.checkstyle.filters

Classes in com.puppycrawl.tools.checkstyle.filters that implement Configurable
`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` `SuppressWithNearbyCommentFilter` A filter that uses nearby comments to suppress audit events.

Copyright © 2001-2011. All Rights Reserved.