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

Examples

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;

}
        

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.

Package

com.puppycrawl.tools.checkstyle.checks.annotation

Parent Module

TreeWalker