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, AnnotatedDeclarationVisibilityCheck, AnnotationLocationCheck, AnnotationOnSameLineCheck, AnnotationUseStyleCheck, AnonInnerLengthCheck, ArrayBracketNoWhitespaceCheck, ArrayTrailingCommaCheck, ArrayTypeStyleCheck, AtclauseOrderCheck, AutomaticBean, AvoidDoubleBraceInitializationCheck, AvoidEscapedUnicodeCharactersCheck, AvoidInlineConditionalsCheck, AvoidModuleImportCheck, AvoidNestedBlocksCheck, AvoidNoArgumentSuperConstructorCallCheck, AvoidStarImportCheck, AvoidStaticImportCheck, BeforeExecutionExclusionFileFilter, BlockCommentEndPositionCheck, BooleanExpressionComplexityCheck, CatchParameterNameCheck, Checker, ChecksAndFilesSuppressionFileGeneratorAuditListener, ClassDataAbstractionCouplingCheck, ClassFanOutComplexityCheck, ClassHeaderWrapOpenjdkCheck, ClassMemberImpliedModifierCheck, ClassTypeParameterNameCheck, CommentsIndentationCheck, ConstantNameCheck, ConstructorsDeclarationGroupingCheck, CovariantEqualsCheck, CustomImportOrderCheck, CyclomaticComplexityCheck, DeclarationOrderCheck, DefaultComesLastCheck, DefaultLogger, DescendantTokenCheck, DesignForExtensionCheck, EmptyBlockCheck, EmptyCatchBlockCheck, EmptyForInitializerPadCheck, EmptyForIteratorPadCheck, EmptyLineSeparatorCheck, EmptyLineWrappingInBlockCheck, EmptyStatementCheck, EqualsAvoidNullCheck, EqualsHashCodeCheck, ExceptionThrowShouldUseContextCheck, ExecutableStatementCountCheck, ExplicitInitializationCheck, ExpressionOverBlockLambdaCheck, FallThroughCheck, FileLengthCheck, FileTabCharacterCheck, FinalClassCheck, FinalLocalVariableCheck, FinalParametersCheck, FinalPatternVariableCheck, GenericWhitespaceCheck, GoogleMethodNameCheck, GoogleNonConstantFieldNameCheck, GoogleRightCurlyCheck, HeaderCheck, HexLiteralCaseCheck, HiddenFieldCheck, HideUtilityClassConstructorCheck, IllegalBlockTagCheck, IllegalCatchCheck, IllegalIdentifierNameCheck, IllegalImportCheck, IllegalInstantiationCheck, IllegalSymbolCheck, IllegalThrowsCheck, IllegalTokenCheck, IllegalTokenTextCheck, IllegalTypeCheck, ImportControlCheck, ImportOrderCheck, InappropriateJavadocBlockTagsOnFieldCheck, InappropriateJavadocBlockTagsOnPackageCheck, InappropriateJavadocBlockTagsOnTypeCheck, IndentationCheck, InnerAssignmentCheck, InnerTypeLastCheck, InterfaceIsTypeCheck, InterfaceMemberImpliedModifierCheck, InterfaceTypeParameterNameCheck, InvalidJavadocPositionCheck, JavadocBlockTagLocationCheck, JavadocContentLocationCheck, JavadocEndCommentDelimiterCheck, JavadocLeadingAsteriskAlignCheck, JavadocLinkFirstOccurrenceCheck, JavadocLinkWellKnownApiCheck, JavadocMethodCheck, JavadocMissingLeadingAsteriskCheck, JavadocMissingWhitespaceAfterAsteriskCheck, JavadocNoErrorInThrowsTagCheck, JavadocPackageCheck, JavadocParagraphCheck, JavadocParamOrderCheck, JavadocRegexpCheck, JavadocSeeTagOrderCheck, JavadocTagContinuationIndentationCheck, JavadocThrowsOrderCheck, JavadocTypeCheck, JavadocUtilizingTrailingSpaceCheck, JavadocVariableCheck, JavaNCSSCheck, LambdaBodyLengthCheck, LambdaParameterNameCheck, LeftCurlyCheck, LineEndingCheck, LineLengthCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MagicNumberCheck, MatchXpathCheck, MemberNameCheck, MethodCountCheck, MethodLengthCheck, MethodNameCheck, MethodParamPadCheck, MethodTypeParameterNameCheck, MissingCtorCheck, MissingDeprecatedCheck, MissingJavadocMethodCheck, MissingJavadocPackageCheck, MissingJavadocTypeCheck, MissingNullCaseInSwitchCheck, MissingOverrideCheck, MissingOverrideOnRecordAccessorCheck, MissingSwitchDefaultCheck, ModifiedControlVariableCheck, ModifierOrderCheck, ModuleDirectiveOrderCheck, ModuleImportOrderCheck, MultiFileRegexpHeaderCheck, MultilineCommentLeadingAsteriskPresenceCheck, MultipleStringLiteralsCheck, MultipleVariableDeclarationsCheck, MutableExceptionCheck, NeedBracesCheck, NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck, NewlineAtEndOfFileCheck, NoArrayTrailingCommaCheck, NoCauseGetMessageInExceptionConstructorCheck, NoCloneCheck, NoCodeInFileCheck, NoEnumTrailingCommaCheck, NoFinalizerCheck, NoLineWrapCheck, NonEmptyAtclauseDescriptionCheck, NoWhitespaceAfterCheck, NoWhitespaceBeforeCaseDefaultColonCheck, NoWhitespaceBeforeCheck, NPathComplexityCheck, NumericalPrefixesInfixesSuffixesCharacterCaseCheck, OneStatementPerLineCheck, OneTopLevelClassCheck, OpenjdkAnnotationLocationCheck, OpenjdkMethodParameterAlignmentCheck, OpenjdkMethodThrowsAlignmentCheck, OperatorWrapCheck, OrderedPropertiesCheck, OuterTypeFilenameCheck, OuterTypeNumberCheck, OverloadMethodsDeclarationOrderCheck, PackageAnnotationCheck, PackageDeclarationCheck, PackageNameCheck, ParameterAssignmentCheck, ParameterNameCheck, ParameterNumberCheck, ParenPadCheck, PatternVariableAssignmentCheck, PatternVariableNameCheck, PreferCodeOrSnippetJavadocInlineTagCheck, PreferLiteralJavadocInlineTagCheck, RecordComponentNameCheck, RecordComponentNumberCheck, RecordTypeParameterNameCheck, RedundantImportCheck, RedundantModifierCheck, RedundantModifierCompactSourceCheck, RedundantThisCheck, 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, TextBlockGoogleStyleFormattingCheck, ThrowsCountCheck, TodoCommentCheck, TrailingCommentCheck, TranslationCheck, TreeWalker, TypeBodyPaddingCheck, TypecastParenPadCheck, TypeNameCheck, UncommentedMainCheck, UniquePropertiesCheck, UnnecessaryFullyQualifiedTypeCheck, UnnecessaryNullCheckWithInstanceOfCheck, UnnecessaryParenthesesCheck, UnnecessaryPermitsClauseCheck, UnnecessarySemicolonAfterOuterTypeDeclarationCheck, UnnecessarySemicolonAfterTypeMemberDeclarationCheck, UnnecessarySemicolonInEnumerationCheck, UnnecessarySemicolonInTryWithResourcesCheck, UnnecessaryTypeArgumentsWithRecordPatternCheck, UnusedCatchParameterShouldBeUnnamedCheck, UnusedImportsCheck, UnusedLambdaParameterShouldBeUnnamedCheck, UnusedLocalVariableCheck, UnusedPrivateFieldCheck, UnusedTryResourceShouldBeUnnamedCheck, UpperEllCheck, UseEnhancedSwitchCheck, VariableDeclarationUsageDistanceCheck, VisibilityModifierCheck, WhenShouldBeUsedCheck, WhitespaceAfterCheck, WhitespaceAroundCheck, WhitespaceBeforeEmptyBodyCheck, 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.