Package com.puppycrawl.tools.checkstyle.api


package com.puppycrawl.tools.checkstyle.api
Contains the core API to be used to implement checks. If you want to implement your own check, you should be referring to this package.
  • Class
    Description
    The base class for checks.
    Provides common functionality for many FileSetChecks.
    Serves as an abstract base class for all modules that report inspection findings.
    Raw event for audit.
    Listener in charge of receiving events from the Checker.
    A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.
    Enum to specify behaviour regarding ignored modules.
    An interface for before execution file filtering events.
    A before execution file filter set applies filters to events.
    Represents an error condition within Checkstyle.
    Representation of the comment block.
    A component that can be configured.
    A Configuration is used to configure a Configurable component.
    A context to be used in subcomponents.
    A Component that needs context information from it's container(parent object) to work.
    A interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
    DetailNode is used to construct tree during parsing Javadoc comments.
    The following interface should be implemented by each module (inheritor of AbstractCheck, implementor of FileSetCheck, or Filter) which uses external resources of any kind for its configuration.
    Represents the contents of a file.
    Interface for Checking a set of files for some criteria.
    Represents the text contents of a file of arbitrary plain text type.
    An interface for filtering AuditEvents.
    A filter set applies filters to AuditEvents.
    Represents a full identifier, including dots, with associated position information.
    Contains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar.
    Immutable line and column numbers.
    Represents a message that can be localised.
    Custom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.
    Used by FileSetChecks to distribute AuditEvents to AuditListeners.
    The first module that is run as part of Checkstyle and controls its entire behavior and children.
    Represents a Java visibility scope.
    Severity level for a check violation.
    An audit listener that counts how many AuditEvents of a given severity have been generated.
    A block of text from an input file that does not necessarily have any grammatical structure.
    Contains the constants for all the tokens contained in the Abstract Syntax Tree.