Field Detail

• NON_NULL_PATTERN

  public static final Pattern NON_NULL_PATTERN

  Matches the simple part of any annotation that lombok considers as indicative of NonNull status.

• NULLABLE_PATTERN

  public static final Pattern NULLABLE_PATTERN

  Matches the simple part of any annotation that lombok considers as indicative of Nullable status.

Method Detail

• toGetterName

  public static String toGetterName(AnnotationValues<Accessors> accessors,
                    CharSequence fieldName,
                    boolean isBoolean)

  Generates a getter name from a given field name. Strategy:

  • Reduce the field's name to its base name by stripping off any prefix (from Accessors). If the field name does not fit the prefix list, this method immediately returns null.
  • If Accessors has fluent=true, then return the basename.
  • Pick a prefix. 'get' normally, but 'is' if isBoolean is true.
  • Only if isBoolean is true: Check if the field starts with is followed by a non-lowercase character. If so, return the field name verbatim.
  • Check if the first character of the field is lowercase. If so, check if the second character exists and is title or upper case. If so, uppercase the first character. If not, titlecase the first character.
  • Return the prefix plus the possibly title/uppercased first character, and the rest of the field name.

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type java.lang.Boolean, you should provide false.

  Returns:

  The getter name for this field, or null if this field does not fit expected patterns and therefore cannot be turned into a getter name.

• toSetterName

  public static String toSetterName(AnnotationValues<Accessors> accessors,
                    CharSequence fieldName,
                    boolean isBoolean)

  Generates a setter name from a given field name. Strategy:

  • Reduce the field's name to its base name by stripping off any prefix (from Accessors). If the field name does not fit the prefix list, this method immediately returns null.
  • If Accessors has fluent=true, then return the basename.
  • Only if isBoolean is true: Check if the field starts with is followed by a non-lowercase character. If so, replace is with set and return that.
  • Check if the first character of the field is lowercase. If so, check if the second character exists and is title or upper case. If so, uppercase the first character. If not, titlecase the first character.
  • Return "set" plus the possibly title/uppercased first character, and the rest of the field name.

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type java.lang.Boolean, you should provide false.

  Returns:

  The setter name for this field, or null if this field does not fit expected patterns and therefore cannot be turned into a getter name.

• toWitherName

  public static String toWitherName(AnnotationValues<Accessors> accessors,
                    CharSequence fieldName,
                    boolean isBoolean)

  Generates a wither name from a given field name. Strategy:

  • Reduce the field's name to its base name by stripping off any prefix (from Accessors). If the field name does not fit the prefix list, this method immediately returns null.
  • Only if isBoolean is true: Check if the field starts with is followed by a non-lowercase character. If so, replace is with with and return that.
  • Check if the first character of the field is lowercase. If so, check if the second character exists and is title or upper case. If so, uppercase the first character. If not, titlecase the first character.
  • Return "with" plus the possibly title/uppercased first character, and the rest of the field name.

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type java.lang.Boolean, you should provide false.

  Returns:

  The wither name for this field, or null if this field does not fit expected patterns and therefore cannot be turned into a getter name.

• toAllGetterNames

  public static List<String> toAllGetterNames(AnnotationValues<Accessors> accessors,
                              CharSequence fieldName,
                              boolean isBoolean)

  Returns all names of methods that would represent the getter for a field with the provided name. For example if isBoolean is true, then a field named isRunning would produce:
  [isRunning, getRunning, isIsRunning, getIsRunning]

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type 'java.lang.Boolean', you should provide false.

• toAllSetterNames

  public static List<String> toAllSetterNames(AnnotationValues<Accessors> accessors,
                              CharSequence fieldName,
                              boolean isBoolean)

  Returns all names of methods that would represent the setter for a field with the provided name. For example if isBoolean is true, then a field named isRunning would produce:
  [setRunning, setIsRunning]

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type 'java.lang.Boolean', you should provide false.

• toAllWitherNames

  public static List<String> toAllWitherNames(AnnotationValues<Accessors> accessors,
                              CharSequence fieldName,
                              boolean isBoolean)

  Returns all names of methods that would represent the wither for a field with the provided name. For example if isBoolean is true, then a field named isRunning would produce:
  [withRunning, withIsRunning]

  Parameters:

  accessors - Accessors configuration.

  fieldName - the name of the field.

  isBoolean - if the field is of type 'boolean'. For fields of type 'java.lang.Boolean', you should provide false.