com.github.sevntu.checkstyle.checks.annotation

Class ForbidAnnotationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.github.sevntu.checkstyle.checks.annotation.ForbidAnnotationCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class ForbidAnnotationCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck

Forbid specific annotation of variable,methods,class,package and other. If you want to forbid use of '@XXX' annotation with methods and class, you must write:

 <module name="ForbidAnnotation"> <property name="annotationNames"
 value="XXX"/> <property name="annotationTargets"
 value="METHOD_DEF,CLASS_DEF"/> </module>
 

Since:

1.12.0

Author:

Hidoyatov Victor

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is used to retrieve check message from 'messages.properties' file.

Constructor Summary

Constructors

Constructor and Description
ForbidAnnotationCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	setAnnotationNames(String... names) Setter for annotationNames.
void	setAnnotationTargets(String... targets) Getter for annotationNames.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST annotation)

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

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

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

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

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is used to retrieve check message from 'messages.properties' file.

See Also:

Constant Field Values

Constructor Detail

ForbidAnnotationCheck

public ForbidAnnotationCheck()

Method Detail

setAnnotationNames

public void setAnnotationNames(String... names)

Setter for annotationNames.

Parameters:

names - - array of annotation's names

setAnnotationTargets

public void setAnnotationTargets(String... targets)

Getter for annotationNames.

Parameters:

targets - - array of type's names

getDefaultTokens

public int[] getDefaultTokens()

Specified by:

getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getAcceptableTokens

public int[] getAcceptableTokens()

Specified by:

getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getRequiredTokens

public int[] getRequiredTokens()

Specified by:

getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST annotation)

Overrides:

visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck