PodamUtils (podam 6.0.2.RELEASE API)

java.lang.Object
- uk.co.jemos.podam.api.PodamUtils

public final class PodamUtils
extends Object

PODAM Utilities class.

Since:: 1.0.0
Author:: mtedone

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`GETTER_PREFIX`
`private static String`	`GETTER_PREFIX2`
`private static org.slf4j.Logger`	`LOG` The application logger.
`static char[]`	`NICE_ASCII_CHARACTERS` An array of valid String characters
`private static int`	`SETTER_IDENTIFIER_LENGTH`

Constructor Summary

Constructors
Modifier Constructor and Description

private PodamUtils()
Non instantiable constructor

Constructors
Modifier	Constructor and Description
`private`	`PodamUtils()` Non instantiable constructor

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`containsAnyAnnotation(Field field, Set<Class<? extends Annotation>> annotations)` Checks if the given field has any one of the annotations
`private static boolean`	`containsAnyAnnotation(Method method, Set<Class<? extends Annotation>> annotations)` Checks if the given method has any one of the annotations
`static String`	`extractFieldNameFromGetterMethod(Method method)` Given a getter `Method`, it extracts the field name, according to JavaBean standards
`static String`	`extractFieldNameFromSetterMethod(Method method)` Given a setter `Method`, it extracts the field name, according to JavaBean standards
`static void`	`fillPojoSets(Class<?> clazz, Set<Field> classFields, Set<Method> classGetters, Set<Method> classSetters, Set<Class<? extends Annotation>> excludeAnnotations, Set<String> excludedFields)` Given a class and a set of class declared fields it returns a Set of setters, getters and fields defined for this class
`static List<Annotation>`	`getAttributeAnnotations(Field attribute, Method setter)` Given the attribute and setter it combines annotations from them or an empty collection if no custom annotations were found
`static ClassInfo`	`getClassInfo(Class<?> clazz, ClassAttributeApprover attributeApprover)` It returns a `ClassInfo` object for the given class
`static ClassInfo`	`getClassInfo(Class<?> clazz, Set<Class<? extends Annotation>> excludeFieldAnnotations, Set<String> excludedFields, ClassAttributeApprover attributeApprover)` It returns a `ClassInfo` object for the given class
`static ClassInfo`	`getClassInfo(Class<?> clazz, Set<Class<? extends Annotation>> excludeFieldAnnotations, Set<String> excludedFields, ClassAttributeApprover attributeApprover, Collection<Method> extraMethods)`
`static Field`	`getField(Class<?> pojoClass, String attributeName)` It returns a `Field` matching the attribute name or null if a field was not found.
`static <T> T`	`getFieldValue(Object pojo, String attributeName)` It returns an value for a `Field` matching the attribute name or null if a field was not found.
`static long`	`getLongInRange(long minValue, long maxValue)` It returns a long/Long value between min and max value (included).
`static Character`	`getNiceCharacter()` Generates random character from set valid for identifiers in Java language
`static Class<?>`	`primitiveToBoxedType(Class<?> primitiveType)` Finds boxed type for a primitive type

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

- Field Detail
  - SETTER_IDENTIFIER_LENGTH
```
private static final int SETTER_IDENTIFIER_LENGTH
```
    See Also:
    
    Constant Field Values
  - GETTER_PREFIX
```
private static final String GETTER_PREFIX
```
    See Also:
    
    Constant Field Values
  - GETTER_PREFIX2
```
private static final String GETTER_PREFIX2
```
    See Also:
    
    Constant Field Values
  - NICE_ASCII_CHARACTERS
```
public static final char[] NICE_ASCII_CHARACTERS
```
    An array of valid String characters
  - LOG
```
private static final org.slf4j.Logger LOG
```
    The application logger.
- Constructor Detail
  - PodamUtils
```
private PodamUtils()
```
    Non instantiable constructor
- Method Detail
  - getClassInfo
```
public static ClassInfo getClassInfo(Class<?> clazz,
                                     ClassAttributeApprover attributeApprover)
```
    It returns a ClassInfo object for the given class
    
    Parameters:
    
    clazz - The class to retrieve info from
    
    attributeApprover - a ClassAttributeApprover implementation, which attributes to skip and which to process. If one hasn't been provided, Podam will use the default one in the DefaultClassInfoStrategy class.
    
    Returns:
    
    a ClassInfo object for the given class
  - getClassInfo
```
public static ClassInfo getClassInfo(Class<?> clazz,
                                     Set<Class<? extends Annotation>> excludeFieldAnnotations,
                                     Set<String> excludedFields,
                                     ClassAttributeApprover attributeApprover)
```
    It returns a ClassInfo object for the given class
    
    Parameters:
    
    clazz - The class to retrieve info from
    
    excludeFieldAnnotations - the fields marked with any of these annotations will not be included in the class info
    
    excludedFields - the fields matching the given names will not be included in the class info
    
    attributeApprover - a ClassAttributeApprover implementation, which defines which attributes to skip and which to process
    
    Returns:
    
    a ClassInfo object for the given class
  - getClassInfo
```
public static ClassInfo getClassInfo(Class<?> clazz,
                                     Set<Class<? extends Annotation>> excludeFieldAnnotations,
                                     Set<String> excludedFields,
                                     ClassAttributeApprover attributeApprover,
                                     Collection<Method> extraMethods)
```
  - containsAnyAnnotation
```
public static boolean containsAnyAnnotation(Field field,
                                            Set<Class<? extends Annotation>> annotations)
```
    Checks if the given field has any one of the annotations
    
    Parameters:
    
    field - the field to check for
    
    annotations - the set of annotations to look for in the field
    
    Returns:
    
    true if the field is marked with any of the given annotations
  - containsAnyAnnotation
```
private static boolean containsAnyAnnotation(Method method,
                                             Set<Class<? extends Annotation>> annotations)
```
    Checks if the given method has any one of the annotations
    
    Parameters:
    
    method - the method to check for
    
    annotations - the set of annotations to look for in the field
    
    Returns:
    
    true if the field is marked with any of the given annotations
  - fillPojoSets
```
public static void fillPojoSets(Class<?> clazz,
                                Set<Field> classFields,
                                Set<Method> classGetters,
                                Set<Method> classSetters,
                                Set<Class<? extends Annotation>> excludeAnnotations,
                                Set<String> excludedFields)
```
    Given a class and a set of class declared fields it returns a Set of setters, getters and fields defined for this class
    Anything present: setter, getter or field will be recorded as three independent sets available for future analysis
    
    Parameters:
    
    clazz - The class to analyze for setters
    
    classFields - The Set which will be filled with class' fields
    
    classGetters - The Set which will be filled with class' getters
    
    classSetters - The Set which will be filled with class' setters
    
    excludeAnnotations - The Set containing annotations marking fields to be excluded
    
    excludedFields - The Set containing field names to be excluded
  - extractFieldNameFromSetterMethod
```
public static String extractFieldNameFromSetterMethod(Method method)
```
    Given a setter Method, it extracts the field name, according to JavaBean standards
    This method, given a setter method, it returns the corresponding attribute name. For example: given setIntField the method would return intField. The correctness of the return value depends on the adherence to JavaBean standards.
    
    Parameters:
    
    method - The setter method from which the field name is required
    
    Returns:
    
    The field name corresponding to the setter
  - extractFieldNameFromGetterMethod
```
public static String extractFieldNameFromGetterMethod(Method method)
```
    Given a getter Method, it extracts the field name, according to JavaBean standards
    This method, given a getter method, it returns the corresponding attribute name. For example: given getIntField the method would return intField; given isBoolField the method would return boolField. The correctness of the return value depends on the adherence to JavaBean standards.
    
    Parameters:
    
    method - The setter method from which the field name is required
    
    Returns:
    
    The field name corresponding to the setter
  - getField
```
public static Field getField(Class<?> pojoClass,
                             String attributeName)
```
    It returns a Field matching the attribute name or null if a field was not found.
    
    Parameters:
    
    pojoClass - The class supposed to contain the field
    
    attributeName - The field name
    
    Returns:
    
    a Field matching the attribute name or null if a field was not found.
  - getFieldValue
```
public static <T> T getFieldValue(Object pojo,
                                  String attributeName)
```
    It returns an value for a Field matching the attribute name or null if a field was not found.
    
    Type Parameters:
    
    T - The type of field to be returned
    
    Parameters:
    
    pojo - The class supposed to contain the field
    
    attributeName - The field name
    
    Returns:
    
    an instance of Field matching the attribute name or null if a field was not found.
  - getAttributeAnnotations
```
public static List<Annotation> getAttributeAnnotations(Field attribute,
                                                       Method setter)
```
    Given the attribute and setter it combines annotations from them or an empty collection if no custom annotations were found
    
    Parameters:
    
    attribute - The class attribute
    
    setter - The class attribute's setter
    
    Returns:
    
    all annotations for the attribute
  - getNiceCharacter
```
public static Character getNiceCharacter()
```
    Generates random character from set valid for identifiers in Java language
    
    Returns:
    
    random character suitable for identifier
  - getLongInRange
```
public static long getLongInRange(long minValue,
                                  long maxValue)
```
    It returns a long/Long value between min and max value (included).
    
    Parameters:
    
    minValue - The minimum value for the returned value
    
    maxValue - The maximum value for the returned value
    
    Returns:
    
    A long/Long value between min and max value (included).
  - primitiveToBoxedType
```
public static Class<?> primitiveToBoxedType(Class<?> primitiveType)
```
    Finds boxed type for a primitive type
    
    Parameters:
    
    primitiveType - Primitive type to find boxed type for
    
    Returns:
    
    A boxed type or the same type, if original type was not primitive

Class PodamUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SETTER_IDENTIFIER_LENGTH

GETTER_PREFIX

GETTER_PREFIX2

NICE_ASCII_CHARACTERS

LOG

Constructor Detail

PodamUtils

Method Detail

getClassInfo

getClassInfo

getClassInfo

containsAnyAnnotation

containsAnyAnnotation

fillPojoSets

extractFieldNameFromSetterMethod

extractFieldNameFromGetterMethod

getField

getFieldValue

getAttributeAnnotations

getNiceCharacter

getLongInRange

primitiveToBoxedType