Package com.puppycrawl.tools.checkstyle.api

Interface Configurable

All Known Subinterfaces:

FileSetCheck, RootModule

All Known Implementing Classes:

AbbreviationAsWordInNameCheck, AbstractAccessControlNameCheck, AbstractAutomaticBean, AbstractCheck, AbstractClassCouplingCheck, AbstractClassNameCheck, AbstractFileSetCheck, AbstractHeaderCheck, AbstractJavadocCheck, AbstractNameCheck, AbstractParenPadCheck, AbstractSuperCheck, AbstractViolationReporter, AnnotationLocationCheck, AnnotationOnSameLineCheck, AnnotationUseStyleCheck, AnonInnerLengthCheck, ArrayTrailingCommaCheck, ArrayTypeStyleCheck, AtclauseOrderCheck, AutomaticBean, AvoidDoubleBraceInitializationCheck, AvoidEscapedUnicodeCharactersCheck, AvoidInlineConditionalsCheck, AvoidNestedBlocksCheck, AvoidNoArgumentSuperConstructorCallCheck, AvoidStarImportCheck, AvoidStaticImportCheck, BeforeExecutionExclusionFileFilter, BooleanExpressionComplexityCheck, CatchParameterNameCheck, Checker, ClassAndPropertiesSettersJavadocScraper, ClassDataAbstractionCouplingCheck, ClassFanOutComplexityCheck, ClassMemberImpliedModifierCheck, ClassTypeParameterNameCheck, CommentsIndentationCheck, ConstantNameCheck, ConstructorsDeclarationGroupingCheck, CovariantEqualsCheck, CustomImportOrderCheck, CyclomaticComplexityCheck, DeclarationOrderCheck, DefaultComesLastCheck, DefaultLogger, DescendantTokenCheck, DesignForExtensionCheck, EmptyBlockCheck, EmptyCatchBlockCheck, EmptyForInitializerPadCheck, EmptyForIteratorPadCheck, EmptyLineSeparatorCheck, EmptyStatementCheck, EqualsAvoidNullCheck, EqualsHashCodeCheck, ExecutableStatementCountCheck, ExplicitInitializationCheck, FallThroughCheck, FileLengthCheck, FileTabCharacterCheck, FinalClassCheck, FinalLocalVariableCheck, FinalParametersCheck, GenericWhitespaceCheck, HeaderCheck, HiddenFieldCheck, HideUtilityClassConstructorCheck, IllegalCatchCheck, IllegalIdentifierNameCheck, IllegalImportCheck, IllegalInstantiationCheck, IllegalThrowsCheck, IllegalTokenCheck, IllegalTokenTextCheck, IllegalTypeCheck, ImportControlCheck, ImportOrderCheck, IndentationCheck, InnerAssignmentCheck, InnerTypeLastCheck, InterfaceIsTypeCheck, InterfaceMemberImpliedModifierCheck, InterfaceTypeParameterNameCheck, InvalidJavadocPositionCheck, JavadocBlockTagLocationCheck, JavadocContentLocationCheck, JavadocLeadingAsteriskAlignCheck, JavadocMetadataScraper, JavadocMethodCheck, JavadocMissingLeadingAsteriskCheck, JavadocMissingWhitespaceAfterAsteriskCheck, JavadocPackageCheck, JavadocParagraphCheck, JavadocStyleCheck, JavadocTagContinuationIndentationCheck, JavadocTypeCheck, JavadocVariableCheck, JavaNCSSCheck, LambdaBodyLengthCheck, LambdaParameterNameCheck, LeftCurlyCheck, LineLengthCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MagicNumberCheck, MatchXpathCheck, MemberNameCheck, MetadataGeneratorLogger, MethodCountCheck, MethodLengthCheck, MethodNameCheck, MethodParamPadCheck, MethodTypeParameterNameCheck, MissingCtorCheck, MissingDeprecatedCheck, MissingJavadocMethodCheck, MissingJavadocPackageCheck, MissingJavadocTypeCheck, MissingNullCaseInSwitchCheck, MissingOverrideCheck, MissingSwitchDefaultCheck, ModifiedControlVariableCheck, ModifierOrderCheck, MultipleStringLiteralsCheck, MultipleVariableDeclarationsCheck, MutableExceptionCheck, NeedBracesCheck, NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck, NewlineAtEndOfFileCheck, NoArrayTrailingCommaCheck, NoCloneCheck, NoCodeInFileCheck, NoEnumTrailingCommaCheck, NoFinalizerCheck, NoLineWrapCheck, NonEmptyAtclauseDescriptionCheck, NoWhitespaceAfterCheck, NoWhitespaceBeforeCaseDefaultColonCheck, NoWhitespaceBeforeCheck, NPathComplexityCheck, OneStatementPerLineCheck, OneTopLevelClassCheck, OperatorWrapCheck, OrderedPropertiesCheck, OuterTypeFilenameCheck, OuterTypeNumberCheck, OverloadMethodsDeclarationOrderCheck, PackageAnnotationCheck, PackageDeclarationCheck, PackageNameCheck, ParameterAssignmentCheck, ParameterNameCheck, ParameterNumberCheck, ParenPadCheck, PatternVariableNameCheck, RecordComponentNameCheck, RecordComponentNumberCheck, RecordTypeParameterNameCheck, RedundantImportCheck, RedundantModifierCheck, RegexpCheck, RegexpHeaderCheck, RegexpMultilineCheck, RegexpOnFilenameCheck, RegexpSinglelineCheck, RegexpSinglelineJavaCheck, RequireEmptyLineBeforeBlockTagGroupCheck, RequireThisCheck, ReturnCountCheck, RightCurlyCheck, SarifLogger, SealedShouldHavePermitsListCheck, SeparatorWrapCheck, SeverityMatchFilter, SimplifyBooleanExpressionCheck, SimplifyBooleanReturnCheck, SingleLineJavadocCheck, SingleSpaceSeparatorCheck, StaticVariableNameCheck, StringLiteralEqualityCheck, SummaryJavadocCheck, SuperCloneCheck, SuperFinalizeCheck, SuppressionCommentFilter, SuppressionFilter, SuppressionSingleFilter, SuppressionXpathFilter, SuppressionXpathSingleFilter, SuppressWarningsCheck, SuppressWarningsFilter, SuppressWarningsHolder, SuppressWithNearbyCommentFilter, SuppressWithNearbyTextFilter, SuppressWithPlainTextCommentFilter, ThrowsCountCheck, TodoCommentCheck, TrailingCommentCheck, TranslationCheck, TreeWalker, TypecastParenPadCheck, TypeNameCheck, UncommentedMainCheck, UniquePropertiesCheck, UnnecessaryParenthesesCheck, UnnecessarySemicolonAfterOuterTypeDeclarationCheck, UnnecessarySemicolonAfterTypeMemberDeclarationCheck, UnnecessarySemicolonInEnumerationCheck, UnnecessarySemicolonInTryWithResourcesCheck, UnusedCatchParameterShouldBeUnnamedCheck, UnusedImportsCheck, UnusedLambdaParameterShouldBeUnnamedCheck, UnusedLocalVariableCheck, UpperEllCheck, VariableDeclarationUsageDistanceCheck, VisibilityModifierCheck, WhenShouldBeUsedCheck, WhitespaceAfterCheck, WhitespaceAroundCheck, WriteTagCheck, XMLLogger, XpathFileGeneratorAstFilter, XpathFileGeneratorAuditListener

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Configurable

A component that can be configured. Note: Configuring of object mean copy user defined properties to object. Contextualizing is inheriting some properties from parent that are provided by user to parent object or created by parent object. The general idea of Configuration/Configurable was taken from Jakarta's Avalon framework.

Method Summary

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

Method Detail

configure

void configure(Configuration configuration)
        throws CheckstyleException

Configures this component.

Parameters:

configuration - the configuration to use.

Throws:

CheckstyleException - if there is a configuration error.