com.massa.util.property

Class PropertyUtils

java.lang.Object

com.massa.util.property.PropertyUtils

public class PropertyUtils
extends Object

Utility class for property framework. The default instance might be accessed by the getDefaultInstance() method, but it might be overridden for specific purposes.
This utility class provides method to access bean properties in a "one shot" mode. It means the String reprensenting the property will be interpreted (i.e. compiled) each time.
To improve performances, to access multiple times the same property (enven on different target instances) you should use directly the Property Compiler and keep the compiled property in cache.
For example :
IProperty property = ConfigDiscovery.getPropertyCompiler().compile("propertyToAccess.subProperty"); for (MyBean bean: allBeans) { SubPropertyType subPropertyValue = property.get(new PropertySource(bean)); // Do something with value... }

Since:

1.8.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyUtils()

Method Summary

Modifier and Type	Method and Description
static Object	get(Object obj, String property) Gets property value.
static PropertyUtils	getDefaultInstance()
static Class<?>	getGenericCollectionType(Object obj, String property) Returns the generic type if the property type is a collection, or null if it cannot be resolved or if the property type is not a collection.
static Class<?>	getType(Object obj, String property) Gets property type if it can be resolved or null.
static boolean	isReadable(Object obj, String property) Tells if property can be read.
static boolean	isWriteable(Object obj, String property) Tells if property can be set.
static Object	safeSet(Object obj, String property, Object value) Calls set after performing advanced cast, to handle converting an object into a Collection of another type than the object's.
static Object	set(Object obj, String property, Object value) Sets property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUtils

protected PropertyUtils()

Method Detail

getDefaultInstance

public static PropertyUtils getDefaultInstance()

Returns:

Default global instance.

isReadable

public static boolean isReadable(Object obj,
                                 String property)
                          throws UtilsException

Tells if property can be read. If nested are null, types will be used if possible.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property returns true.

Throws:

UtilsException - If operation is impossible

isWriteable

public static boolean isWriteable(Object obj,
                                  String property)
                           throws UtilsException

Tells if property can be set. If nested are null, types will be used if possible.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property returns true.

Throws:

UtilsException - If operation is impossible

get

public static Object get(Object obj,
                         String property)
                  throws UtilsException

Gets property value. If nested are null, returns null.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property returns obj directly.

Throws:

UtilsException - If operation is impossible

set

public static Object set(Object obj,
                         String property,
                         Object value)
                  throws UtilsException

Sets property value. If nested are null, they will be set if possible and requested.
This method handles putting values in a Map.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property will throw an exception.

value - The value to set

Throws:

UtilsException - If operation is impossible

safeSet

public static Object safeSet(Object obj,
                             String property,
                             Object value)
                      throws UtilsException

Calls set after performing advanced cast, to handle converting an object into a Collection of another type than the object's.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property will throw an exception.

value - The value to set

Throws:

UtilsException - If operation is impossible

getType

public static Class<?> getType(Object obj,
                               String property)
                        throws UtilsException

Gets property type if it can be resolved or null. If nested are null, types will be used if possible.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property will return obj type.

Throws:

UtilsException - If operation is impossible (property does not exist, ...)

getGenericCollectionType

public static Class<?> getGenericCollectionType(Object obj,
                                                String property)
                                         throws UtilsException

Returns the generic type if the property type is a collection, or null if it cannot be resolved or if the property type is not a collection.
Arrays are considered as Collection.
If nested are null, types will be used if possible.

Parameters:

obj - The object with the getter/setter corresponding to the property

property - The target property. Null or empty property will return null.

Throws:

UtilsException