Since Checkstyle 8.2
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.
| 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 |
To configure the check:
<module name="AnnotationOnSameLine"/>
Example:
class Foo {
@SuppressWarnings("deprecation") // violation, annotation should be on the same line
public Foo() {
}
@SuppressWarnings("unchecked") public void fun2() { // OK
}
}
@SuppressWarnings("unchecked") class Bar extends Foo { // OK
@Deprecated public Bar() { // OK
}
@Override // violation, annotation should be on the same line
public void fun1() {
}
@Before @Override public void fun2() { // OK
}
@SuppressWarnings("deprecation") // violation, annotation should be on the same line
@Before public void fun3() {
}
}
To configure the check to check for annotations applied on interfaces, variables and constructors:
<module name="AnnotationOnSameLine">
<property name="tokens"
value="INTERFACE_DEF, VARIABLE_DEF, CTOR_DEF"/>
</module>
Example:
@Deprecated interface Foo { // OK
void doSomething();
}
class Bar implements Foo {
@SuppressWarnings("deprecation") // violation, annotation should be on the same line
public Bar() {
}
@Override // OK
public void doSomething() {
}
@Nullable // violation, annotation should be on the same line
String s;
}
All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.
com.puppycrawl.tools.checkstyle.checks.annotation