Checkstyle Addons
A B C E F G H I L N P R S T U V 

A

AbstractAddonsCheck - Class in com.thomasjensen.checkstyle.addons.checks
Base class of all Checkstyle Addons checks.
AbstractAddonsCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
AbstractAddonsCheck(String) - Constructor for class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
AbstractMethodCallCheck - Class in com.thomasjensen.checkstyle.addons.checks
Checks deriving from this type are aware of method calls occurring anywhere in the source, and get explicitly notified when such calls are encountered.
AbstractMethodCallCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
 

B

beginTree(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
beginTree(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
 
beginTree(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
BinaryName - Class in com.thomasjensen.checkstyle.addons.checks
Represents a Java binary class name for reference types, in the form of its fragments.
BinaryName(String, String, String...) - Constructor for class com.thomasjensen.checkstyle.addons.checks.BinaryName
Constructor.
BinaryName(String, Collection<String>) - Constructor for class com.thomasjensen.checkstyle.addons.checks.BinaryName
Constructor.

C

canonize(File) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Calls getCanonicalFile() on the given File; if that doesn't work, call getAbsoluteFile() on it.
CheckstyleApiFixer - Class in com.thomasjensen.checkstyle.addons.util
The public API of the Checkstyle tool changes frequently, and many releases of Checkstyle are incompatible with their predecessors.
CheckstyleApiFixer(Check) - Constructor for class com.thomasjensen.checkstyle.addons.util.CheckstyleApiFixer
Constructor.
CheckstyleApiFixer(Check, String) - Constructor for class com.thomasjensen.checkstyle.addons.util.CheckstyleApiFixer
Constructor.
CheckstyleExtensionPlugin - Class in com.thomasjensen.checkstyle.addons.sonarqube
The Checkstyle Addons SonarQube plugin main class.
CheckstyleExtensionPlugin() - Constructor for class com.thomasjensen.checkstyle.addons.sonarqube.CheckstyleExtensionPlugin
 
CheckstyleExtensionRepository - Class in com.thomasjensen.checkstyle.addons.sonarqube
Container for the SonarQube rules provided by this plugin.
CheckstyleExtensionRepository(XMLRuleParser) - Constructor for class com.thomasjensen.checkstyle.addons.sonarqube.CheckstyleExtensionRepository
Constructor.
closeQuietly(Closeable) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Quietly close the given resource, ignoring any exceptions.
com.thomasjensen.checkstyle.addons.checks - package com.thomasjensen.checkstyle.addons.checks
Common classes for all checks.
com.thomasjensen.checkstyle.addons.checks.coding - package com.thomasjensen.checkstyle.addons.checks.coding
Checks that find coding problems.
com.thomasjensen.checkstyle.addons.checks.misc - package com.thomasjensen.checkstyle.addons.checks.misc
Checks that find miscellaneous problems.
com.thomasjensen.checkstyle.addons.checks.regexp - package com.thomasjensen.checkstyle.addons.checks.regexp
Checks that primarily apply regular expressions to stuff.
com.thomasjensen.checkstyle.addons.sonarqube - package com.thomasjensen.checkstyle.addons.sonarqube
The SonarQube plugin.
com.thomasjensen.checkstyle.addons.util - package com.thomasjensen.checkstyle.addons.util
Generic helper classes for all checks.
createRules() - Method in class com.thomasjensen.checkstyle.addons.sonarqube.CheckstyleExtensionRepository
 

E

equals(Object) - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
 

F

findLeftMostTokenInLine(DetailAST) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Find the left-most token in the given AST.
finishTree(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
finishTree(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Called after a tree is fully processed.

G

getApiFixer() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
getClassDeclarationPosition(BinaryName) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
getCurrentBinaryName() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Gets the binary name of the class currently being traversed on the AST.
getCurrentFileName() - Method in class com.thomasjensen.checkstyle.addons.util.CheckstyleApiFixer
Wrapper for FileContents.getFileName() (Checkstyle issue #1205).
getCurrentMethodName() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
The current method name.
getCurrentSimpleName() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Gets the simple name of the current class, interface, annotation, or enum.
getDefaultTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
getExtensions() - Method in class com.thomasjensen.checkstyle.addons.sonarqube.CheckstyleExtensionPlugin
 
getFirstIdent(DetailAST) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Determine the text of the first direct IDENT child node.
getFullIdent(DetailAST) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Determine the full identifier of the current element on the AST.
getInnerSimpleName() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
Getter.
getMyPackage() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
getOuterFqcn() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
The fully qualified name of the outer class.
getOuterSimpleName() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
Getter.
getPackage() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
 
getRelevantTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
The tokens which this check is interested in.
getRelevantTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
 
getRelevantTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.coding.LostInstanceCheck
 
getRelevantTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
getRelevantTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
getRequiredTokens() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
getTokenName(int) - Method in class com.thomasjensen.checkstyle.addons.util.CheckstyleApiFixer
Returns the name of a token for a given ID.

H

hashCode() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
 

I

IllegalMethodCallCheck - Class in com.thomasjensen.checkstyle.addons.checks.coding
Flags calls to methods with certain names.
IllegalMethodCallCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
 
init() - Method in class com.thomasjensen.checkstyle.addons.checks.coding.LostInstanceCheck
 
isCheckActive() - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
Determines if the check is configured to do anything at all.
isCheckActive() - Method in class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
 
isCheckActive() - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
isRelevantCall(String, String) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
Filter method which determines if the given method call is considered relevant.
isRelevantCall(String, String) - Method in class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
 
isRelevantCall(String, String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 

L

leaveKnownType(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Called after leaving a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and the type's binary class name is known.
leaveKnownType(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
leaveToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Called after all the child nodes have been processed.
leaveToken(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
leaveToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
 
LocationReferenceCheck - Class in com.thomasjensen.checkstyle.addons.checks.misc
This check compares specified method arguments to the names of the current method or class.
LocationReferenceCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
LocationReferenceOption - Enum in com.thomasjensen.checkstyle.addons.checks.misc
Represents the possible locations that an instance of the LocationReferenceCheck may refer to.
LostInstanceCheck - Class in com.thomasjensen.checkstyle.addons.checks.coding
Checks that object instances created explicitly with new are actually used for something.
LostInstanceCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.coding.LostInstanceCheck
 

N

NEVER_MATCH - Static variable in class com.thomasjensen.checkstyle.addons.util.Util
A pattern that never matches (and does so efficiently)

P

processFiltered(File, List<String>) - Method in class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
 
PropertyCatalogCheck - Class in com.thomasjensen.checkstyle.addons.checks.misc
This check helps to keep a property file in sync with a piece of code that contains the property keys.
PropertyCatalogCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
Constructor.

R

RegexpOnFilenameCheck - Class in com.thomasjensen.checkstyle.addons.checks.regexp
This check applies a given regular expression to the names of files.
RegexpOnFilenameCheck() - Constructor for class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
 
RegexpOnFilenameOption - Enum in com.thomasjensen.checkstyle.addons.checks.regexp
Represents the possible modes of operation for the RegexpOnFilenameCheck.

S

setArgumentPosition(int) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
setBaseDir(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setCaseSensitive(boolean) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setEnumArgument(boolean) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setExcludedFields(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setExcludedQualifiers(String...) - Method in class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
Setter.
setIllegalMethodNames(String...) - Method in class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
Setter.
setLocation(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
setMethodCalls(String...) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
Setter.
setMode(String) - Method in class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
 
setPropertyFile(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setPropertyFileEncoding(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setRegexp(String) - Method in class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
Setter.
setReportDuplicates(boolean) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setReportOrphans(boolean) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setSelection(String) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
setSelection(String) - Method in class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
Setter.
setSimple(boolean) - Method in class com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameCheck
 
setVariableNames(String...) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
Setter.

T

toString() - Method in class com.thomasjensen.checkstyle.addons.checks.BinaryName
 

U

union(Set<E>, Set<E>) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Creates a new immutable HashSet which contains a union of the two given sets.
Util - Class in com.thomasjensen.checkstyle.addons.util
Utility class.

V

valueOf(String) - Static method in enum com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameOption
Returns the enum constant of this type with the specified name.
valueOfIgnoreCase(String) - Static method in enum com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceOption
Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.
valueOfIgnoreCase(String) - Static method in enum com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameOption
Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.
valueOfIgnoreCase(String, Class<E>) - Static method in class com.thomasjensen.checkstyle.addons.util.Util
Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.
values() - Static method in enum com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameOption
Returns an array containing the constants of this enum type, in the order they are declared.
visitKnownType(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Called after visiting a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and successfully determining the type's binary class name.
visitKnownType(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
visitMethodCall(String, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
Visitor method called when a relevant method call is encountered.
visitMethodCall(String, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck
 
visitMethodCall(String, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
visitToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck
 
visitToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck
 
visitToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.coding.LostInstanceCheck
 
visitToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.LocationReferenceCheck
 
visitToken(BinaryName, DetailAST) - Method in class com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck
 
A B C E F G H I L N P R S T U V 
Checkstyle Addons