Uses of Package
com.puppycrawl.tools.checkstyle.api
Packages that use com.puppycrawl.tools.checkstyle.api
Package
Description
Contains the implementation of the Checkstyle framework.
Contains code related to Checkstyle Ant Task.
Contains the core API to be used to implement checks.
Contains the checks that are bundled with the main distribution.
Contains the Annotation checks that are
bundled with the main distribution.
Contains the Block checks that are
bundled with the main distribution.
Contains the Coding checks that are
bundled with the main distribution.
Contains the Class Design checks that
are bundled with the main distribution.
File Header checks.
Contains the Imports checks that are
bundled with the main distribution.
Contains all classes required for the
indentation check.
Contains the Javadoc checks that are bundled with the main distribution.
Contains utils classes for the Javadoc checks that are bundled with the main distribution.
Contains the Metrics checks that are
bundled with the main distribution.
Contains the modifier checks that are bundled with the main distribution.
Contains the Naming conventions checks
that are bundled with the main distribution.
Contains the regular expression checks that are bundled with the main
distribution.
Contains the Size Violations checks
that are bundled with the main distribution.
Contains the Whitespace checks that
are bundled with the main distribution.
Contains the before execution file filters that are bundled with the main distribution.
Contains the filters that are bundled with the main distribution.
User interface classes for CheckStyle.
Contains module metadata generation classes for checkstyle.
Contains utils classes for checkstyle.
Contains the nodes implementations for XPATH queries and query generator.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyleClassDescriptionProvides 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.Represents an error condition within Checkstyle.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 ofFileSetCheck
, orFilter
) 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.Represents a message that can be localised.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. -
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.ant
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.apiClassDescriptionServes 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.Represents an error condition within Checkstyle.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.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.Represents a full identifier, including dots, with associated position information.Immutable line and column numbers.Represents a message that can be localised.Used by FileSetChecks to distribute AuditEvents to AuditListeners.Represents a Java visibility scope.Severity level for a check violation.A block of text from an input file that does not necessarily have any grammatical structure.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checksClassDescriptionThe 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.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.annotationClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.blocksClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.codingClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.designClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.headerClassDescriptionProvides common functionality for many FileSetChecks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.A Component that needs context information from it's container(parent object) to work.The following interface should be implemented by each module (inheritor of
AbstractCheck
, implementor ofFileSetCheck
, orFilter
) which uses external resources of any kind for its configuration.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type. -
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.importsClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.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.The following interface should be implemented by each module (inheritor of
AbstractCheck
, implementor ofFileSetCheck
, orFilter
) which uses external resources of any kind for its configuration. -
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.indentationClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.javadocClassDescriptionThe base class for checks.Provides common functionality for many FileSetChecks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.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.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type.Represents a Java visibility scope.Severity level for a check violation.
-
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.metricsClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.modifierClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.namingClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.regexpClassDescriptionThe base class for checks.Provides common functionality for many FileSetChecks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.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.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.sizesClassDescriptionThe base class for checks.Provides common functionality for many FileSetChecks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.whitespaceClassDescriptionThe base class for checks.Provides common functionality for many FileSetChecks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.A component that can be configured.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.Interface for Checking a set of files for some criteria.Represents the text contents of a file of arbitrary plain text type.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.filefiltersClassDescriptionA Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.An interface for before execution file filtering events.A component that can be configured.A Component that needs context information from it's container(parent object) to work.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.filtersClassDescriptionRaw event for audit.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.A Component that needs context information from it's container(parent object) to work.The following interface should be implemented by each module (inheritor of
AbstractCheck
, implementor ofFileSetCheck
, orFilter
) which uses external resources of any kind for its configuration.Represents the contents of a file.An interface for filtering AuditEvents.A filter set applies filters to AuditEvents.Severity level for a check violation. -
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.guiClassDescriptionRepresents an error condition within Checkstyle.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.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.metaClassDescriptionThe base class for checks.Serves as an abstract base class for all modules that report inspection findings.A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Represents an error condition within Checkstyle.A component that can be configured.A Component that needs context information from it's container(parent object) to work.DetailNode is used to construct tree during parsing Javadoc comments.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.utilsClassDescriptionRepresents an error condition within Checkstyle.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.Represents a full identifier, including dots, with associated position information.Represents a Java visibility scope.A block of text from an input file that does not necessarily have any grammatical structure.
-
Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.xpath