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, AvoidNestedBlocksCheck, AvoidNoArgumentSuperConstructorCallCheck, AvoidStarImportCheck, AvoidStaticImportCheck, BeforeExecutionExclusionFileFilter, BooleanExpressionComplexityCheck, CatchParameterNameCheck, Checker, ChecksAndFilesSuppressionFileGeneratorAuditListener, 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, GoogleMethodNameCheck, GoogleNonConstantFieldNameCheck, HeaderCheck, HexLiteralCaseCheck, HiddenFieldCheck, HideUtilityClassConstructorCheck, IllegalBlockTagCheck, IllegalCatchCheck, IllegalIdentifierNameCheck, IllegalImportCheck, IllegalInstantiationCheck, IllegalSymbolCheck, IllegalThrowsCheck, IllegalTokenCheck, IllegalTokenTextCheck, IllegalTypeCheck, ImportControlCheck, ImportOrderCheck, InappropriateJavadocBlockTagsOnTypeCheck, IndentationCheck, InnerAssignmentCheck, InnerTypeLastCheck, InterfaceIsTypeCheck, InterfaceMemberImpliedModifierCheck, InterfaceTypeParameterNameCheck, InvalidJavadocPositionCheck, JavadocBlockTagLocationCheck, JavadocContentLocationCheck, JavadocEndCommentDelimiterCheck, JavadocLeadingAsteriskAlignCheck, JavadocLinkFirstOccurrenceCheck, JavadocLinkWellKnownApiCheck, JavadocMethodCheck, JavadocMissingLeadingAsteriskCheck, JavadocMissingWhitespaceAfterAsteriskCheck, JavadocNoErrorInThrowsTagCheck, JavadocPackageCheck, JavadocParagraphCheck, JavadocParamOrderCheck, JavadocRegexpCheck, JavadocTagContinuationIndentationCheck, JavadocThrowsOrderCheck, JavadocTypeCheck, 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, MultiFileRegexpHeaderCheck, MultilineCommentLeadingAsteriskPresenceCheck, MultipleStringLiteralsCheck, MultipleVariableDeclarationsCheck, MutableExceptionCheck, NeedBracesCheck, NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck, NewlineAtEndOfFileCheck, NoArrayTrailingCommaCheck, NoCloneCheck, NoCodeInFileCheck, NoEnumTrailingCommaCheck, NoFinalizerCheck, NoLineWrapCheck, NonEmptyAtclauseDescriptionCheck, NoWhitespaceAfterCheck, NoWhitespaceBeforeCaseDefaultColonCheck, NoWhitespaceBeforeCheck, NPathComplexityCheck, NumericalPrefixesInfixesSuffixesCharacterCaseCheck, OneStatementPerLineCheck, OneTopLevelClassCheck, OpenjdkAnnotationLocationCheck, OperatorWrapCheck, OrderedPropertiesCheck, OuterTypeFilenameCheck, OuterTypeNumberCheck, OverloadMethodsDeclarationOrderCheck, PackageAnnotationCheck, PackageDeclarationCheck, PackageNameCheck, ParameterAssignmentCheck, ParameterNameCheck, ParameterNumberCheck, ParenPadCheck, PatternVariableAssignmentCheck, PatternVariableNameCheck, PreferCodeOrSnippetJavadocInlineTagCheck, PreferLiteralJavadocInlineTagCheck, 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, TextBlockGoogleStyleFormattingCheck, ThrowsCountCheck, TodoCommentCheck, TrailingCommentCheck, TranslationCheck, TreeWalker, TypeBodyPaddingCheck, TypecastParenPadCheck, TypeNameCheck, UncommentedMainCheck, UniquePropertiesCheck, UnnecessaryFullyQualifiedTypeCheck, UnnecessaryNullCheckWithInstanceOfCheck, UnnecessaryParenthesesCheck, 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.