Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ api Javadoc ]

• com.puppycrawl.tools.checkstyle.api: Javadoc index of package com.puppycrawl.tools.checkstyle.api.


Package Samples:

• com.puppycrawl.tools.checkstyle.api

Classes:

• StrArrayConverter: Standard Converter implementation that converts an incoming String into an array of String. On a conversion failure, returns a specified default value or throws a ConversionException depending on how this instance is constructed. Hacked from http://cvs.apache.org/viewcvs/jakarta-commons/beanutils/src/java/org/apache/commons/beanutils/converters/StringArrayConverter.java because that implementation fails to convert array of tokens with elements containing an underscore, "_" :(
• AuditEvent: Raw event for audit. I'm not very satisfied about the design of this event since there are optional methods that will return null in most of the case. This will need some work to clean it up especially if we want to introduce a more sequential reporting action rather than a packet error reporting. This will allow for example to follow the process quickly in an interface or a servlet (yep, that's cool to run a check via a web interface in a source repository ;-)
• FullIdent: Represents a full identifier, including dots, with associated position information. Identifiers such as java.util.HashMap are spread across multiple AST nodes in the syntax tree (three IDENT nodes, two DOT nodes). A FullIdent represents the whole String (excluding any intermediate whitespace), which is often easier to work with in Checks.
• Contextualizable: A Component that needs context information from it's container to work. The container will create a Context object and pass it to this Contextualizable. Contextualization will occur before configuration. The general idea of Context/Contextualizable was taken from Jakarta's Avalon framework .
• AbstractViolationReporter: Serves as an abstract base class for all modules that report inspection findings. Such modules have a Severity level which is used for the localized messages that are created by the module.
• DetailAST: An extension of the CommonAST that records the line and column number. The idea was taken from Java Guru FAQ: How can I include line numbers in automatically generated ASTs? .
• AuditListener: Listener in charge of receiving events from the Checker. Typical events sequence is: auditStarted (fileStarted (addError)* (addException)* fileFinished )* (addException)* auditFinished
• Configuration: A Configuration is used to configure a Configurable component. The general idea of Configuration/Configurable was taken from Jakarta's Avalon framework .
• TokenTypes: Contains the constants for all the tokens contained in the Abstract Syntax Tree. Implementation detail: This class has been introduced to break the circular dependency between packages.
• Configurable: A component that can be configured. The general idea of Configuration/Configurable was taken from Jakarta's Avalon framework .
• Context: A context to be used in subcomponents. The general idea of Context/Contextualizable was taken from Jakarta's Avalon framework .
• FilterSet: A filter set applies filters to AuditEvents. If a filter in the set rejects an AuditEvent, then the AuditEvent is rejected. Otherwise, the AuditEvent is accepted.
• LocalizedMessage: Represents a message that can be localised. The translations come from message.properties files. The underlying implementation uses java.text.MessageFormat.
• SeverityLevel: Severity level for a check violation. Each violation of an audit check is assigned one of the severity levels defined here.
• AutomaticBean: A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configration attributes.
• AbstractViolationReporterTest: Tests to ensure that default messagebundle is determined correctly.
• MessageDispatcher: Used by FileSetChecks to distribute AuditEvents to AuditListeners.
• FileSetCheck: Interface for Checking a set of files for some criteria.
• AbstractFileSetCheck: Provides common functionality for many FileSetChecks.
• CheckstyleException: Represents an error condition within Checkstyle.
• ScopeUtils: Contains utility methods for working on scope.
• Filter: An interface for filtering AuditEvents.
• Scope: Represents a Java visibility scope.
• FileContents: Represents the contents of a file.
• DetailASTTest: TestCase to check DetailAST.

Home | Contact Us | Privacy Policy | Terms of Service