javadoc

/**
 * Comments regarding MyClass
 */
private int field;

A documentation comment.

Configuration options

contents

Checks the content of the javadoc element.

search:
  javadoc:
    contents:
      contains: "javadoc"
/**
 * This class contains the string javadoc
 */
class MyClass {
    /**
     * This method doesn't
     */
    public void myMethod() {

    }
}

owner

Checks what the annotation belongs to. The owner can be a class, method, field or parameter target.

search:
  javadoc:
    owner:
      method: {}
/**
 *
 */
class MyClass {
    /**
     *
     */
    public void myMethod() {

    }
}

Generic Configuration options

The following options are generic and available for every target.

anyOf

Similar to the logical operator OR: one or more descendant options should match.

search:
  <target>:
    anyOf:
    - name: "illegal"
    - name: "alsoIllegal"

allOf

Similar to the logical operator AND: all descendant options must match.

search:
  <target>:
    allOf:
    - annotation: "HttpPost"
    - annotation: "AllowUnAuthorized"

with

The only purpose to use this field is to make the recipe easier to read. It provides no additional functionality.

search:
  <target>:
    with:
      annotation: "HttpPost"

not, without

Works as the logical operator NOT. It will negate the result of the descendant options. Sensei presents the user with both options. They display the same behavior, but certain scenarios tend to read better using without.

search:
  <target>:
    not:
      annotation: "HttpPost"
search:
  <target>:
    without:
      annotation: "HttpPost"

in

Performs a structural search, this option is mainly used to narrow down recipes. Examples of this would be to only analyze and mark code inside a certain class or method that has a specific annotation. However, we haven't limited this option to only support these two scenarios. More advanced configuration can be achieved.

search:
  <target>:
    in:
      class:
        name:
          contains: "Controller"
search:
  <target>:
    in:
      method:
        annotation:
          type: "HttpPost"