com.puppycrawl.tools.checkstyle.api

Interface Configurable

All Known Subinterfaces:

FileSetCheck

All Known Implementing Classes:

AbstractAccessControlNameCheck, AbstractClassCouplingCheck, AbstractClassNameCheck, AbstractComplexityCheck, AbstractFileSetCheck, AbstractFormatCheck, AbstractHeaderCheck, AbstractIllegalCheck, AbstractIllegalMethodCheck, AbstractNameCheck, AbstractNestedDepthCheck, AbstractOptionCheck, AbstractSuperCheck, AbstractTypeAwareCheck, AbstractTypeParameterNameCheck, AbstractViolationReporter, AnnotationUseStyleCheck, AnonInnerLengthCheck, ArrayTrailingCommaCheck, ArrayTypeStyleCheck, AutomaticBean, AvoidInlineConditionalsCheck, AvoidNestedBlocksCheck, AvoidStarImportCheck, AvoidStaticImportCheck, BooleanExpressionComplexityCheck, Check, Checker, ClassDataAbstractionCouplingCheck, ClassFanOutComplexityCheck, ClassTypeParameterNameCheck, ConstantNameCheck, CovariantEqualsCheck, CyclomaticComplexityCheck, DeclarationCollector, DeclarationOrderCheck, DefaultComesLastCheck, DefaultLogger, DescendantTokenCheck, DesignForExtensionCheck, EmptyBlockCheck, EmptyForInitializerPadCheck, EmptyForIteratorPadCheck, EmptyStatementCheck, EqualsAvoidNullCheck, EqualsHashCodeCheck, ExecutableStatementCountCheck, ExplicitInitializationCheck, FallThroughCheck, FileContentsHolder, FileLengthCheck, FileTabCharacterCheck, FinalClassCheck, FinalLocalVariableCheck, FinalParametersCheck, GenericWhitespaceCheck, HeaderCheck, HiddenFieldCheck, HideUtilityClassConstructorCheck, IllegalCatchCheck, IllegalImportCheck, IllegalInstantiationCheck, IllegalThrowsCheck, IllegalTokenCheck, IllegalTokenTextCheck, IllegalTypeCheck, ImportControlCheck, ImportOrderCheck, IndentationCheck, InnerAssignmentCheck, InnerTypeLastCheck, InterfaceIsTypeCheck, JavadocMethodCheck, JavadocPackageCheck, JavadocStyleCheck, JavadocTypeCheck, JavadocVariableCheck, JavaNCSSCheck, JUnitTestCaseCheck, LeftCurlyCheck, LineLengthCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MagicNumberCheck, MemberNameCheck, MethodCountCheck, MethodLengthCheck, MethodNameCheck, MethodParamPadCheck, MethodTypeParameterNameCheck, MissingCtorCheck, MissingDeprecatedCheck, MissingOverrideCheck, MissingSwitchDefaultCheck, ModifiedControlVariableCheck, ModifierOrderCheck, MultipleStringLiteralsCheck, MultipleVariableDeclarationsCheck, MutableExceptionCheck, NeedBracesCheck, NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck, NewlineAtEndOfFileCheck, NoCloneCheck, NoFinalizerCheck, NoWhitespaceAfterCheck, NoWhitespaceBeforeCheck, NPathComplexityCheck, OneStatementPerLineCheck, OperatorWrapCheck, OuterTypeFilenameCheck, OuterTypeNumberCheck, PackageAnnotationCheck, PackageDeclarationCheck, PackageNameCheck, ParameterAssignmentCheck, ParameterNameCheck, ParameterNumberCheck, ParenPadCheck, RedundantImportCheck, RedundantModifierCheck, RedundantThrowsCheck, RegexpCheck, RegexpHeaderCheck, RegexpMultilineCheck, RegexpSinglelineCheck, RegexpSinglelineJavaCheck, RequireThisCheck, ReturnCountCheck, RightCurlyCheck, SeverityMatchFilter, SimplifyBooleanExpressionCheck, SimplifyBooleanReturnCheck, StaticVariableNameCheck, StrictDuplicateCodeCheck, StringLiteralEqualityCheck, SuperCloneCheck, SuperFinalizeCheck, SuppressionCommentFilter, SuppressionFilter, SuppressWarningsCheck, SuppressWarningsFilter, SuppressWarningsHolder, SuppressWithNearbyCommentFilter, ThrowsCountCheck, TodoCommentCheck, TrailingCommentCheck, TranslationCheck, TreeWalker, TypecastParenPadCheck, TypeNameCheck, UncommentedMainCheck, UniquePropertiesCheck, UnnecessaryParenthesesCheck, UnusedImportsCheck, UpperEllCheck, VisibilityModifierCheck, WhitespaceAfterCheck, WhitespaceAroundCheck, WriteTagCheck, XMLLogger

public interface Configurable

A component that can be configured. The general idea of Configuration/Configurable was taken from Jakarta's Avalon framework.

Author:

lkuehne

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Configuration aConfiguration) Configures this component.

Method Detail

configure

void configure(Configuration aConfiguration)
               throws CheckstyleException

Configures this component.

Parameters:

aConfiguration - the configuration to use.

Throws:

CheckstyleException - if there is a configuration error.