com.puppycrawl.tools.checkstyle.checks.annotation

Class AnnotationLocationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class AnnotationLocationCheck
extends Check

Check location of annotation on language elements. By default, Check enforce to locate annotations immediately after documentation block and before target element, annotation should be located on separate line from target element.

Example:

 @Override
 @Nullable
 public String getNameIfPresent() { ... }
 

Check have following options:

• allowSamelineMultipleAnnotations - to allow annotation to be located on the same line as target element. Default value is false.
• allowSamelineSingleParameterlessAnnotation - to allow single parameterless annotation to be located on the same line as target element. Default value is false.
• allowSamelineParameterizedAnnotation - to allow parameterized annotation to be located on the same line as target element. Default value is false.

Example to allow single parameterless annotation on the same line:

 @Override public int hashCode() { ... }
 

Use following configuration:

 <module name="AnnotationLocation">
    <property name="allowSamelineMultipleAnnotations" value="false"/>
    <property name="allowSamelineSingleParameterlessAnnotation"
    value="true"/>
    <property name="allowSamelineParameterizedAnnotation" value="false"
    />
 </module>
 

Example to allow multiple parameterized annotations on the same line:

 @SuppressWarnings("deprecation") @Mock DataLoader loader;
 

Use following configuration:

 <module name="AnnotationLocation">
    <property name="allowSamelineMultipleAnnotations" value="true"/>
    <property name="allowSamelineSingleParameterlessAnnotation"
    value="true"/>
    <property name="allowSamelineParameterizedAnnotation" value="true"
    />
 </module>
 

Example to allow multiple parameterless annotations on the same line:

 @Partial @Mock DataLoader loader;
 

Use following configuration:

 <module name="AnnotationLocation">
    <property name="allowSamelineMultipleAnnotations" value="true"/>
    <property name="allowSamelineSingleParameterlessAnnotation"
    value="true"/>
    <property name="allowSamelineParameterizedAnnotation" value="false"
    />
 </module>
 

Author:

maxvetrenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY_ANNOTATION_LOCATION A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_KEY_ANNOTATION_LOCATION_ALONE A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
AnnotationLocationCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setAllowSamelineMultipleAnnotations(boolean allow) Some javadoc.
void	setAllowSamelineParametrizedAnnotation(boolean allow) Some javadoc.
void	setAllowSamelineSingleParameterlessAnnotation(boolean allow) Some javadoc.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, 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

Field Detail

MSG_KEY_ANNOTATION_LOCATION_ALONE

public static final String MSG_KEY_ANNOTATION_LOCATION_ALONE

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_KEY_ANNOTATION_LOCATION

public static final String MSG_KEY_ANNOTATION_LOCATION

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

AnnotationLocationCheck

public AnnotationLocationCheck()

Method Detail

setAllowSamelineSingleParameterlessAnnotation

public final void setAllowSamelineSingleParameterlessAnnotation(boolean allow)

Some javadoc.

Parameters:

allow - Some javadoc.

setAllowSamelineParametrizedAnnotation

public final void setAllowSamelineParametrizedAnnotation(boolean allow)

Some javadoc.

Parameters:

allow - Some javadoc.

setAllowSamelineMultipleAnnotations

public final void setAllowSamelineMultipleAnnotations(boolean allow)

Some javadoc.

Parameters:

allow - Some javadoc.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process