Package com.puppycrawl.tools.checkstyle.api

Interface Contextualizable

All Known Subinterfaces:

FileSetCheck

All Known Implementing Classes:

AbbreviationAsWordInNameCheck, AbstractAccessControlNameCheck, 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, ClassDataAbstractionCouplingCheck, ClassFanOutComplexityCheck, ClassMemberImpliedModifierCheck, ClassTypeParameterNameCheck, CommentsIndentationCheck, ConstantNameCheck, 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, JavadocMetadataScraper, JavadocMethodCheck, JavadocMissingWhitespaceAfterAsteriskCheck, JavadocPackageCheck, JavadocParagraphCheck, JavadocStyleCheck, JavadocTagContinuationIndentationCheck, JavadocTypeCheck, JavadocVariableCheck, JavaNCSSCheck, LambdaParameterNameCheck, LeftCurlyCheck, LineLengthCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MagicNumberCheck, MemberNameCheck, MethodCountCheck, MethodLengthCheck, MethodNameCheck, MethodParamPadCheck, MethodTypeParameterNameCheck, MissingCtorCheck, MissingDeprecatedCheck, MissingJavadocMethodCheck, MissingJavadocPackageCheck, MissingJavadocTypeCheck, MissingOverrideCheck, MissingSwitchDefaultCheck, ModifiedControlVariableCheck, ModifierOrderCheck, MultipleStringLiteralsCheck, MultipleVariableDeclarationsCheck, MutableExceptionCheck, NeedBracesCheck, NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck, NewlineAtEndOfFileCheck, NoArrayTrailingCommaCheck, NoCloneCheck, NoCodeInFileCheck, NoEnumTrailingCommaCheck, NoFinalizerCheck, NoLineWrapCheck, NonEmptyAtclauseDescriptionCheck, NoWhitespaceAfterCheck, NoWhitespaceBeforeCheck, NPathComplexityCheck, OneStatementPerLineCheck, OneTopLevelClassCheck, OperatorWrapCheck, OrderedPropertiesCheck, OuterTypeFilenameCheck, OuterTypeNumberCheck, OverloadMethodsDeclarationOrderCheck, PackageAnnotationCheck, PackageDeclarationCheck, PackageNameCheck, ParameterAssignmentCheck, ParameterNameCheck, ParameterNumberCheck, ParenPadCheck, PatternVariableNameCheck, RecordComponentNumberCheck, RecordTypeParameterNameCheck, RedundantImportCheck, RedundantModifierCheck, RegexpCheck, RegexpHeaderCheck, RegexpMultilineCheck, RegexpOnFilenameCheck, RegexpSinglelineCheck, RegexpSinglelineJavaCheck, RequireEmptyLineBeforeBlockTagGroupCheck, RequireThisCheck, ReturnCountCheck, RightCurlyCheck, SeparatorWrapCheck, SeverityMatchFilter, SimplifyBooleanExpressionCheck, SimplifyBooleanReturnCheck, SingleLineJavadocCheck, SingleSpaceSeparatorCheck, StaticVariableNameCheck, StringLiteralEqualityCheck, SummaryJavadocCheck, SuperCloneCheck, SuperFinalizeCheck, SuppressionCommentFilter, SuppressionFilter, SuppressionSingleFilter, SuppressionXpathFilter, SuppressionXpathSingleFilter, SuppressWarningsCheck, SuppressWarningsFilter, SuppressWarningsHolder, SuppressWithNearbyCommentFilter, SuppressWithPlainTextCommentFilter, ThrowsCountCheck, TodoCommentCheck, TrailingCommentCheck, TranslationCheck, TreeWalker, TypecastParenPadCheck, TypeNameCheck, UncommentedMainCheck, UniquePropertiesCheck, UnnecessaryParenthesesCheck, UnnecessarySemicolonAfterOuterTypeDeclarationCheck, UnnecessarySemicolonAfterTypeMemberDeclarationCheck, UnnecessarySemicolonInEnumerationCheck, UnnecessarySemicolonInTryWithResourcesCheck, UnusedImportsCheck, UpperEllCheck, VariableDeclarationUsageDistanceCheck, VisibilityModifierCheck, 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 Contextualizable

A Component that needs context information from it's container(parent object) to work. The container will create a Context object and pass it to this Contextualizable. Contextualization will occur before configuration. 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 Context/Contextualizable was taken from Jakarta's Avalon framework.

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)	Sets the context for this Component.

Method Detail

contextualize

void contextualize(Context context)
            throws CheckstyleException

Sets the context for this Component.

Parameters:

context - the context.

Throws:

CheckstyleException - if there is a contextualization error.