nc.ird.cantharella.utils

Class BeanTools

java.lang.Object

nc.ird.cantharella.utils.BeanTools

public final class BeanTools
extends Object

Tools for beans

Author:

Mickael Tricot, Adrien Cheype

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeanTools.AccessType Access type

Method Summary

Methods

Modifier and Type	Method and Description
static String	beanListToString(List<? extends Object> beansList, BeanTools.AccessType accessType, String... pathsToProperties) Display a list of beans by listing the specified properties (bean separated by "\n", properties by ", ")
static String	beanListToString(List<? extends Object> beansList, String delimiterBeans, String delimiterProperties, BeanTools.AccessType accessType, String... pathsToProperties) Display a list of beans by listing the specified properties
static <T> Comparator<T>	createPropertyComparator(String propertyExpression) Wrapping of Apache communs BeanComparator.
static <T> Comparator<T>	createPropertyComparator(String propertyExpression, Comparator<T> comparator) Wrapping of Apache communs BeanComparator to avoid "unchecked" tag in code.
static boolean	equals(Object thiz, Object obj, BeanTools.AccessType accessType, String... properties) Equals method
static boolean	equals(Object thiz, Object obj, Field... fields) Equals method
static Field	getAnnotatedPrivateField(Class<?> clazz, Class<? extends Annotation>... annotations) Retrieve an annotated from private field or from inherited private, protected or public field
static Field	getAnnotatedPublicField(Class<?> clazz, Class<? extends Annotation>... annotations) Retrieve an annotated public field
static Field	getAnnotatedPublicField(Object thiz, Class<? extends Annotation>... annotations) Retrieve an annotated public field or from inherited public field too
static <A extends Annotation> A	getAnnotationOnProperty(Class<?> beanClass, Class<A> annotation, String property) Get an annotation on a bean property
static Object	getValue(Object bean, BeanTools.AccessType accessType, String property) Get a property value for a specified bean
static Object	getValueFromPath(Object bean, BeanTools.AccessType accessType, String pathToProperty) Get a property value for a specified bean
static int	hashCode(Object thiz, Field... fields) HashCode method
static int	hashCode(Object thiz, Object... ids) HashCode method
static <A extends Annotation> boolean	isAnnotationOnProperty(Class<?> beanClass, Class<A> annotation, String property) Is there an annotation on a bean property
static String	toString(Object bean, BeanTools.AccessType accessType, String... properties) Display a bean by listing the specified properties (separated by "\n")
static String	toString(Object bean, String delimiter, BeanTools.AccessType accessType, String... pathsToProperties) Display a bean by listing the specified properties

Methods inherited from class java.lang.Object

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

Method Detail

equals

public static boolean equals(Object thiz,
             Object obj,
             BeanTools.AccessType accessType,
             String... properties)

Equals method

Parameters:

thiz - First object ("this", not null)

obj - Second object

accessType - Access type

properties - Properties (names) to check

Returns:

Equality

equals

public static boolean equals(Object thiz,
             Object obj,
             Field... fields)

Equals method

Parameters:

thiz - First object ("this", not null)

obj - Second object

fields - Public fields to check

Returns:

Equality

getAnnotatedPublicField

@SafeVarargs
public static Field getAnnotatedPublicField(Object thiz,
                                        Class<? extends Annotation>... annotations)
                                     throws NoSuchFieldException

Retrieve an annotated public field or from inherited public field too

Parameters:

thiz - Object

annotations - Annotations to retrieve on a public field

Returns:

First annotated public field

Throws:

NoSuchFieldException - If an annotation cannot be found

getAnnotatedPrivateField

@SafeVarargs
public static Field getAnnotatedPrivateField(Class<?> clazz,
                                         Class<? extends Annotation>... annotations)
                                      throws NoSuchFieldException

Retrieve an annotated from private field or from inherited private, protected or public field

Parameters:

clazz - The class which contains annotations (or inherited class)

annotations - Annotations to retrieve

Returns:

First annotated field finded

Throws:

NoSuchFieldException - If an annotation cannot be found

getAnnotatedPublicField

@SafeVarargs
public static Field getAnnotatedPublicField(Class<?> clazz,
                                        Class<? extends Annotation>... annotations)
                                     throws NoSuchFieldException

Retrieve an annotated public field

Parameters:

clazz - The class which contains annotations

annotations - Annotations to retrieve on a public field

Returns:

First annotated public field

Throws:

NoSuchFieldException - If an annotation cannot be found

getAnnotationOnProperty

public static <A extends Annotation> A getAnnotationOnProperty(Class<?> beanClass,
                                               Class<A> annotation,
                                               String property)
                                                    throws NoSuchFieldException

Get an annotation on a bean property

Type Parameters:

A - Annotation class

Parameters:

beanClass - Bean class

annotation - Annotation

property - Property name

Returns:

The annotation

Throws:

NoSuchFieldException - If the property does not exist

getValue

public static Object getValue(Object bean,
              BeanTools.AccessType accessType,
              String property)

Get a property value for a specified bean

Parameters:

bean - Bean

accessType - Access type

property - Property name

Returns:

Property value

getValueFromPath

public static Object getValueFromPath(Object bean,
                      BeanTools.AccessType accessType,
                      String pathToProperty)

Get a property value for a specified bean

Parameters:

bean - Bean

accessType - Access type

pathToProperty - properties path to access the property, example : beanX.beanY.propZ

Returns:

Property value

hashCode

public static int hashCode(Object thiz,
           Field... fields)

HashCode method

Parameters:

thiz - Bean (not null)

fields - Public fields to considere

Returns:

HashCode

hashCode

public static int hashCode(Object thiz,
           Object... ids)

HashCode method

Parameters:

thiz - Bean (not null)

ids - Bean IDs

Returns:

HashCode

isAnnotationOnProperty

public static <A extends Annotation> boolean isAnnotationOnProperty(Class<?> beanClass,
                                                    Class<A> annotation,
                                                    String property)
                                      throws NoSuchFieldException

Is there an annotation on a bean property

Type Parameters:

A - Annotation class

Parameters:

beanClass - Bean class

annotation - Annotation

property - Property name

Returns:

TRUE if the annotation is on the bean property

Throws:

NoSuchFieldException - If the property does not exist

toString

public static String toString(Object bean,
              String delimiter,
              BeanTools.AccessType accessType,
              String... pathsToProperties)

Display a bean by listing the specified properties

Parameters:

bean - Bean

delimiter - Delimiter between properties in the resulting string

accessType - Access type

pathsToProperties - Path of properties to display

Returns:

Bean display

toString

public static String toString(Object bean,
              BeanTools.AccessType accessType,
              String... properties)

Display a bean by listing the specified properties (separated by "\n")

Parameters:

bean - Bean

accessType - Access type

properties - Properties to display

Returns:

Bean display

beanListToString

public static String beanListToString(List<? extends Object> beansList,
                      BeanTools.AccessType accessType,
                      String... pathsToProperties)

Display a list of beans by listing the specified properties (bean separated by "\n", properties by ", ")

Parameters:

beansList - The beans list to browsed

accessType - Access type

pathsToProperties - Paths to properties to display

Returns:

Bean display

beanListToString

public static String beanListToString(List<? extends Object> beansList,
                      String delimiterBeans,
                      String delimiterProperties,
                      BeanTools.AccessType accessType,
                      String... pathsToProperties)

Display a list of beans by listing the specified properties

Parameters:

beansList - The beans list to browsed

delimiterBeans - Delimiter between beans in the resulting string

delimiterProperties - Delimiter between properties in the resulting string

accessType - Access type

pathsToProperties - Paths to properties to display

Returns:

Bean display

createPropertyComparator

public static <T> Comparator<T> createPropertyComparator(String propertyExpression)

Wrapping of Apache communs BeanComparator. Create a comparator which compares two beans by the specified bean property. Property expression can use Apache's nested, indexed, combinated, mapped syntax. @see Apache's Bean Comparator for more details.

Type Parameters:

T - generic type

Parameters:

propertyExpression - propertyExpression

Returns:

the comparator

createPropertyComparator

public static <T> Comparator<T> createPropertyComparator(String propertyExpression,
                                         Comparator<T> comparator)

Wrapping of Apache communs BeanComparator to avoid "unchecked" tag in code. Create a comparator which compares two beans by the specified bean property. Property expression can use Apache's nested, indexed, combinated, mapped syntax. @see Apache's Bean Comparator for more details.

Type Parameters:

T - generic type

Parameters:

propertyExpression - PropertyExpression

comparator - BeanComparator will pass the values of the specified bean property to this Comparator. If your bean property is not a comparable or contains null values, a suitable comparator may be supplied in this constructor

Returns:

the Comparator being used to compare beans