Module de.cuioss.java.tools

Package de.cuioss.tools.property

Class PropertyUtil

java.lang.Object

de.cuioss.tools.property.PropertyUtil

public class PropertyUtil
extends Object

Helper class providing convenient methods for reading from / writing to java beans.

Caution:

Use reflection only if there is no other way. Even if some of the problems are minimized by using this type. It should be used either in test-code, what is we actually do, and not production code. An other reason could be framework code. as for that you should exactly know what you do.

Author:

Oliver Wolff

Constructor Summary

Constructors

Constructor	Description
PropertyUtil()

Method Summary

Modifier and Type	Method	Description
static Object	readProperty(Object bean, String propertyName)
static Optional<Class<?>>	resolvePropertyType(Class<?> beanType, String propertyName)	Tries to determine the type of given property
static Object	writeProperty(Object bean, String propertyName, Object propertyValue)

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyUtil

public PropertyUtil()

Method Details

readProperty

public static Object readProperty(Object bean,
 String propertyName)

Parameters:

bean - instance to be read from, must not be null

propertyName - to be read, must not be null nor empty nor blank

Returns:

the object read from the property

Throws:

IllegalArgumentException - in case the property does not exist (determined by a read method)

IllegalStateException - in case some Exception occurred while reading

writeProperty

public static Object writeProperty(Object bean,
 String propertyName,
 Object propertyValue)

Parameters:

bean - instance to be read from, must not be null

propertyName - to be read, must not be null nor empty nor blank

propertyValue - to be set

Returns:

In case the property set method is void the given bean will be returned. Otherwise, the return value of the method invocation, assuming the setMethods is a builder type.

Throws:

IllegalArgumentException - in case the property does not exist (determined by a write method)

IllegalStateException - in case some Exception occurred while writing

resolvePropertyType

public static Optional<Class<?>> resolvePropertyType(Class<?> beanType,
 String propertyName)

Tries to determine the type of given property

Parameters:

beanType - to be checked, must not be null

propertyName - to be checked, must not be null

Returns:

an Optional on the actual type of the property. First it checks an access-methods, then it tries to directly access the field, and if that fails it uses the first read method found, Optional.empty() otherwise.