org.apache.commons.beanutils2.PropertyUtils Maven / Gradle / Ivy
Show all versions of commons-beanutils2 Show documentation
/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.beanutils2; import java.beans.PropertyDescriptor; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.Map; /** *
isUtility methods for using Java Reflection APIs to facilitate generic * property getter and setter operations on Java objects.
* *The implementations for these methods are provided by {@code PropertyUtilsBean}. * For more details see {@link PropertyUtilsBean}.
* * @see PropertyUtilsBean * @see org.apache.commons.beanutils2.expression.Resolver */ public class PropertyUtils { /** * Clear any cached property descriptors information for all classes * loaded by any class loaders. This is useful in cases where class * loaders are thrown away to implement class reloading. * *For more details see {@code PropertyUtilsBean}.
* * @see PropertyUtilsBean#clearDescriptors */ public static void clearDescriptors() { PropertyUtilsBean.getInstance().clearDescriptors(); } /** * Resets the registered {@link BeanIntrospector} objects to the initial default * state. * * @since 1.9 */ public static void resetBeanIntrospectors() { PropertyUtilsBean.getInstance().resetBeanIntrospectors(); } /** * Adds a {@code BeanIntrospector}. This object is invoked when the * property descriptors of a class need to be obtained. * * @param introspector the {@code BeanIntrospector} to be added (must * not be null * @throws IllegalArgumentException if the argument is null * @since 1.9 */ public static void addBeanIntrospector(final BeanIntrospector introspector) { PropertyUtilsBean.getInstance().addBeanIntrospector(introspector); } /** * Removes the specified {@code BeanIntrospector}. * * @param introspector the {@code BeanIntrospector} to be removed * @return true if the {@code BeanIntrospector} existed and * could be removed, false otherwise * @since 1.9 */ public static boolean removeBeanIntrospector(final BeanIntrospector introspector) { return PropertyUtilsBean.getInstance().removeBeanIntrospector( introspector); } /** *Copy property values from the "origin" bean to the "destination" bean * for all cases where the property names are the same (even though the * actual getter and setter methods might have been customized via * {@code BeanInfo} classes).
* *For more details see {@code PropertyUtilsBean}.
* * @param dest Destination bean whose properties are modified * @param orig Origin bean whose properties are retrieved * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if the {@code dest} or * {@code orig} argument is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#copyProperties */ public static void copyProperties(final Object dest, final Object orig) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().copyProperties(dest, orig); } /** *Return the entire set of properties for which the specified bean * provides a read method.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose properties are to be extracted * @return The set of properties for the bean * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#describe */ public static Mapdescribe(final Object bean) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().describe(bean); } /** * Return the value of the specified indexed property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name {@code propertyname[index]} of the property value * to be extracted * @return the indexed property value * * @throws IndexOutOfBoundsException if the specified index * is outside the valid range for the underlying property * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getIndexedProperty(Object,String) */ public static Object getIndexedProperty(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getIndexedProperty(bean, name); } /** *Return the value of the specified indexed property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name Simple property name of the property value to be extracted * @param index Index of the property value to be extracted * @return the indexed property value * * @throws IndexOutOfBoundsException if the specified index * is outside the valid range for the underlying property * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getIndexedProperty(Object,String, int) */ public static Object getIndexedProperty(final Object bean, final String name, final int index) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getIndexedProperty(bean, name, index); } /** *Return the value of the specified mapped property of the * specified bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name {@code propertyname(key)} of the property value * to be extracted * @return the mapped property value * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getMappedProperty(Object,String) */ public static Object getMappedProperty(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getMappedProperty(bean, name); } /** *Return the value of the specified mapped property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name Mapped property name of the property value to be extracted * @param key Key of the property value to be extracted * @return the mapped property value * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getMappedProperty(Object,String, String) */ public static Object getMappedProperty(final Object bean, final String name, final String key) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getMappedProperty(bean, name, key); } /** *Return the mapped property descriptors for this bean class.
* *For more details see {@code PropertyUtilsBean}.
* * @param beanClass Bean class to be introspected * @return the mapped property descriptors * @see PropertyUtilsBean#getMappedPropertyDescriptors(Class) */ static Map, Map> getMappedPropertyDescriptors(final Class> beanClass) { return PropertyUtilsBean.getInstance().getMappedPropertyDescriptors(beanClass); } /** * Return the value of the (possibly nested) property of the specified * name, for the specified bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name Possibly nested name of the property to be extracted * @return the nested property value * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws NestedNullException if a nested reference to a * property returns null * @throws InvocationTargetException * if the property accessor method throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getNestedProperty */ public static Object getNestedProperty(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getNestedProperty(bean, name); } /** *Return the value of the specified property of the specified bean, * no matter which property reference format is used, with no * type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name Possibly indexed and/or nested name of the property * to be extracted * @return the property value * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getProperty */ public static Object getProperty(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getProperty(bean, name); } /** *Retrieve the property descriptor for the specified property of the * specified bean, or return {@code null} if there is no such * descriptor.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean for which a property descriptor is requested * @param name Possibly indexed and/or nested name of the property for * which a property descriptor is requested * @return the property descriptor * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if a nested reference to a * property returns null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getPropertyDescriptor */ public static PropertyDescriptor getPropertyDescriptor(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getPropertyDescriptor(bean, name); } /** *Retrieve the property descriptors for the specified class, * introspecting and caching them the first time a particular bean class * is encountered.
* *For more details see {@code PropertyUtilsBean}.
* * @param beanClass Bean class for which property descriptors are requested * @return the property descriptors * @throws IllegalArgumentException if {@code beanClass} is null * @see PropertyUtilsBean#getPropertyDescriptors(Class) */ public static PropertyDescriptor[] getPropertyDescriptors(final Class> beanClass) { return PropertyUtilsBean.getInstance().getPropertyDescriptors(beanClass); } /** *Retrieve the property descriptors for the specified bean, * introspecting and caching them the first time a particular bean class * is encountered.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean for which property descriptors are requested * @return the property descriptors * @throws IllegalArgumentException if {@code bean} is null * @see PropertyUtilsBean#getPropertyDescriptors(Object) */ public static PropertyDescriptor[] getPropertyDescriptors(final Object bean) { return PropertyUtilsBean.getInstance().getPropertyDescriptors(bean); } /** *Return the Java Class representing the property editor class that has * been registered for this property (if any).
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean for which a property descriptor is requested * @param name Possibly indexed and/or nested name of the property for * which a property descriptor is requested * @return the property editor class * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if a nested reference to a * property returns null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getPropertyEditorClass(Object,String) */ public static Class> getPropertyEditorClass(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getPropertyEditorClass(bean, name); } /** *Return the Java Class representing the property type of the specified * property, or {@code null} if there is no such property for the * specified bean.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean for which a property descriptor is requested * @param name Possibly indexed and/or nested name of the property for * which a property descriptor is requested * @return The property type * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if a nested reference to a * property returns null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getPropertyType(Object, String) */ public static Class> getPropertyType(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getPropertyType(bean, name); } /** *Return an accessible property getter method for this property, * if there is one; otherwise return {@code null}.
* *For more details see {@code PropertyUtilsBean}.
* * @param descriptor Property descriptor to return a getter for * @return The read method * @see PropertyUtilsBean#getReadMethod(PropertyDescriptor) */ public static Method getReadMethod(final PropertyDescriptor descriptor) { return PropertyUtilsBean.getInstance().getReadMethod(descriptor); } /** *Return the value of the specified simple property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be extracted * @param name Name of the property to be extracted * @return The property value * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if the property name * is nested or indexed * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#getSimpleProperty */ public static Object getSimpleProperty(final Object bean, final String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { return PropertyUtilsBean.getInstance().getSimpleProperty(bean, name); } /** *Return an accessible property setter method for this property, * if there is one; otherwise return {@code null}.
* *For more details see {@code PropertyUtilsBean}.
* * @param descriptor Property descriptor to return a setter for * @return The write method * @see PropertyUtilsBean#getWriteMethod(PropertyDescriptor) */ public static Method getWriteMethod(final PropertyDescriptor descriptor) { return PropertyUtilsBean.getInstance().getWriteMethod(descriptor); } /** *Return {@code true} if the specified property name identifies * a readable property on the specified bean; otherwise, return * {@code false}.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean to be examined (may be a {@link DynaBean} * @param name Property name to be evaluated * @return {@code true} if the property is readable, * otherwise {@code false} * * @throws IllegalArgumentException if {@code bean} * or {@code namenull} * @see PropertyUtilsBean#isReadable * @since BeanUtils 1.6 */ public static boolean isReadable(final Object bean, final String name) { return PropertyUtilsBean.getInstance().isReadable(bean, name); } /** *
isReturn {@code true} if the specified property name identifies * a writeable property on the specified bean; otherwise, return * {@code false}.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean to be examined (may be a {@link DynaBean} * @param name Property name to be evaluated * @return {@code true} if the property is writeable, * otherwise {@code false} * * @throws IllegalArgumentException if {@code bean} * or {@code namenull} * @see PropertyUtilsBean#isWriteable * @since BeanUtils 1.6 */ public static boolean isWriteable(final Object bean, final String name) { return PropertyUtilsBean.getInstance().isWriteable(bean, name); } /** *
Sets the value of the specified indexed property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be modified * @param name {@code propertyname[index]} of the property value * to be modified * @param value Value to which the specified property element * should be set * * @throws IndexOutOfBoundsException if the specified index * is outside the valid range for the underlying property * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setIndexedProperty(Object, String, Object) */ public static void setIndexedProperty(final Object bean, final String name, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setIndexedProperty(bean, name, value); } /** *Sets the value of the specified indexed property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be set * @param name Simple property name of the property value to be set * @param index Index of the property value to be set * @param value Value to which the indexed property element is to be set * * @throws IndexOutOfBoundsException if the specified index * is outside the valid range for the underlying property * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setIndexedProperty(Object, String, Object) */ public static void setIndexedProperty(final Object bean, final String name, final int index, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setIndexedProperty(bean, name, index, value); } /** *Sets the value of the specified mapped property of the * specified bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be set * @param name {@code propertyname(key)} of the property value * to be set * @param value The property value to be set * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setMappedProperty(Object, String, Object) */ public static void setMappedProperty(final Object bean, final String name, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setMappedProperty(bean, name, value); } /** *Sets the value of the specified mapped property of the specified * bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be set * @param name Mapped property name of the property value to be set * @param key Key of the property value to be set * @param value The property value to be set * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setMappedProperty(Object, String, String, Object) */ public static void setMappedProperty(final Object bean, final String name, final String key, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setMappedProperty(bean, name, key, value); } /** *Sets the value of the (possibly nested) property of the specified * name, for the specified bean, with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be modified * @param name Possibly nested name of the property to be modified * @param value Value to which the property is to be set * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if a nested reference to a * property returns null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setNestedProperty */ public static void setNestedProperty(final Object bean, final String name, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setNestedProperty(bean, name, value); } /** *Set the value of the specified property of the specified bean, * no matter which property reference format is used, with no * type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be modified * @param name Possibly indexed and/or nested name of the property * to be modified * @param value Value to which this property is to be set * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setProperty */ public static void setProperty(final Object bean, final String name, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setProperty(bean, name, value); } /** *Set the value of the specified simple property of the specified bean, * with no type conversions.
* *For more details see {@code PropertyUtilsBean}.
* * @param bean Bean whose property is to be modified * @param name Name of the property to be modified * @param value Value to which the property should be set * * @throws IllegalAccessException if the caller does not have * access to the property accessor method * @throws IllegalArgumentException if {@code bean} or * {@code name} is null * @throws IllegalArgumentException if the property name is * nested or indexed * @throws InvocationTargetException if the property accessor method * throws an exception * @throws NoSuchMethodException if an accessor method for this * property cannot be found * @see PropertyUtilsBean#setSimpleProperty */ public static void setSimpleProperty(final Object bean, final String name, final Object value) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { PropertyUtilsBean.getInstance().setSimpleProperty(bean, name, value); } }