AnnotationOnSameLine
Since Checkstyle 8.2
Description
Checks that annotations are located on the same line with their targets. Verifying with this check is not good practice, but it is using by some style guides.
Properties
| name | description | type | default value | since |
|---|---|---|---|---|
| tokens | tokens to check | subset of tokens CLASS_DEF , INTERFACE_DEF , ENUM_DEF , METHOD_DEF , CTOR_DEF , VARIABLE_DEF , PARAMETER_DEF , ANNOTATION_DEF , TYPECAST , LITERAL_THROWS , IMPLEMENTS_CLAUSE , TYPE_ARGUMENT , LITERAL_NEW , DOT , ANNOTATION_FIELD_DEF , RECORD_DEF , COMPACT_CTOR_DEF . | CLASS_DEF , INTERFACE_DEF , ENUM_DEF , METHOD_DEF , CTOR_DEF , VARIABLE_DEF , RECORD_DEF , COMPACT_CTOR_DEF . | 8.2 |
Examples
To configure the check:
<module name="Checker">
<module name="TreeWalker">
<module name="AnnotationOnSameLine"/>
</module>
</module>
Example:
class Example1 {
// violation below, "should be on the same line with its target."
@SuppressWarnings("deprecation")
public Example1() {
}
@SuppressWarnings("unchecked") public void fun2() {}
public void fun1() {}
// violation below, "should be on the same line with its target."
@Nullable
String s;
}
@SuppressWarnings("unchecked") class Test1 {
@Deprecated public Test1() {}
// violation below, "should be on the same line with its target."
@Before
public void fun1() {}
// violation below, "should be on the same line with its target."
@Before
@SuppressWarnings("unchecked") public void fun2() {}
// violation below, "should be on the same line with its target."
@SuppressWarnings("deprecation")
@Before public void fun3() {
}
}
To configure the check to check for annotations applied on interfaces, variables and constructors:
<module name="Checker">
<module name="TreeWalker">
<module name="AnnotationOnSameLine">
<property name="tokens"
value="INTERFACE_DEF, VARIABLE_DEF, CTOR_DEF"/>
</module>
</module>
</module>
Example:
class Example2 {
// violation below, "should be on the same line with its target."
@SuppressWarnings("deprecation")
public Example2() {
}
@SuppressWarnings("unchecked") public void fun2() {}
public void fun1() {}
// violation below, "should be on the same line with its target."
@Nullable
String s;
}
@SuppressWarnings("unchecked") class Test2 {
@Deprecated public Test2() {}
// ok below, @Before is not in tokens to check
@Before
public void fun1() {}
// ok below, @Before is not in tokens to check
@Before
@SuppressWarnings("unchecked") public void fun2() {}
// ok below, @SuppressWarnings is not in tokens to check
@SuppressWarnings("deprecation")
@Before public void fun3() {
}
}
Example of Usage
Violation Messages
All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.
Fully Qualified Name
com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
Use this fully qualified class name in configuration when an exact class reference is required.