field ¶

class X {
    private int x;
}

A variable defined at class level

Contents

field
- Configuration options
  - type
  - name
  - modifier
  - annotation
  - javadoc
- Generic Configuration options
  - anyOf
  - allOf
  - with
  - not, without
  - in
  - label

Configuration options ¶

type ¶

Checks the declaration type of the field.

search:
  field:
    type: "String"

 class SomeClass {
     private String example = "test";
 }

name ¶

Checks the name of the field.

search:
  field:
    name: "example"

 class SomeClass {
    private String example = "test";
 }

modifier ¶

Checks if the field contains a modifier that matches the string target. All modifiers are matched separately. To match multiple modifiers, use allOf or anyOf.

search:
  field:
    modifier: "private"

 class SomeClass {
    private String example = "test";
 }

example of multiple modifiers

search:
  field:
    allOf:
    - modifier: "public"
    - modifier: "static"
    - modifier: "final"

 class SomeClass {
     public static final String example = "test";
 }

annotation ¶

Checks if the specified annotation is present. This option is configured using the annotation target.

search:
  field:
    annotation: "Deprecated"

 class SomeClass {
     @Deprecated
     private String example = "test";
 }

javadoc ¶

Checks if the defined field contains a javadoc comment that matches the javadoc target.

search:
  field:
    javadoc:
      contents:
        matches: ".*example.*"

 class Example {
     /**
      * this is an example.
      */
     private String example;
 }

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"

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"

label ¶

Labels do not modify the behavior of searching elements, but they allow addressing a specific element in a quick fix.

search:
  element:
    tagName: inner
    attribute:
      name: data
    in:
      element:
        label: outerelement

availableFixes:
- name: add the 'type' attribute on the outer element
  actions:
  - add:
      attribute:
        name: type
        value: '"unsafe"'
      target: label:outerelement

- <outer>
+ <outer type="unsafe">
      <inner data="test"/>
  </outer>