HandlerUtil (Lombok)

java.lang.Object
- lombok.core.handlers.HandlerUtil

```
public class HandlerUtil
extends Object
```
Container for static utility methods useful for some of the standard lombok handlers, regardless of target platform (e.g. useful for both javac and Eclipse lombok implementations).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_EXCEPTION_FOR_NON_NULL`
`static List<Class<? extends Annotation>>`	`INVALID_ON_BUILDERS`
`static Pattern`	`NON_NULL_PATTERN` Matches the simple part of any annotation that lombok considers as indicative of NonNull status.
`static Pattern`	`NULLABLE_PATTERN` Matches the simple part of any annotation that lombok considers as indicative of Nullable status.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`autoSingularize(String plural)`
`static String`	`buildAccessorName(String prefix, String suffix)`
`static boolean`	`checkName(String nameSpec, String identifier, LombokNode<?,?,?> errorNode)` Checks if the given name is a valid identifier.
`static void`	`handleExperimentalFlagUsage(LombokNode<?,?,?> node, ConfigurationKey<FlagUsageType> key, String featureName)`
`static void`	`handleFlagUsage(LombokNode<?,?,?> node, ConfigurationKey<FlagUsageType> key, String featureName)`
`static void`	`handleFlagUsage(LombokNode<?,?,?> node, ConfigurationKey<FlagUsageType> key1, String featureName1, ConfigurationKey<FlagUsageType> key2, String featureName2)`
`static int`	`primeForFalse()`
`static int`	`primeForHashcode()`
`static int`	`primeForNull()`
`static int`	`primeForTrue()`
`static CharSequence`	`removePrefix(CharSequence fieldName, List<String> prefixes)` Given the name of a field, return the 'base name' of that field.
`static boolean`	`shouldAddGenerated(LombokNode<?,?,?> node)`
`static boolean`	`shouldReturnThis0(AnnotationValues<Accessors> accessors, AST<?,?,?> ast)`
`static List<String>`	`toAllGetterNames(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Returns all names of methods that would represent the getter for a field with the provided name.
`static List<String>`	`toAllSetterNames(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Returns all names of methods that would represent the setter for a field with the provided name.
`static List<String>`	`toAllWitherNames(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Returns all names of methods that would represent the wither for a field with the provided name.
`static String`	`toGetterName(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Generates a getter name from a given field name.
`static String`	`toSetterName(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Generates a setter name from a given field name.
`static String`	`toWitherName(AST<?,?,?> ast, AnnotationValues<Accessors> accessors, CharSequence fieldName, boolean isBoolean)` Generates a wither name from a given field name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INVALID_ON_BUILDERS
```
public static final List<Class<? extends Annotation>> INVALID_ON_BUILDERS
```
  - 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.
  - DEFAULT_EXCEPTION_FOR_NON_NULL
```
public static final String DEFAULT_EXCEPTION_FOR_NON_NULL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - primeForHashcode
```
public static int primeForHashcode()
```
  - primeForTrue
```
public static int primeForTrue()
```
  - primeForFalse
```
public static int primeForFalse()
```
  - primeForNull
```
public static int primeForNull()
```
  - checkName
```
public static boolean checkName(String nameSpec,
                                String identifier,
                                LombokNode<?,?,?> errorNode)
```
    Checks if the given name is a valid identifier. If it is, this returns true and does nothing else. If it isn't, this returns false and adds an error message to the supplied node.
  - autoSingularize
```
public static String autoSingularize(String plural)
```
  - handleFlagUsage
```
public static void handleFlagUsage(LombokNode<?,?,?> node,
                                   ConfigurationKey<FlagUsageType> key,
                                   String featureName)
```
  - shouldAddGenerated
```
public static boolean shouldAddGenerated(LombokNode<?,?,?> node)
```
  - handleExperimentalFlagUsage
```
public static void handleExperimentalFlagUsage(LombokNode<?,?,?> node,
                                               ConfigurationKey<FlagUsageType> key,
                                               String featureName)
```
  - handleFlagUsage
```
public static void handleFlagUsage(LombokNode<?,?,?> node,
                                   ConfigurationKey<FlagUsageType> key1,
                                   String featureName1,
                                   ConfigurationKey<FlagUsageType> key2,
                                   String featureName2)
```
  - shouldReturnThis0
```
public static boolean shouldReturnThis0(AnnotationValues<Accessors> accessors,
                                        AST<?,?,?> ast)
```
  - removePrefix
```
public static CharSequence removePrefix(CharSequence fieldName,
                                        List<String> prefixes)
```
    Given the name of a field, return the 'base name' of that field. For example, fFoobar becomes foobar if f is in the prefix list. For prefixes that end in a letter character, the next character must be a non-lowercase character (i.e. hashCode is not ashCode even if h is in the prefix list, but hAshcode would become ashCode). The first prefix that matches is used. If the prefix list is empty, or the empty string is in the prefix list and no prefix before it matches, the fieldName will be returned verbatim. If no prefix matches and the empty string is not in the prefix list and the prefix list is not empty, null is returned.
    
    Parameters:
    
    fieldName - The full name of a field.
    
    prefixes - A list of prefixes, usually provided by the Accessors settings annotation, listing field prefixes.
    
    Returns:
    
    The base name of the field.
  - toGetterName
```
public static String toGetterName(AST<?,?,?> ast,
                                  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(AST<?,?,?> ast,
                                  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(AST<?,?,?> ast,
                                  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(AST<?,?,?> ast,
                                            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(AST<?,?,?> ast,
                                            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(AST<?,?,?> ast,
                                            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.
  - buildAccessorName
```
public static String buildAccessorName(String prefix,
                                       String suffix)
```
    Parameters:
    
    prefix - Something like get or set or is.
    
    suffix - Something like running.
    
    Returns:
    
    prefix + smartly title-cased suffix. For example, setRunning.

Class HandlerUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_ON_BUILDERS

NON_NULL_PATTERN

NULLABLE_PATTERN

DEFAULT_EXCEPTION_FOR_NON_NULL

Method Detail

primeForHashcode

primeForTrue

primeForFalse

primeForNull

checkName

autoSingularize

handleFlagUsage

shouldAddGenerated

handleExperimentalFlagUsage

handleFlagUsage

shouldReturnThis0

removePrefix

toGetterName

toSetterName

toWitherName

toAllGetterNames

toAllSetterNames

toAllWitherNames

buildAccessorName