Class LocaleBeanUtilsBean
java.lang.Object
org.apache.commons.beanutils2.BeanUtilsBean
org.apache.commons.beanutils2.locale.LocaleBeanUtilsBean
Utility methods for populating JavaBeans properties via reflection in a locale-dependent manner.
- Since:
- 1.7
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs instance with standard conversion beanLocaleBeanUtilsBean(LocaleConvertUtilsBean localeConvertUtils) Constructs instance that uses given locale conversionLocaleBeanUtilsBean(LocaleConvertUtilsBean localeConvertUtils, ConvertUtilsBean convertUtilsBean, PropertyUtilsBean propertyUtilsBean) Constructs instance that uses given locale conversion
- 
Method SummaryModifier and TypeMethodDescriptionprotected ObjectConvert the specified value to the required type.protected ObjectConvert the specified value to the required type using the specified conversion pattern.protected Class<?> definePropertyType(Object target, String name, String propName) Calculate the property type.booleanIs the pattern to be applied localized (Indicate whether the pattern is localized or not)Gets the default LocalegetIndexedProperty(Object bean, String name) Gets the value of the specified locale-sensitive indexed property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter.getIndexedProperty(Object bean, String name, int index) Gets the value of the specified locale-sensetive indexed property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter.getIndexedProperty(Object bean, String name, int index, String pattern) Gets the value of the specified locale-sensetive indexed property of the specified bean, as a String using the specified conversion pattern.getIndexedProperty(Object bean, String name, String pattern) Gets the value of the specified locale-sensitive indexed property of the specified bean, as a String.static LocaleBeanUtilsBeanGets singleton instanceGets the bean instance used for conversionsgetMappedProperty(Object bean, String name) Gets the value of the specified locale-sensitive mapped property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter.getMappedProperty(Object bean, String name, String key) Gets the value of the specified mapped locale-sensitive property of the specified bean, as a String The key is specified as a method parameter and must *not* be included in the property name expressiongetMappedProperty(Object bean, String name, String key, String pattern) Gets the value of the specified mapped locale-sensitive property of the specified bean, as a String using the specified conversion pattern.getMappedPropertyLocale(Object bean, String name, String pattern) Gets the value of the specified locale-sensitive mapped property of the specified bean, as a String using the specified pattern.getNestedProperty(Object bean, String name) Gets the value of the (possibly nested) locale-sensitive property of the specified name, for the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter.getNestedProperty(Object bean, String name, String pattern) Gets the value of the (possibly nested) locale-sensitive property of the specified name, for the specified bean, as a String using the specified pattern.getProperty(Object bean, String name) Gets the value of the specified locale-sensitive property of the specified bean, no matter which property reference format is used, as a String using the default conversion pattern of the correspondingLocaleConverter.getProperty(Object bean, String name, String pattern) Gets the value of the specified locale-sensitive property of the specified bean, no matter which property reference format is used, as a String using the specified conversion pattern.getSimpleProperty(Object bean, String name) Gets the value of the specified simple locale-sensitive property of the specified bean, converted to a String using the default conversion pattern of the correspondingLocaleConverter.getSimpleProperty(Object bean, String name, String pattern) Gets the value of the specified simple locale-sensitive property of the specified bean, converted to a String using the specified conversion pattern.protected voidinvokeSetter(Object target, String propName, String key, int index, Object newValue) Invoke the setter method.voidsetApplyLocalized(boolean newApplyLocalized) Sets whether the pattern is applied localized (Indicate whether the pattern is localized or not)voidsetDefaultLocale(Locale locale) Sets the default Locale.static voidsetInstance(LocaleBeanUtilsBean newInstance) Sets the instance which provides the functionality forLocaleBeanUtils.voidsetProperty(Object bean, String name, Object value) Sets the specified locale-sensitive property value, performing type conversions as required to conform to the type of the destination property using the default conversion pattern of the correspondingLocaleConverter.voidsetProperty(Object bean, String name, Object value, String pattern) Sets the specified locale-sensitive property value, performing type conversions as required to conform to the type of the destination property using the specified conversion pattern.Methods inherited from class org.apache.commons.beanutils2.BeanUtilsBeancloneBean, convert, copyProperties, copyProperty, describe, getArrayProperty, getConvertUtils, getInstance, getPropertyUtils, populate, setInstance
- 
Constructor Details- 
LocaleBeanUtilsBeanpublic LocaleBeanUtilsBean()Constructs instance with standard conversion bean
- 
LocaleBeanUtilsBeanConstructs instance that uses given locale conversion- Parameters:
- localeConvertUtils- use this- localeConvertUtilsto perform conversions
 
- 
LocaleBeanUtilsBeanpublic LocaleBeanUtilsBean(LocaleConvertUtilsBean localeConvertUtils, ConvertUtilsBean convertUtilsBean, PropertyUtilsBean propertyUtilsBean) Constructs instance that uses given locale conversion- Parameters:
- localeConvertUtils- use this- localeConvertUtilsto perform conversions
- convertUtilsBean- use this for standard conversions
- propertyUtilsBean- use this for property conversions
 
 
- 
- 
Method Details- 
getLocaleBeanUtilsInstanceGets singleton instance- Returns:
- the singleton instance
 
- 
setInstanceSets the instance which provides the functionality forLocaleBeanUtils. This is a pseudo-singleton - an single instance is provided per (thread) context classloader. This mechanism provides isolation for web apps deployed in the same container.- Parameters:
- newInstance- a new singleton instance
 
- 
convertConvert the specified value to the required type.- Parameters:
- type- The Java type of target property
- index- The indexed subscript value (if any)
- value- The value to be converted
- Returns:
- The converted value
 
- 
convertConvert the specified value to the required type using the specified conversion pattern.- Parameters:
- type- The Java type of target property
- index- The indexed subscript value (if any)
- value- The value to be converted
- pattern- The conversion pattern
- Returns:
- The converted value
 
- 
definePropertyTypeprotected Class<?> definePropertyType(Object target, String name, String propName) throws IllegalAccessException, InvocationTargetException Calculate the property type.- Parameters:
- target- The bean
- name- The property name
- propName- The Simple name of target property
- Returns:
- The property's type
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
 
- 
getApplyLocalizedIs the pattern to be applied localized (Indicate whether the pattern is localized or not)- Returns:
- trueif pattern is localized, otherwise- false
 
- 
getDefaultLocaleGets the default Locale- Returns:
- the default locale
 
- 
getIndexedPropertypublic String getIndexedProperty(Object bean, String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive indexed property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter. The zero-relative index of the required value must be included (in square brackets) as a suffix to the property name, orIllegalArgumentExceptionwill be thrown.- Overrides:
- getIndexedPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name-- propertyname[index]of the property value to be extracted
- Returns:
- The indexed property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getIndexedPropertypublic String getIndexedProperty(Object bean, String name, int index) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensetive indexed property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter. The index is specified as a method parameter and must *not* be included in the property name expression- Overrides:
- getIndexedPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name- Simple property name of the property value to be extracted
- index- Index of the property value to be extracted
- Returns:
- The indexed property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getIndexedPropertypublic String getIndexedProperty(Object bean, String name, int index, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensetive indexed property of the specified bean, as a String using the specified conversion pattern. The index is specified as a method parameter and must *not* be included in the property name expression- Parameters:
- bean- Bean whose property is to be extracted
- name- Simple property name of the property value to be extracted
- index- Index of the property value to be extracted
- pattern- The conversion pattern
- Returns:
- The indexed property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getIndexedPropertypublic String getIndexedProperty(Object bean, String name, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive indexed property of the specified bean, as a String. The zero-relative index of the required value must be included (in square brackets) as a suffix to the property name, orIllegalArgumentExceptionwill be thrown.- Parameters:
- bean- Bean whose property is to be extracted
- name-- propertyname[index]of the property value to be extracted
- pattern- The conversion pattern
- Returns:
- The indexed property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getLocaleConvertUtilsGets the bean instance used for conversions- Returns:
- the locale converter bean instance
 
- 
getMappedPropertypublic String getMappedProperty(Object bean, String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive mapped property of the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter. The String-valued key of the required value must be included (in parentheses) as a suffix to the property name, orIllegalArgumentExceptionwill be thrown.- Overrides:
- getMappedPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name-- propertyname(index)of the property value to be extracted
- Returns:
- The mapped property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getMappedPropertypublic String getMappedProperty(Object bean, String name, String key) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified mapped locale-sensitive property of the specified bean, as a String The key is specified as a method parameter and must *not* be included in the property name expression- Overrides:
- getMappedPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name- Simple property name of the property value to be extracted
- key- Lookup key of the property value to be extracted
- Returns:
- The mapped property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getMappedPropertypublic String getMappedProperty(Object bean, String name, String key, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified mapped locale-sensitive property of the specified bean, as a String using the specified conversion pattern. The key is specified as a method parameter and must *not* be included in the property name expression.- Parameters:
- bean- Bean whose property is to be extracted
- name- Simple property name of the property value to be extracted
- key- Lookup key of the property value to be extracted
- pattern- The conversion pattern
- Returns:
- The mapped property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getMappedPropertyLocalepublic String getMappedPropertyLocale(Object bean, String name, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive mapped property of the specified bean, as a String using the specified pattern. The String-valued key of the required value must be included (in parentheses) as a suffix to the property name, orIllegalArgumentExceptionwill be thrown.- Parameters:
- bean- Bean whose property is to be extracted
- name-- propertyname(index)of the property value to be extracted
- pattern- The conversion pattern
- Returns:
- The mapped property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getNestedPropertypublic String getNestedProperty(Object bean, String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the (possibly nested) locale-sensitive property of the specified name, for the specified bean, as a String using the default conversion pattern of the correspondingLocaleConverter.- Overrides:
- getNestedPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name- Possibly nested name of the property to be extracted
- Returns:
- The nested property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- IllegalArgumentException- if a nested reference to a property returns null
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getNestedPropertypublic String getNestedProperty(Object bean, String name, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the (possibly nested) locale-sensitive property of the specified name, for the specified bean, as a String using the specified pattern.- Parameters:
- bean- Bean whose property is to be extracted
- name- Possibly nested name of the property to be extracted
- pattern- The conversion pattern
- Returns:
- The nested property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- IllegalArgumentException- if a nested reference to a property returns null
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getPropertypublic String getProperty(Object bean, String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive property of the specified bean, no matter which property reference format is used, as a String using the default conversion pattern of the correspondingLocaleConverter.- Overrides:
- getPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name- Possibly indexed and/or nested name of the property to be extracted
- Returns:
- The property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getPropertypublic String getProperty(Object bean, String name, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified locale-sensitive property of the specified bean, no matter which property reference format is used, as a String using the specified conversion pattern.- Parameters:
- bean- Bean whose property is to be extracted
- name- Possibly indexed and/or nested name of the property to be extracted
- pattern- The conversion pattern
- Returns:
- The nested property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getSimplePropertypublic String getSimpleProperty(Object bean, String name) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified simple locale-sensitive property of the specified bean, converted to a String using the default conversion pattern of the correspondingLocaleConverter.- Overrides:
- getSimplePropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean whose property is to be extracted
- name- Name of the property to be extracted
- Returns:
- The property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
getSimplePropertypublic String getSimpleProperty(Object bean, String name, String pattern) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException Gets the value of the specified simple locale-sensitive property of the specified bean, converted to a String using the specified conversion pattern.- Parameters:
- bean- Bean whose property is to be extracted
- name- Name of the property to be extracted
- pattern- The conversion pattern
- Returns:
- The property's value, converted to a String
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
- NoSuchMethodException- if an accessor method for this property cannot be found
 
- 
invokeSetterprotected void invokeSetter(Object target, String propName, String key, int index, Object newValue) throws IllegalAccessException, InvocationTargetException Invoke the setter method.- Parameters:
- target- The bean
- propName- The Simple name of target property
- key- The Mapped key value (if any)
- index- The indexed subscript value (if any)
- newValue- The value to be set
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
 
- 
setApplyLocalizedSets whether the pattern is applied localized (Indicate whether the pattern is localized or not)- Parameters:
- newApplyLocalized-- trueif pattern is localized, otherwise- false
 
- 
setDefaultLocaleSets the default Locale.- Parameters:
- locale- the default locale
 
- 
setPropertypublic void setProperty(Object bean, String name, Object value) throws IllegalAccessException, InvocationTargetException Sets the specified locale-sensitive property value, performing type conversions as required to conform to the type of the destination property using the default conversion pattern of the correspondingLocaleConverter.- Overrides:
- setPropertyin class- BeanUtilsBean
- Parameters:
- bean- Bean on which setting is to be performed
- name- Property name (can be nested/indexed/mapped/combo)
- value- Value to be set
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
 
- 
setPropertypublic void setProperty(Object bean, String name, Object value, String pattern) throws IllegalAccessException, InvocationTargetException Sets the specified locale-sensitive property value, performing type conversions as required to conform to the type of the destination property using the specified conversion pattern.- Parameters:
- bean- Bean on which setting is to be performed
- name- Property name (can be nested/indexed/mapped/combo)
- value- Value to be set
- pattern- The conversion pattern
- Throws:
- IllegalAccessException- if the caller does not have access to the property accessor method
- InvocationTargetException- if the property accessor method throws an exception
 
 
-