uk.co.jemos.podam.utils

Class PodamUtils

java.lang.Object

uk.co.jemos.podam.utils.PodamUtils

public class PodamUtils
extends Object

PODAM Utilities class.

Since:

1.0.0

Author:

mtedone

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOG The application logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PodamUtils() Non instantiable constructor

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsAnyAnnotation(Field field, List<Class<? extends Annotation>> annotations) Checks if the given field has any one of the annotations
static String	extractFieldNameFromSetterMethod(Method method) Given a setter Method, it extracts the field name, according to JavaBean standards
static ClassInfo	getClassInfo(Class<?> clazz) It returns a ClassInfo object for the given class
static ClassInfo	getClassInfo(Class<?> clazz, List<Class<? extends Annotation>> excludeFieldAnnotations) It returns a ClassInfo object for the given class
static Set<String>	getDeclaredInstanceFields(Class<?> clazz) Given a class, it returns a Set of its declared instance field names.
static Set<String>	getDeclaredInstanceFields(Class<?> clazz, List<Class<? extends Annotation>> excludeAnnotations) Given a class, it returns a Set of its declared instance field names.
static Method	getGetterFor(Field field)
static Set<Method>	getPojoSetters(Class<?> clazz, Set<String> classFields) Given a class and a set of class declared fields it returns a Set of setters matching the declared fields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.apache.log4j.Logger LOG

The application logger.

Constructor Detail

PodamUtils

private PodamUtils()

Non instantiable constructor

Method Detail

getClassInfo

public static ClassInfo getClassInfo(Class<?> clazz)

It returns a ClassInfo object for the given class

Parameters:

clazz - The class to retrieve info from

Returns:

a ClassInfo object for the given class

getClassInfo

public static ClassInfo getClassInfo(Class<?> clazz,
                     List<Class<? extends Annotation>> excludeFieldAnnotations)

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

Returns:

a ClassInfo object for the given class

getDeclaredInstanceFields

public static Set<String> getDeclaredInstanceFields(Class<?> clazz)

Given a class, it returns a Set of its declared instance field names.

Parameters:

clazz - The class to analyse to retrieve declared fields

Returns:

Set of a class declared field names.

getDeclaredInstanceFields

public static Set<String> getDeclaredInstanceFields(Class<?> clazz,
                                    List<Class<? extends Annotation>> excludeAnnotations)

Given a class, it returns a Set of its declared instance field names.

Parameters:

clazz - The class to analyse to retrieve declared fields

excludeAnnotations - fields marked with any of the mentioned annotations will be skipped

Returns:

Set of a class declared field names.

containsAnyAnnotation

public static boolean containsAnyAnnotation(Field field,
                            List<Class<? extends Annotation>> annotations)

Checks if the given field has any one of the annotations

Parameters:

field - the field to check for

annotations - the list of annotations to look for in the field

Returns:

true if the field is marked with any of the given annotations

getGetterFor

public static Method getGetterFor(Field field)

getPojoSetters

public static Set<Method> getPojoSetters(Class<?> clazz,
                         Set<String> classFields)

Given a class and a set of class declared fields it returns a Set of setters matching the declared fields

If present, a setter method is considered if and only if the classFields argument contains an attribute whose name matches the setter, according to JavaBean standards.

Parameters:

clazz - The class to analyse for setters

classFields - A Set of field names for which setters are to be found

Returns:

A Set of setters matching the class declared field names

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