com.thomasjensen.checkstyle.addons.checks.misc

Class PropertyCatalogCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

com.thomasjensen.checkstyle.addons.checks.misc.PropertyCatalogCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class PropertyCatalogCheck
extends AbstractAddonsCheck

This check helps to keep a property file in sync with a piece of code that contains the property keys.

Documentation

Author:

Thomas Jensen

Constructor Summary

Constructors

Constructor and Description
PropertyCatalogCheck()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTree(DetailAST pRootAst)
Set<Integer>	getRelevantTokens() The tokens which this check is interested in.
protected void	leaveKnownType(String pBinaryClassName, DetailAST pAst) Called after leaving a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and the type's binary class name is known.
void	setCaseSensitive(boolean pCaseSensitive)
void	setEnumArgument(boolean pEnumArgument)
void	setExcludedFields(String pExcludedFields)
void	setPropertyFile(String pTemplate)
void	setPropertyFileEncoding(String pEncoding)
void	setReportDuplicates(boolean pReportDuplicates)
void	setReportOrphans(boolean pReportOrphans)
void	setSelection(String pSelection)
protected void	visitKnownType(String pBinaryClassName, DetailAST pAst) Called after visiting a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and successfully determining the type's binary class name.
protected void	visitToken(String pBinaryClassName, DetailAST pAst) Called to process a token.

Methods inherited from class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

finishTree, finishTree, getClassDeclarationPosition, getCurrentBinaryName, getDefaultTokens, getMyPackage, getRequiredTokens, isCheckStopped, leaveToken, leaveToken, stopChecking, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyCatalogCheck

public PropertyCatalogCheck()

Method Detail

getRelevantTokens

public Set<Integer> getRelevantTokens()

Description copied from class: AbstractAddonsCheck

The tokens which this check is interested in. Will be added to the tokens of the base class.

Specified by:

getRelevantTokens in class AbstractAddonsCheck

Returns:

the relevant tokens

beginTree

public void beginTree(DetailAST pRootAst)

Overrides:

beginTree in class AbstractAddonsCheck

visitKnownType

protected void visitKnownType(@Nonnull
                  String pBinaryClassName,
                  @Nonnull
                  DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called after visiting a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and successfully determining the type's binary class name. This is useful in a Java source file with nested inner classes. If the implementing check registers for any of the above tokens, the regular call to AbstractAddonsCheck.visitToken(String, DetailAST) will be performed in addition to (after) this one.

Overrides:

visitKnownType in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the binary class name of the visited type

pAst - the token to process

leaveKnownType

protected void leaveKnownType(@Nonnull
                  String pBinaryClassName,
                  @Nonnull
                  DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called after leaving a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and the type's binary class name is known. This is useful in a Java source file with nested inner classes. If the implementing check registers for any of the above tokens, the regular call to AbstractAddonsCheck.leaveToken(String, DetailAST) will be performed in addition to (before) this one.

Overrides:

leaveKnownType in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the binary class name of the visited type

pAst - the token being completed

visitToken

protected void visitToken(@Nullable
              String pBinaryClassName,
              @Nonnull
              DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called to process a token.

Overrides:

visitToken in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token to process

setSelection

public void setSelection(String pSelection)

setExcludedFields

public void setExcludedFields(String pExcludedFields)

setEnumArgument

public void setEnumArgument(boolean pEnumArgument)

setPropertyFile

public void setPropertyFile(String pTemplate)

setPropertyFileEncoding

public void setPropertyFileEncoding(String pEncoding)

setReportDuplicates

public void setReportDuplicates(boolean pReportDuplicates)

setReportOrphans

public void setReportOrphans(boolean pReportOrphans)

setCaseSensitive

public void setCaseSensitive(boolean pCaseSensitive)