jodd.bean

Class BeanUtil

java.lang.Object

jodd.bean.BeanUtil

public class BeanUtil
extends java.lang.Object

Supreme utility for reading and writing bean properties. However, this one is the fastest available. Although it provides various methods, the whole thing can be easily extended to match most needs.

BeanUtil supports:

• Nested properties: separated by a dot ('.')
• Indexed properties: arrays or Lists
• Simple properties: accessor or Map

Variants includes combinations of forced, declared and silent writing.

• Forced setting property tries to create destination property so it can be set correctly.
• Silent doesn't throw an exception if destination doesn't exist or if conversion fails.
• Declared includes only declared (public) properties.

This utility considers both bean property methods (set and get accessors), and bean fields. This is done because of several reasons: often there is no need for both set/get accessors, since bean logic requires just one functionality (e.g. just reading). In such case, other bean manipulation libraries still requires to have both accessors in order to set or get value. Another reason is that most common usage is to work with public accessors, and in that case private fields are ignored.

Constructor Summary

Constructors

Constructor and Description
BeanUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	extractThisReference(java.lang.String propertyName) Extract the first name of this reference.
static BeanUtilBean	getBeanUtilBean() Returns BeanUtilBean implementation.
static java.lang.Object	getDeclaredProperty(java.lang.Object bean, java.lang.String name) Returns value of declared bean's property.
static java.lang.Object	getDeclaredPropertySilently(java.lang.Object bean, java.lang.String name) Silently returns value of declared bean's property.
static java.lang.Class	getDeclaredPropertyType(java.lang.Object bean, java.lang.String name)
static java.lang.Object	getProperty(java.lang.Object bean, java.lang.String name) Returns value of bean's property.
static java.lang.Object	getPropertySilently(java.lang.Object bean, java.lang.String name) Silently returns value of bean's property.
static java.lang.Class	getPropertyType(java.lang.Object bean, java.lang.String name)
static boolean	hasDeclaredProperty(java.lang.Object bean, java.lang.String name)
static boolean	hasDeclaredRootProperty(java.lang.Object bean, java.lang.String name)
static boolean	hasProperty(java.lang.Object bean, java.lang.String name)
static boolean	hasRootProperty(java.lang.Object bean, java.lang.String name)
static void	populateBean(java.lang.Object bean, java.util.Map<?,?> map)
static void	populateProperty(java.lang.Object bean, java.lang.String name, java.util.List<?> list)
static void	populateProperty(java.lang.Object bean, java.lang.String name, java.util.Map<?,?> map)
static void	setDeclaredProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets declared Java Bean property.
static void	setDeclaredPropertyForced(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets declared Java Bean property forced.
static void	setDeclaredPropertyForcedSilent(java.lang.Object bean, java.lang.String name, java.lang.Object value) Silently sets declared Java Bean property forced.
static void	setDeclaredPropertySilent(java.lang.Object bean, java.lang.String name, java.lang.Object value) Silently sets declared Java Bean property.
static void	setProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets Java Bean property.
static void	setPropertyForced(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets Java Bean property forced.
static void	setPropertyForcedSilent(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets Java Bean property forced, without throwing an exception on non-existing properties.
static void	setPropertySilent(java.lang.Object bean, java.lang.String name, java.lang.Object value) Sets Java Bean property silently, without throwing an exception on non-existing properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanUtil

public BeanUtil()

Method Detail

getBeanUtilBean

public static BeanUtilBean getBeanUtilBean()

Returns BeanUtilBean implementation.

setProperty

public static void setProperty(java.lang.Object bean,
               java.lang.String name,
               java.lang.Object value)

Sets Java Bean property.

setPropertySilent

public static void setPropertySilent(java.lang.Object bean,
                     java.lang.String name,
                     java.lang.Object value)

Sets Java Bean property silently, without throwing an exception on non-existing properties.

setPropertyForced

public static void setPropertyForced(java.lang.Object bean,
                     java.lang.String name,
                     java.lang.Object value)

Sets Java Bean property forced.

setPropertyForcedSilent

public static void setPropertyForcedSilent(java.lang.Object bean,
                           java.lang.String name,
                           java.lang.Object value)

Sets Java Bean property forced, without throwing an exception on non-existing properties.

setDeclaredProperty

public static void setDeclaredProperty(java.lang.Object bean,
                       java.lang.String name,
                       java.lang.Object value)

Sets declared Java Bean property.

setDeclaredPropertySilent

public static void setDeclaredPropertySilent(java.lang.Object bean,
                             java.lang.String name,
                             java.lang.Object value)

Silently sets declared Java Bean property.

setDeclaredPropertyForced

public static void setDeclaredPropertyForced(java.lang.Object bean,
                             java.lang.String name,
                             java.lang.Object value)

Sets declared Java Bean property forced.

setDeclaredPropertyForcedSilent

public static void setDeclaredPropertyForcedSilent(java.lang.Object bean,
                                   java.lang.String name,
                                   java.lang.Object value)

Silently sets declared Java Bean property forced.

getProperty

public static java.lang.Object getProperty(java.lang.Object bean,
                           java.lang.String name)

Returns value of bean's property.

getPropertySilently

public static java.lang.Object getPropertySilently(java.lang.Object bean,
                                   java.lang.String name)

Silently returns value of bean's property. Return value null is ambiguous: it may means that property name is valid and property value is null or that property name is invalid.

getDeclaredProperty

public static java.lang.Object getDeclaredProperty(java.lang.Object bean,
                                   java.lang.String name)

Returns value of declared bean's property.

getDeclaredPropertySilently

public static java.lang.Object getDeclaredPropertySilently(java.lang.Object bean,
                                           java.lang.String name)

Silently returns value of declared bean's property. Return value null is ambiguous: it may means that property name is valid and property value is null or that property name is invalid.

hasProperty

public static boolean hasProperty(java.lang.Object bean,
                  java.lang.String name)

hasRootProperty

public static boolean hasRootProperty(java.lang.Object bean,
                      java.lang.String name)

hasDeclaredProperty

public static boolean hasDeclaredProperty(java.lang.Object bean,
                          java.lang.String name)

hasDeclaredRootProperty

public static boolean hasDeclaredRootProperty(java.lang.Object bean,
                              java.lang.String name)

getPropertyType

public static java.lang.Class getPropertyType(java.lang.Object bean,
                              java.lang.String name)

getDeclaredPropertyType

public static java.lang.Class getDeclaredPropertyType(java.lang.Object bean,
                                      java.lang.String name)

populateBean

public static void populateBean(java.lang.Object bean,
                java.util.Map<?,?> map)

populateProperty

public static void populateProperty(java.lang.Object bean,
                    java.lang.String name,
                    java.util.Map<?,?> map)

populateProperty

public static void populateProperty(java.lang.Object bean,
                    java.lang.String name,
                    java.util.List<?> list)

extractThisReference

public static java.lang.String extractThisReference(java.lang.String propertyName)

Extract the first name of this reference.