This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-beanutils.git
The following commit(s) were added to refs/heads/master by this push:
new 02650415 Javadoc
02650415 is described below
commit 02650415e87a403837bf8d93f77126d980aaf421
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:40:37 2026 -0400
Javadoc
---
.../beanutils2/BaseDynaBeanMapDecorator.java | 6 ++--
.../apache/commons/beanutils2/BasicDynaClass.java | 4 +--
.../apache/commons/beanutils2/BeanComparator.java | 6 ++--
.../commons/beanutils2/BeanIntrospectionData.java | 8 +++---
.../org/apache/commons/beanutils2/BeanMap.java | 20 +++++++-------
.../apache/commons/beanutils2/BeanPredicate.java | 4 +--
.../org/apache/commons/beanutils2/BeanUtils.java | 2 +-
.../apache/commons/beanutils2/BeanUtilsBean.java | 6 ++--
.../beanutils2/ContextClassLoaderLocal.java | 2 +-
.../org/apache/commons/beanutils2/DynaClass.java | 4 +--
.../apache/commons/beanutils2/DynaProperty.java | 8 +++---
.../beanutils2/FluentPropertyBeanIntrospector.java | 6 ++--
.../commons/beanutils2/IntrospectionContext.java | 4 +--
.../apache/commons/beanutils2/LazyDynaList.java | 2 +-
.../org/apache/commons/beanutils2/LazyDynaMap.java | 6 ++--
.../org/apache/commons/beanutils2/MethodUtils.java | 4 +--
.../apache/commons/beanutils2/PropertyUtils.java | 22 +++++++--------
.../commons/beanutils2/PropertyUtilsBean.java | 32 +++++++++++-----------
.../apache/commons/beanutils2/WrapDynaBean.java | 4 +--
.../apache/commons/beanutils2/WrapDynaClass.java | 10 +++----
.../beanutils2/converters/AbstractConverter.java | 10 +++----
.../beanutils2/converters/ArrayConverter.java | 2 +-
.../beanutils2/converters/CharacterConverter.java | 2 +-
.../beanutils2/converters/ClassConverter.java | 2 +-
.../beanutils2/converters/DateTimeConverter.java | 4 +--
.../beanutils2/converters/NumberConverter.java | 2 +-
.../beanutils2/locale/BaseLocaleConverter.java | 4 +--
.../commons/beanutils2/locale/LocaleBeanUtils.java | 2 +-
.../beanutils2/locale/LocaleBeanUtilsBean.java | 6 ++--
.../beanutils2/locale/LocaleConvertUtils.java | 20 +++++++-------
.../beanutils2/locale/LocaleConvertUtilsBean.java | 22 +++++++--------
.../locale/converters/DateLocaleConverter.java | 2 +-
.../beanutils2/sql/AbstractJdbcDynaClass.java | 2 +-
.../beanutils2/BeanIntrospectionDataTest.java | 6 ++--
.../DefaultIntrospectionContextTest.java | 2 +-
.../FluentPropertyBeanIntrospectorTest.java | 2 +-
.../commons/beanutils2/PropertyUtilsTest.java | 2 +-
.../SuppressPropertiesBeanIntrospectorTest.java | 2 +-
.../commons/beanutils2/bugs/Jira339Test.java | 2 +-
.../commons/beanutils2/bugs/Jira347Test.java | 2 +-
.../commons/beanutils2/bugs/Jira456Test.java | 2 +-
.../beanutils2/bugs/other/Jira61BeanFactory.java | 2 +-
.../converters/AbstractDateConverterTest.java | 2 +-
.../beanutils2/memoryleaktests/MemoryLeakTest.java | 2 +-
.../memoryleaktests/pojotests/CustomInteger.java | 8 +++---
.../commons/beanutils2/sql/DynaRowSetTest.java | 2 +-
46 files changed, 138 insertions(+), 138 deletions(-)
diff --git
a/src/main/java/org/apache/commons/beanutils2/BaseDynaBeanMapDecorator.java
b/src/main/java/org/apache/commons/beanutils2/BaseDynaBeanMapDecorator.java
index 86ba5dbb..4d513314 100644
--- a/src/main/java/org/apache/commons/beanutils2/BaseDynaBeanMapDecorator.java
+++ b/src/main/java/org/apache/commons/beanutils2/BaseDynaBeanMapDecorator.java
@@ -172,7 +172,7 @@ public abstract class BaseDynaBeanMapDecorator<K>
implements Map<K, Object> {
* Converts the name of a property to the key type of this decorator.
*
* @param propertyName the name of a property
- * @return the converted key to be used in the decorated map
+ * @return The converted key to be used in the decorated map
*/
protected abstract K convertKey(String propertyName);
@@ -213,7 +213,7 @@ public abstract class BaseDynaBeanMapDecorator<K>
implements Map<K, Object> {
/**
* Provide access to the underlying {@link DynaBean} this Map decorates.
*
- * @return the decorated {@link DynaBean}.
+ * @return The decorated {@link DynaBean}.
*/
public DynaBean getDynaBean() {
return dynaBean;
@@ -320,7 +320,7 @@ public abstract class BaseDynaBeanMapDecorator<K>
implements Map<K, Object> {
* remove() operation is not supported.
*
* @param key The {@link DynaBean}'s property name
- * @return the value removed
+ * @return The value removed
* @throws UnsupportedOperationException This operation is not yet
supported
*/
@Override
diff --git a/src/main/java/org/apache/commons/beanutils2/BasicDynaClass.java
b/src/main/java/org/apache/commons/beanutils2/BasicDynaClass.java
index bf8948ba..50f6deb9 100644
--- a/src/main/java/org/apache/commons/beanutils2/BasicDynaClass.java
+++ b/src/main/java/org/apache/commons/beanutils2/BasicDynaClass.java
@@ -128,7 +128,7 @@ public class BasicDynaClass implements DynaClass {
* <strong>FIXME</strong> - Should we really be implementing {@code
getBeanInfo()} instead, which returns property descriptors and a bunch of other
stuff?
* </p>
*
- * @return the set of properties for this DynaClass
+ * @return The set of properties for this DynaClass
*/
@Override
public DynaProperty[] getDynaProperties() {
@@ -151,7 +151,7 @@ public class BasicDynaClass implements DynaClass {
* Gets the name of this DynaClass (analogous to the {@code getName()}
method of {@link Class}, which allows the same {@code DynaClass} implementation
class
* to support different dynamic classes, with different sets of properties.
*
- * @return the name of the DynaClass
+ * @return The name of the DynaClass
*/
@Override
public String getName() {
diff --git a/src/main/java/org/apache/commons/beanutils2/BeanComparator.java
b/src/main/java/org/apache/commons/beanutils2/BeanComparator.java
index 5b18b990..c78e362b 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanComparator.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanComparator.java
@@ -191,7 +191,7 @@ public class BeanComparator<T, V> implements Comparator<T> {
/**
* Gets the Comparator being used to compare beans.
*
- * @return the Comparator being used to compare beans
+ * @return The Comparator being used to compare beans
*/
public Comparator<V> getComparator() {
return comparator;
@@ -209,7 +209,7 @@ public class BeanComparator<T, V> implements Comparator<T> {
/**
* Hashcode compatible with equals.
*
- * @return the hash code for this comparator
+ * @return The hash code for this comparator
*/
@Override
public int hashCode() {
@@ -222,7 +222,7 @@ public class BeanComparator<T, V> implements Comparator<T> {
*
* @param val1 the first value to be compared
* @param val2 the second value to be compared
- * @return the result of the comparison
+ * @return The result of the comparison
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
private int internalCompare(final Object val1, final Object val2) {
diff --git
a/src/main/java/org/apache/commons/beanutils2/BeanIntrospectionData.java
b/src/main/java/org/apache/commons/beanutils2/BeanIntrospectionData.java
index afa20298..f7c85aad 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanIntrospectionData.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanIntrospectionData.java
@@ -45,7 +45,7 @@ final class BeanIntrospectionData {
* because they may get lost when the GC claims soft references used by
the {@code PropertyDescriptor} objects.
*
* @param descs the array with the descriptors of the available properties
- * @return the map with the names of write methods for properties
+ * @return The map with the names of write methods for properties
*/
private static Map<String, String> setUpWriteMethodNames(final
PropertyDescriptor[] descs) {
final Map<String, String> methods = new HashMap<>();
@@ -89,7 +89,7 @@ final class BeanIntrospectionData {
* Returns the {@code PropertyDescriptor} for the property with the
specified name. If this property is unknown, result is {@code null}.
*
* @param name the name of the property in question
- * @return the {@code PropertyDescriptor} for this property or {@code null}
+ * @return The {@code PropertyDescriptor} for this property or {@code null}
*/
public PropertyDescriptor getDescriptor(final String name) {
for (final PropertyDescriptor pd : getDescriptors()) {
@@ -103,7 +103,7 @@ final class BeanIntrospectionData {
/**
* Returns the array with property descriptors.
*
- * @return the property descriptors for the associated bean class
+ * @return The property descriptors for the associated bean class
*/
public PropertyDescriptor[] getDescriptors() {
return descriptors;
@@ -117,7 +117,7 @@ final class BeanIntrospectionData {
*
* @param beanCls the class of the affected bean
* @param desc the {@code PropertyDescriptor} of the desired property
- * @return the write method for this property or {@code null} if there is
none
+ * @return The write method for this property or {@code null} if there is
none
*/
public Method getWriteMethod(final Class<?> beanCls, final
PropertyDescriptor desc) {
Method method = desc.getWriteMethod();
diff --git a/src/main/java/org/apache/commons/beanutils2/BeanMap.java
b/src/main/java/org/apache/commons/beanutils2/BeanMap.java
index 4c0d2cd3..b141490f 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanMap.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanMap.java
@@ -70,7 +70,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* Sets the value.
*
* @param value the new value for the entry
- * @return the old value for the entry
+ * @return The old value for the entry
*/
@Override
public Object setValue(final Object value) {
@@ -247,7 +247,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* @param <R> The return type.
* @param newType the type to convert the value to
* @param value the value to convert
- * @return the converted value
+ * @return The converted value
* @throws NumberFormatException if newType is a primitive type, and
the string representation of the given value cannot be converted to that type
* @throws InstantiationException if the constructor found with
reflection raises it
* @throws InvocationTargetException if the constructor found with
reflection raises it
@@ -335,7 +335,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* Each MapEntry can be set but not removed.
* </p>
*
- * @return the unmodifiable set of mappings
+ * @return The unmodifiable set of mappings
*/
@Override
public Set<Map.Entry<String, Object>> entrySet() {
@@ -375,7 +375,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* </p>
*
* @param name the name of the property whose value to return
- * @return the value of the property with that name
+ * @return The value of the property with that name
*/
@Override
public Object get(final Object name) {
@@ -395,7 +395,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
/**
* Gets the bean currently being operated on. The return value may be null
if this map is empty.
*
- * @return the bean being operated on by this map
+ * @return The bean being operated on by this map
*/
public Object getBean() {
return bean;
@@ -417,7 +417,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* Gets the accessor for the property with the given name.
*
* @param name the name of the property
- * @return the accessor method for the property, or null
+ * @return The accessor method for the property, or null
*/
public Method getReadMethod(final String name) {
return readMethods.get(name);
@@ -427,7 +427,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* Gets the type of the property with the given name.
*
* @param name the name of the property
- * @return the type of the property, or {@code null} if no such property
exists
+ * @return The type of the property, or {@code null} if no such property
exists
*/
public Class<?> getType(final String name) {
return types.get(name);
@@ -459,7 +459,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
* Gets the mutator for the property with the given name.
*
* @param name the name of the property
- * @return the mutator method for the property, or null
+ * @return The mutator method for the property, or null
*/
public Method getWriteMethod(final String name) {
return writeMethods.get(name);
@@ -560,7 +560,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
*
* @param name the name of the property to set
* @param value the value to set that property to
- * @return the previous value of that property
+ * @return The previous value of that property
* @throws IllegalArgumentException if the given name is null; if the
given name is not a {@link String}; if the bean doesn't define a property with
that
* name; or if the bean property with
that name is read-only
* @throws ClassCastException if an error occurs creating the method
args
@@ -625,7 +625,7 @@ public class BeanMap extends AbstractMap<String, Object>
implements Cloneable {
/**
* Returns the number of properties defined by the bean.
*
- * @return the number of properties defined by the bean
+ * @return The number of properties defined by the bean
*/
@Override
public int size() {
diff --git a/src/main/java/org/apache/commons/beanutils2/BeanPredicate.java
b/src/main/java/org/apache/commons/beanutils2/BeanPredicate.java
index 325cc102..72ed7510 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanPredicate.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanPredicate.java
@@ -63,7 +63,7 @@ public class BeanPredicate<T> implements Predicate<T> {
/**
* Gets the name of the property whose value is to be predicated. in the
evaluation.
*
- * @return the property name, not null
+ * @return The property name, not null
*/
public String getPropertyName() {
return propertyName;
@@ -91,7 +91,7 @@ public class BeanPredicate<T> implements Predicate<T> {
* Evaluates the given object by applying the {@link #getPredicate()} to a
property value named by {@link #getPropertyName()}.
*
* @param object The object to test
- * @return the result of the predicate evaluation
+ * @return The result of the predicate evaluation
* @throws IllegalArgumentException when the property cannot be evaluated
*/
@Override
diff --git a/src/main/java/org/apache/commons/beanutils2/BeanUtils.java
b/src/main/java/org/apache/commons/beanutils2/BeanUtils.java
index ca5b71dc..89cae7cc 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanUtils.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanUtils.java
@@ -52,7 +52,7 @@ public final class BeanUtils {
* </p>
*
* @param bean Bean to be cloned
- * @return the cloned bean
+ * @return The cloned bean
* @throws IllegalAccessException if the caller does not have access to
the property accessor method
* @throws InstantiationException if a new instance of the bean's class
cannot be instantiated
* @throws InvocationTargetException if the property accessor method
throws an exception
diff --git a/src/main/java/org/apache/commons/beanutils2/BeanUtilsBean.java
b/src/main/java/org/apache/commons/beanutils2/BeanUtilsBean.java
index a30fdd9e..847d2a81 100644
--- a/src/main/java/org/apache/commons/beanutils2/BeanUtilsBean.java
+++ b/src/main/java/org/apache/commons/beanutils2/BeanUtilsBean.java
@@ -98,7 +98,7 @@ public class BeanUtilsBean {
*
* @param dynaProperty the property descriptor
* @param value the value object to be set for this property
- * @return the type of this property
+ * @return The type of this property
*/
private static Class<?> dynaPropertyType(final DynaProperty dynaProperty,
final Object value) {
if (!dynaProperty.isMapped()) {
@@ -178,7 +178,7 @@ public class BeanUtilsBean {
* </p>
*
* @param bean Bean to be cloned
- * @return the cloned bean
+ * @return The cloned bean
* @throws IllegalAccessException if the caller does not have access to
the property accessor method
* @throws InstantiationException if a new instance of the bean's class
cannot be instantiated
* @throws InvocationTargetException if the property accessor method
throws an exception
@@ -218,7 +218,7 @@ public class BeanUtilsBean {
*
* @param value the value to be converted and copied
* @param type the target type of the conversion
- * @return the converted value
+ * @return The converted value
*/
private Object convertForCopy(final Object value, final Class<?> type) {
return value != null ? convert(value, type) : value;
diff --git
a/src/main/java/org/apache/commons/beanutils2/ContextClassLoaderLocal.java
b/src/main/java/org/apache/commons/beanutils2/ContextClassLoaderLocal.java
index a758fa23..29e7d992 100644
--- a/src/main/java/org/apache/commons/beanutils2/ContextClassLoaderLocal.java
+++ b/src/main/java/org/apache/commons/beanutils2/ContextClassLoaderLocal.java
@@ -108,7 +108,7 @@ public class ContextClassLoaderLocal<T> {
* Gets the instance which provides the functionality for {@link
BeanUtils}. 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.
*
- * @return the object currently associated with the context-classloader of
the current thread.
+ * @return The object currently associated with the context-classloader of
the current thread.
*/
public synchronized T get() {
// synchronizing the whole method is a bit slower
diff --git a/src/main/java/org/apache/commons/beanutils2/DynaClass.java
b/src/main/java/org/apache/commons/beanutils2/DynaClass.java
index 371559fe..4c6f2660 100644
--- a/src/main/java/org/apache/commons/beanutils2/DynaClass.java
+++ b/src/main/java/org/apache/commons/beanutils2/DynaClass.java
@@ -35,7 +35,7 @@ public interface DynaClass {
* <strong>FIXME</strong> - Should we really be implementing {@code
getBeanInfo()} instead, which returns property descriptors and a bunch of other
stuff?
* </p>
*
- * @return the set of properties for this DynaClass
+ * @return The set of properties for this DynaClass
*/
DynaProperty[] getDynaProperties();
@@ -52,7 +52,7 @@ public interface DynaClass {
* Returns the name of this DynaClass (analogous to the {@code getName()}
method of {@link Class}, which allows the same {@code DynaClass} implementation
* class to support different dynamic classes, with different sets of
properties.
*
- * @return the name of the DynaClass
+ * @return The name of the DynaClass
*/
String getName();
diff --git a/src/main/java/org/apache/commons/beanutils2/DynaProperty.java
b/src/main/java/org/apache/commons/beanutils2/DynaProperty.java
index 243745d7..ec79a59f 100644
--- a/src/main/java/org/apache/commons/beanutils2/DynaProperty.java
+++ b/src/main/java/org/apache/commons/beanutils2/DynaProperty.java
@@ -128,7 +128,7 @@ public class DynaProperty {
* serialized using the standard methods</strong>.
* </p>
*
- * @return the Class for the content type if this is an indexed {@code
DynaProperty} and this feature is supported. Otherwise null.
+ * @return The Class for the content type if this is an indexed {@code
DynaProperty} and this feature is supported. Otherwise null.
*/
public Class<?> getContentType() {
return contentType;
@@ -137,7 +137,7 @@ public class DynaProperty {
/**
* Gets the name of this property.
*
- * @return the name of the property
+ * @return The name of the property
*/
public String getName() {
return this.name;
@@ -157,14 +157,14 @@ public class DynaProperty {
* <strong>Please leave this field as {@code transient}</strong>
* </p>
*
- * @return the property type
+ * @return The property type
*/
public Class<?> getType() {
return this.type;
}
/**
- * @return the hash code for this dyna property
+ * @return The hash code for this dyna property
* @see Object#hashCode
* @since 1.8.0
*/
diff --git
a/src/main/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospector.java
b/src/main/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospector.java
index e6b60aee..c4a7635f 100644
---
a/src/main/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospector.java
+++
b/src/main/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospector.java
@@ -103,7 +103,7 @@ public class FluentPropertyBeanIntrospector implements
BeanIntrospector {
*
* @param m the set method for the fluent API property
* @param propertyName the name of the corresponding property
- * @return the descriptor
+ * @return The descriptor
* @throws IntrospectionException if an error occurs
*/
private PropertyDescriptor createFluentPropertyDescritor(final Method m,
final String propertyName) throws IntrospectionException {
@@ -113,7 +113,7 @@ public class FluentPropertyBeanIntrospector implements
BeanIntrospector {
/**
* Returns the prefix for write methods this instance scans for.
*
- * @return the prefix for write methods
+ * @return The prefix for write methods
*/
public String getWriteMethodPrefix() {
return writeMethodPrefix;
@@ -155,7 +155,7 @@ public class FluentPropertyBeanIntrospector implements
BeanIntrospector {
* Derives the name of a property from the given set method.
*
* @param m the method
- * @return the corresponding property name
+ * @return The corresponding property name
*/
private String propertyName(final Method m) {
final String methodName =
m.getName().substring(getWriteMethodPrefix().length());
diff --git
a/src/main/java/org/apache/commons/beanutils2/IntrospectionContext.java
b/src/main/java/org/apache/commons/beanutils2/IntrospectionContext.java
index 84f053f0..53ee79b9 100644
--- a/src/main/java/org/apache/commons/beanutils2/IntrospectionContext.java
+++ b/src/main/java/org/apache/commons/beanutils2/IntrospectionContext.java
@@ -52,14 +52,14 @@ public interface IntrospectionContext {
* Returns the descriptor for the property with the given name or {@code
null} if this property is unknown.
*
* @param name the name of the property in question
- * @return the descriptor for this property or {@code null} if this
property is unknown
+ * @return The descriptor for this property or {@code null} if this
property is unknown
*/
PropertyDescriptor getPropertyDescriptor(String name);
/**
* Returns the class that is subject of introspection.
*
- * @return the current class
+ * @return The current class
*/
Class<?> getTargetClass();
diff --git a/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
b/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
index b1a87c55..78e7a720 100644
--- a/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
+++ b/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
@@ -334,7 +334,7 @@ public class LazyDynaList extends ArrayList<Object> {
* Creates a new {@code LazyDynaMap} object for the given property value.
*
* @param value the property value
- * @return the newly created {@code LazyDynaMap}
+ * @return The newly created {@code LazyDynaMap}
*/
private LazyDynaMap createDynaBeanForMapProperty(final Object value) {
@SuppressWarnings("unchecked")
diff --git a/src/main/java/org/apache/commons/beanutils2/LazyDynaMap.java
b/src/main/java/org/apache/commons/beanutils2/LazyDynaMap.java
index 7419e271..fb9999f3 100644
--- a/src/main/java/org/apache/commons/beanutils2/LazyDynaMap.java
+++ b/src/main/java/org/apache/commons/beanutils2/LazyDynaMap.java
@@ -214,7 +214,7 @@ public class LazyDynaMap extends LazyDynaBean implements
MutableDynaClass {
* <strong>FIXME</strong> - Should we really be implementing {@code
getBeanInfo()} instead, which returns property descriptors and a bunch of other
stuff?
* </p>
*
- * @return the set of properties for this DynaClass
+ * @return The set of properties for this DynaClass
*/
@Override
public DynaProperty[] getDynaProperties() {
@@ -271,7 +271,7 @@ public class LazyDynaMap extends LazyDynaBean implements
MutableDynaClass {
/**
* Gets the underlying Map backing this {@code DynaBean}
*
- * @return the underlying Map
+ * @return The underlying Map
* @since 1.8.0
*/
@Override
@@ -282,7 +282,7 @@ public class LazyDynaMap extends LazyDynaBean implements
MutableDynaClass {
/**
* Gets the name of this DynaClass (analogous to the {@code
getName()</code> method of <code>java.lang.Class})
*
- * @return the name of the DynaClass
+ * @return The name of the DynaClass
*/
@Override
public String getName() {
diff --git a/src/main/java/org/apache/commons/beanutils2/MethodUtils.java
b/src/main/java/org/apache/commons/beanutils2/MethodUtils.java
index 0d8f2b05..a3dd768d 100644
--- a/src/main/java/org/apache/commons/beanutils2/MethodUtils.java
+++ b/src/main/java/org/apache/commons/beanutils2/MethodUtils.java
@@ -96,7 +96,7 @@ public final class MethodUtils {
* Returns the string length of method name. I.e. if the hash codes
are different, the objects are different. If the hash codes are the same, need
to
* use the equals method to determine equality.
*
- * @return the string length of method name.
+ * @return The string length of method name.
*/
@Override
public int hashCode() {
@@ -144,7 +144,7 @@ public final class MethodUtils {
/**
* Clear the method cache.
*
- * @return the number of cached methods cleared.
+ * @return The number of cached methods cleared.
* @since 1.8.0
*/
public static synchronized int clearCache() {
diff --git a/src/main/java/org/apache/commons/beanutils2/PropertyUtils.java
b/src/main/java/org/apache/commons/beanutils2/PropertyUtils.java
index e3f964b2..32d22db1 100644
--- a/src/main/java/org/apache/commons/beanutils2/PropertyUtils.java
+++ b/src/main/java/org/apache/commons/beanutils2/PropertyUtils.java
@@ -116,7 +116,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
@@ -141,7 +141,7 @@ public final class PropertyUtils {
* @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
+ * @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
@@ -165,7 +165,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
@@ -188,7 +188,7 @@ public final class PropertyUtils {
* @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
+ * @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
@@ -209,7 +209,7 @@ public final class PropertyUtils {
* </p>
*
* @param beanClass Bean class to be introspected
- * @return the mapped property descriptors
+ * @return The mapped property descriptors
* @see PropertyUtilsBean#getMappedPropertyDescriptors(Class)
*/
static Map<Class<?>, Map> getMappedPropertyDescriptors(final Class<?>
beanClass) {
@@ -227,7 +227,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
@@ -251,7 +251,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
@@ -273,7 +273,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
@@ -296,7 +296,7 @@ public final class PropertyUtils {
* </p>
*
* @param beanClass Bean class for which property descriptors are requested
- * @return the property descriptors
+ * @return The property descriptors
* @throws IllegalArgumentException if {@code beanClass} is null
* @see PropertyUtilsBean#getPropertyDescriptors(Class)
*/
@@ -314,7 +314,7 @@ public final class PropertyUtils {
* </p>
*
* @param bean Bean for which property descriptors are requested
- * @return the property descriptors
+ * @return The property descriptors
* @throws IllegalArgumentException if {@code bean} is null
* @see PropertyUtilsBean#getPropertyDescriptors(Object)
*/
@@ -333,7 +333,7 @@ public final class PropertyUtils {
*
* @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
+ * @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
diff --git a/src/main/java/org/apache/commons/beanutils2/PropertyUtilsBean.java
b/src/main/java/org/apache/commons/beanutils2/PropertyUtilsBean.java
index 57a8467a..3fba57b6 100644
--- a/src/main/java/org/apache/commons/beanutils2/PropertyUtilsBean.java
+++ b/src/main/java/org/apache/commons/beanutils2/PropertyUtilsBean.java
@@ -86,7 +86,7 @@ public class PropertyUtilsBean {
* of objects.
*
* @param obj the object to be converted
- * @return the resulting list of objects
+ * @return The resulting list of objects
*/
@SuppressWarnings("unchecked")
private static List<Object> toObjectList(final Object obj) {
@@ -99,7 +99,7 @@ public class PropertyUtilsBean {
* in a Map<String, Object>.
*
* @param obj the object to be converted
- * @return the resulting properties map
+ * @return The resulting properties map
*/
@SuppressWarnings("unchecked")
private static Map<String, Object> toPropertyMap(final Object obj) {
@@ -306,7 +306,7 @@ public class 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
+ * @return The indexed property value
* @throws IndexOutOfBoundsException if the specified index is outside the
valid range for the underlying array or List
* @throws IllegalAccessException if the caller does not have access to
the property accessor method
* @throws IllegalArgumentException if {@code bean} or {@code name} is
null
@@ -341,7 +341,7 @@ public class 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
+ * @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
@@ -419,7 +419,7 @@ public class PropertyUtilsBean {
* introspection is performed now on the affected bean class, and the
results object is created.
*
* @param beanClass the bean class in question
- * @return the {@code BeanIntrospectionData} object for this class
+ * @return The {@code BeanIntrospectionData} object for this class
* @throws IllegalArgumentException if the bean class is {@code null}
*/
private BeanIntrospectionData getIntrospectionData(final Class<?>
beanClass) {
@@ -439,7 +439,7 @@ public class 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
+ * @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
@@ -471,7 +471,7 @@ public class 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
+ * @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
@@ -531,7 +531,7 @@ public class PropertyUtilsBean {
* </p>
*
* @param beanClass Bean class to be introspected
- * @return the mapped property descriptors
+ * @return The mapped property descriptors
*/
Map<Class<?>, Map> getMappedPropertyDescriptors(final Class<?> beanClass) {
if (beanClass == null) {
@@ -551,7 +551,7 @@ public class PropertyUtilsBean {
* </p>
*
* @param bean Bean to be introspected
- * @return the mapped property descriptors
+ * @return The mapped property descriptors
*/
Map getMappedPropertyDescriptors(final Object bean) {
if (bean == null) {
@@ -565,7 +565,7 @@ public class 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
+ * @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
@@ -612,7 +612,7 @@ public class 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
+ * @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
@@ -639,7 +639,7 @@ public class 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
+ * @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
@@ -708,7 +708,7 @@ public class PropertyUtilsBean {
* </p>
*
* @param beanClass Bean class for which property descriptors are requested
- * @return the property descriptors
+ * @return The property descriptors
* @throws IllegalArgumentException if {@code beanClass} is null
*/
public PropertyDescriptor[] getPropertyDescriptors(final Class<?>
beanClass) {
@@ -725,7 +725,7 @@ public class PropertyUtilsBean {
* </p>
*
* @param bean Bean for which property descriptors are requested
- * @return the property descriptors
+ * @return The property descriptors
* @throws IllegalArgumentException if {@code bean} is null
*/
public PropertyDescriptor[] getPropertyDescriptors(final Object bean) {
@@ -751,7 +751,7 @@ public class 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
+ * @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
@@ -775,7 +775,7 @@ public class PropertyUtilsBean {
*
* @param bean Map bean
* @param propertyName The property name
- * @return the property value
+ * @return The property value
* @throws IllegalArgumentException when the propertyName is regarded as
being invalid.
* @throws IllegalAccessException just in case subclasses override this
method to try to access real getter methods and find permission is denied.
* @throws InvocationTargetException just in case subclasses override this
method to try to access real getter methods, and find it throws an exception
when
diff --git a/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
b/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
index bb482dab..237a1694 100644
--- a/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
+++ b/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
@@ -198,7 +198,7 @@ public class WrapDynaBean implements DynaBean {
* Gets the bean instance wrapped by this DynaBean. For most common use
cases, this object should already be known and this method safely be ignored.
But
* some creators of frameworks using {@code DynaBean}'s may find this
useful.
*
- * @return the Java bean Object wrapped by this {@code DynaBean}
+ * @return The Java bean Object wrapped by this {@code DynaBean}
*/
public Object getInstance() {
return instance;
@@ -208,7 +208,7 @@ public class WrapDynaBean implements DynaBean {
* Returns the {@code PropertyUtilsBean} instance to be used for accessing
properties. If available, this object is obtained from the associated
* {@code WrapDynaClass}.
*
- * @return the associated {@code PropertyUtilsBean}
+ * @return The associated {@code PropertyUtilsBean}
*/
private PropertyUtilsBean getPropertyUtils() {
PropertyUtilsBean propUtils = null;
diff --git a/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
b/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
index 6428cb77..d5672371 100644
--- a/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
+++ b/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
@@ -129,7 +129,7 @@ public class WrapDynaClass implements DynaClass {
* Returns the cache for the already created class instances. For each
combination of bean class and {@code PropertyUtilsBean} instance an entry is
created
* in the cache.
*
- * @return the cache for already created {@code WrapDynaClass} instances
+ * @return The cache for already created {@code WrapDynaClass} instances
*/
private static Map<CacheKey, WrapDynaClass> getClassesCache() {
return CLASSLOADER_CACHE.get();
@@ -182,7 +182,7 @@ public class WrapDynaClass implements DynaClass {
/**
* Gets the class of the underlying wrapped bean.
*
- * @return the class of the underlying wrapped bean
+ * @return The class of the underlying wrapped bean
* @since 1.8.0
*/
protected Class<?> getBeanClass() {
@@ -199,7 +199,7 @@ public class WrapDynaClass implements DynaClass {
* <strong>FIXME</strong> - Should we really be implementing {@code
getBeanInfo()} instead, which returns property descriptors and a bunch of other
stuff?
* </p>
*
- * @return the set of properties for this DynaClass
+ * @return The set of properties for this DynaClass
*/
@Override
public DynaProperty[] getDynaProperties() {
@@ -222,7 +222,7 @@ public class WrapDynaClass implements DynaClass {
* Gets the name of this DynaClass (analogous to the {@code getName()}
method of {@link Class}, which allows the same {@code DynaClass} implementation
class
* to support different dynamic classes, with different sets of properties.
*
- * @return the name of the DynaClass
+ * @return The name of the DynaClass
*/
@Override
public String getName() {
@@ -242,7 +242,7 @@ public class WrapDynaClass implements DynaClass {
/**
* Returns the {@code PropertyUtilsBean} instance associated with this
class. This bean is used for introspection.
*
- * @return the associated {@code PropertyUtilsBean} instance
+ * @return The associated {@code PropertyUtilsBean} instance
* @since 1.9
*/
protected PropertyUtilsBean getPropertyUtilsBean() {
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/AbstractConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/AbstractConverter.java
index 1b1c05cb..585d685b 100644
---
a/src/main/java/org/apache/commons/beanutils2/converters/AbstractConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/converters/AbstractConverter.java
@@ -63,7 +63,7 @@ public abstract class AbstractConverter<D> implements
Converter<D> {
* Converts the given object to a lower-case string.
*
* @param value the input string.
- * @return the given string trimmed and converter to lower-case.
+ * @return The given string trimmed and converter to lower-case.
*/
protected static String toLowerCase(final Object value) {
return StringUtils.toRootLowerCase(toString(value));
@@ -73,7 +73,7 @@ public abstract class AbstractConverter<D> implements
Converter<D> {
* Converts the given object to a lower-case string.
*
* @param value the input string.
- * @return the given string trimmed and converter to lower-case.
+ * @return The given string trimmed and converter to lower-case.
*/
protected static String toString(final Object value) {
return Objects.requireNonNull(value, "value").toString();
@@ -83,7 +83,7 @@ public abstract class AbstractConverter<D> implements
Converter<D> {
* Converts the given object to a lower-case string.
*
* @param value the input string.
- * @return the given string trimmed and converter to lower-case.
+ * @return The given string trimmed and converter to lower-case.
*/
protected static String toTrim(final Object value) {
return toString(value).trim();
@@ -213,7 +213,7 @@ public abstract class AbstractConverter<D> implements
Converter<D> {
*
* @param value the value to be converted.
* @param <T> the type of the result object.
- * @return the converted value.
+ * @return The converted value.
*/
@SuppressWarnings("unchecked")
private <T> T convertToDefaultType(final Object value) {
@@ -228,7 +228,7 @@ public abstract class AbstractConverter<D> implements
Converter<D> {
* </p>
*
* @param value The input value to be converted.
- * @return the converted String value.
+ * @return The converted String value.
* @throws IllegalArgumentException if an error occurs converting to a
String.
*/
protected String convertToString(final Object value) {
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/ArrayConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/ArrayConverter.java
index 3bb2e53c..bfcc4e4e 100644
--- a/src/main/java/org/apache/commons/beanutils2/converters/ArrayConverter.java
+++ b/src/main/java/org/apache/commons/beanutils2/converters/ArrayConverter.java
@@ -188,7 +188,7 @@ public class ArrayConverter<C> extends AbstractConverter<C>
{
* Handles conversion to a String.
*
* @param value The value to be converted.
- * @return the converted String value.
+ * @return The converted String value.
* @throws IllegalArgumentException if an error occurs converting to a
String
*/
@Override
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/CharacterConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/CharacterConverter.java
index 3fb69496..12745fdf 100644
---
a/src/main/java/org/apache/commons/beanutils2/converters/CharacterConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/converters/CharacterConverter.java
@@ -55,7 +55,7 @@ public final class CharacterConverter extends
AbstractConverter<Character> {
* </p>
*
* @param value The input value to be converted
- * @return the converted String value.
+ * @return The converted String value.
* @since 1.8.0
*/
@Override
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/ClassConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/ClassConverter.java
index 70313c13..444fb62b 100644
--- a/src/main/java/org/apache/commons/beanutils2/converters/ClassConverter.java
+++ b/src/main/java/org/apache/commons/beanutils2/converters/ClassConverter.java
@@ -49,7 +49,7 @@ public final class ClassConverter<T> extends
AbstractConverter<Class<T>> {
* </p>
*
* @param value The input value to be converted
- * @return the converted String value.
+ * @return The converted String value.
* @since 1.8.0
*/
@Override
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/DateTimeConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/DateTimeConverter.java
index bbb2c54a..c08de17e 100644
---
a/src/main/java/org/apache/commons/beanutils2/converters/DateTimeConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/converters/DateTimeConverter.java
@@ -113,7 +113,7 @@ public abstract class DateTimeConverter<D> extends
AbstractConverter<D> {
* to format the date into a String. Otherwise the default {@code
DateFormat} for the default locale (and <em>style</em> if configured) will be
used.
*
* @param value The input value to be converted
- * @return the converted String value.
+ * @return The converted String value.
* @throws IllegalArgumentException if an error occurs converting to a
String
*/
@Override
@@ -331,7 +331,7 @@ public abstract class DateTimeConverter<D> extends
AbstractConverter<D> {
/**
* Gets the {@code java.time.ZoneId</code> from the
<code>java.util.Timezone} set or use the system default if no time zone is set.
*
- * @return the {@code ZoneId}
+ * @return The {@code ZoneId}
*/
private ZoneId getZoneId() {
return timeZone == null ? ZoneId.systemDefault() : timeZone.toZoneId();
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/NumberConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/NumberConverter.java
index 87344ca8..c6568003 100644
---
a/src/main/java/org/apache/commons/beanutils2/converters/NumberConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/converters/NumberConverter.java
@@ -112,7 +112,7 @@ public abstract class NumberConverter<N extends Number>
extends AbstractConverte
* Convert an input Number object into a String.
*
* @param value The input value to be converted
- * @return the converted String value.
+ * @return The converted String value.
* @throws IllegalArgumentException if an error occurs converting to a
String
*/
@Override
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/BaseLocaleConverter.java
b/src/main/java/org/apache/commons/beanutils2/locale/BaseLocaleConverter.java
index 5f551125..8090558a 100644
---
a/src/main/java/org/apache/commons/beanutils2/locale/BaseLocaleConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/locale/BaseLocaleConverter.java
@@ -148,7 +148,7 @@ public abstract class BaseLocaleConverter<T> implements
LocaleConverter<T> {
* @param <T> the desired result type.
* @param type the target class of the conversion.
* @param result the conversion result object.
- * @return the result cast to the target class.
+ * @return The result cast to the target class.
* @throws ConversionException if the result object is not compatible with
the target type.
*/
private static <R> R checkConversionResult(final Class<R> type, final
Object result) {
@@ -277,7 +277,7 @@ public abstract class BaseLocaleConverter<T> implements
LocaleConverter<T> {
* a ConversionException is thrown.
*
* @param type the target class of the conversion.
- * @return the default value in the given target type.
+ * @return The default value in the given target type.
* @throws ConversionException if the default object is not compatible
with the target type.
*/
private <R> R getDefaultAs(final Class<R> type) {
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtils.java
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtils.java
index 256b3fe8..2e1e127a 100644
--- a/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtils.java
+++ b/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtils.java
@@ -117,7 +117,7 @@ public final class LocaleBeanUtils {
* For more details see {@code LocaleBeanUtilsBean}
* </p>
*
- * @return the default locale
+ * @return The default locale
* @see LocaleBeanUtilsBean#getDefaultLocale()
*/
public static Locale getDefaultLocale() {
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtilsBean.java
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtilsBean.java
index 9191151e..5cd84fd7 100644
---
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtilsBean.java
+++
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleBeanUtilsBean.java
@@ -61,7 +61,7 @@ public class LocaleBeanUtilsBean extends BeanUtilsBean {
/**
* Gets singleton instance
*
- * @return the singleton instance
+ * @return The singleton instance
*/
public static LocaleBeanUtilsBean getLocaleBeanUtilsInstance() {
return LOCALE_BEANS_BY_CLASSLOADER.get();
@@ -244,7 +244,7 @@ public class LocaleBeanUtilsBean extends BeanUtilsBean {
/**
* Gets the default Locale
*
- * @return the default locale
+ * @return The default locale
*/
public Locale getDefaultLocale() {
return getLocaleConvertUtils().getDefaultLocale();
@@ -325,7 +325,7 @@ public class LocaleBeanUtilsBean extends BeanUtilsBean {
/**
* Gets the bean instance used for conversions
*
- * @return the locale converter bean instance
+ * @return The locale converter bean instance
*/
public LocaleConvertUtilsBean getLocaleConvertUtils() {
return localeConvertUtils;
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtils.java
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtils.java
index 7ef9aad9..82149375 100644
--- a/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtils.java
+++ b/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtils.java
@@ -42,7 +42,7 @@ public final class LocaleConvertUtils {
* </p>
*
* @param value The Value to be converted
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(Object)
*/
public static String convert(final Object value) {
@@ -61,7 +61,7 @@ public final class LocaleConvertUtils {
* @param value The Value to be converted
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(Object, Locale, String)
*/
public static String convert(final Object value, final Locale locale,
final String pattern) {
@@ -79,7 +79,7 @@ public final class LocaleConvertUtils {
*
* @param value The Value to be converted
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(Object, String)
*/
public static String convert(final Object value, final String pattern) {
@@ -97,7 +97,7 @@ public final class LocaleConvertUtils {
*
* @param value The String scalar value to be converted
* @param clazz The Data type to which this value should be converted.
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String, Class)
*/
public static Object convert(final String value, final Class<?> clazz) {
@@ -118,7 +118,7 @@ public final class LocaleConvertUtils {
* @param clazz The Data type to which this value should be converted.
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String, Class, Locale, String)
*/
public static Object convert(final String value, final Class<?> clazz,
final Locale locale, final String pattern) {
@@ -138,7 +138,7 @@ public final class LocaleConvertUtils {
* @param value The String scalar value to be converted
* @param clazz The Data type to which this value should be converted.
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String, Class, String)
*/
public static Object convert(final String value, final Class<?> clazz,
final String pattern) {
@@ -156,7 +156,7 @@ public final class LocaleConvertUtils {
*
* @param values Value to be converted (may be null)
* @param clazz Java array or element class to be converted to
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String[], Class)
*/
public static Object convert(final String[] values, final Class<?> clazz) {
@@ -176,7 +176,7 @@ public final class LocaleConvertUtils {
* @param clazz Java array or element class to be converted to
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String[], Class, Locale, String)
*/
public static Object convert(final String[] values, final Class<?> clazz,
final Locale locale, final String pattern) {
@@ -195,7 +195,7 @@ public final class LocaleConvertUtils {
* @param values Value to be converted (may be null)
* @param clazz Java array or element class to be converted to
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @see LocaleConvertUtilsBean#convert(String[], Class, String)
*/
public static Object convert(final String[] values, final Class<?> clazz,
final String pattern) {
@@ -275,7 +275,7 @@ public final class LocaleConvertUtils {
* For more details see {@code LocaleConvertUtilsBean}
* </p>
*
- * @return the default locale
+ * @return The default locale
* @see LocaleConvertUtilsBean#getDefaultLocale()
*/
public static Locale getDefaultLocale() {
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtilsBean.java
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtilsBean.java
index 04e247d1..b4537aab 100644
---
a/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtilsBean.java
+++
b/src/main/java/org/apache/commons/beanutils2/locale/LocaleConvertUtilsBean.java
@@ -87,7 +87,7 @@ public class LocaleConvertUtilsBean {
/**
* Gets singleton instance. This is the same as the instance used by the
default {@link LocaleBeanUtilsBean} singleton.
*
- * @return the singleton instance
+ * @return The singleton instance
*/
public static LocaleConvertUtilsBean getInstance() {
return
LocaleBeanUtilsBean.getLocaleBeanUtilsInstance().getLocaleConvertUtils();
@@ -120,7 +120,7 @@ public class LocaleConvertUtilsBean {
* Convert the specified locale-sensitive value into a String.
*
* @param value The Value to be converted
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public String convert(final Object value) {
@@ -133,7 +133,7 @@ public class LocaleConvertUtilsBean {
* @param value The Value to be converted
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public String convert(final Object value, final Locale locale, final
String pattern) {
@@ -146,7 +146,7 @@ public class LocaleConvertUtilsBean {
*
* @param value The Value to be converted
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public String convert(final Object value, final String pattern) {
@@ -158,7 +158,7 @@ public class LocaleConvertUtilsBean {
*
* @param value The String scalar value to be converted
* @param clazz The Data type to which this value should be converted.
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public Object convert(final String value, final Class<?> clazz) {
@@ -173,7 +173,7 @@ public class LocaleConvertUtilsBean {
* @param clazz The Data type to which this value should be converted.
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public Object convert(final String value, final Class<?> clazz, final
Locale locale, final String pattern) {
@@ -202,7 +202,7 @@ public class LocaleConvertUtilsBean {
* @param value The String scalar value to be converted
* @param clazz The Data type to which this value should be converted.
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public Object convert(final String value, final Class<?> clazz, final
String pattern) {
@@ -214,7 +214,7 @@ public class LocaleConvertUtilsBean {
*
* @param values Value to be converted (may be null)
* @param clazz Java array or element class to be converted to
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public Object convert(final String[] values, final Class<?> clazz) {
@@ -229,7 +229,7 @@ public class LocaleConvertUtilsBean {
* @param clazz Java array or element class to be converted to
* @param locale The locale
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public <T> T[] convert(final String[] values, final Class<T> clazz, final
Locale locale, final String pattern) {
@@ -255,7 +255,7 @@ public class LocaleConvertUtilsBean {
* @param values Value to be converted (may be null)
* @param clazz Java array or element class to be converted to
* @param pattern The conversion pattern
- * @return the converted value
+ * @return The converted value
* @throws ConversionException if thrown by an underlying Converter
*/
public <T> T[] convert(final String[] values, final Class<T> clazz, final
String pattern) {
@@ -343,7 +343,7 @@ public class LocaleConvertUtilsBean {
/**
* getter for defaultLocale.
*
- * @return the default locale
+ * @return The default locale
*/
public Locale getDefaultLocale() {
return defaultLocale;
diff --git
a/src/main/java/org/apache/commons/beanutils2/locale/converters/DateLocaleConverter.java
b/src/main/java/org/apache/commons/beanutils2/locale/converters/DateLocaleConverter.java
index 7cf1a5ff..2ae7e472 100644
---
a/src/main/java/org/apache/commons/beanutils2/locale/converters/DateLocaleConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/locale/converters/DateLocaleConverter.java
@@ -218,7 +218,7 @@ public class DateLocaleConverter<D extends Date> extends
BaseLocaleConverter<D>
*
* @param value The input object to be converted.
* @param pattern The pattern is used for the conversion.
- * @return the converted Date value.
+ * @return The converted Date value.
* @throws ConversionException if conversion cannot be performed
successfully.
* @throws ParseException if an error occurs parsing.
*/
diff --git
a/src/main/java/org/apache/commons/beanutils2/sql/AbstractJdbcDynaClass.java
b/src/main/java/org/apache/commons/beanutils2/sql/AbstractJdbcDynaClass.java
index 30119b0a..04f49c45 100644
--- a/src/main/java/org/apache/commons/beanutils2/sql/AbstractJdbcDynaClass.java
+++ b/src/main/java/org/apache/commons/beanutils2/sql/AbstractJdbcDynaClass.java
@@ -80,7 +80,7 @@ abstract class AbstractJdbcDynaClass implements DynaClass {
*
* @param metadata is the result set metadata
* @param i is the column index in the metadata
- * @return the newly created DynaProperty instance
+ * @return The newly created DynaProperty instance
* @throws SQLException If an error occurs accessing the SQL metadata
*/
protected DynaProperty createDynaProperty(final ResultSetMetaData
metadata, final int i) throws SQLException {
diff --git
a/src/test/java/org/apache/commons/beanutils2/BeanIntrospectionDataTest.java
b/src/test/java/org/apache/commons/beanutils2/BeanIntrospectionDataTest.java
index 27b44e40..90be4bcd 100644
--- a/src/test/java/org/apache/commons/beanutils2/BeanIntrospectionDataTest.java
+++ b/src/test/java/org/apache/commons/beanutils2/BeanIntrospectionDataTest.java
@@ -41,7 +41,7 @@ class BeanIntrospectionDataTest {
/**
* Creates an array with property descriptors for the test bean class.
*
- * @return the array with property descriptors
+ * @return The array with property descriptors
*/
private static PropertyDescriptor[] fetchDescriptors() {
final PropertyUtilsBean pub = new PropertyUtilsBean();
@@ -54,7 +54,7 @@ class BeanIntrospectionDataTest {
* Returns the property descriptor for the test property.
*
* @param bid the data object
- * @return the test property descriptor
+ * @return The test property descriptor
*/
private static PropertyDescriptor fetchTestDescriptor(final
BeanIntrospectionData bid) {
return bid.getDescriptor(TEST_PROP);
@@ -63,7 +63,7 @@ class BeanIntrospectionDataTest {
/**
* Creates a test instance which is initialized with default property
descriptors.
*
- * @return the test instance
+ * @return The test instance
*/
private static BeanIntrospectionData setUpData() {
return new BeanIntrospectionData(fetchDescriptors());
diff --git
a/src/test/java/org/apache/commons/beanutils2/DefaultIntrospectionContextTest.java
b/src/test/java/org/apache/commons/beanutils2/DefaultIntrospectionContextTest.java
index 4128e704..e97cb56a 100644
---
a/src/test/java/org/apache/commons/beanutils2/DefaultIntrospectionContextTest.java
+++
b/src/test/java/org/apache/commons/beanutils2/DefaultIntrospectionContextTest.java
@@ -43,7 +43,7 @@ class DefaultIntrospectionContextTest {
* Creates a property descriptor object for a property with the given name.
*
* @param propName the property name
- * @return the descriptor for this property
+ * @return The descriptor for this property
*/
private static PropertyDescriptor createDescriptor(final String propName) {
try {
diff --git
a/src/test/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospectorTest.java
b/src/test/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospectorTest.java
index 094aeba0..80ec1ba4 100644
---
a/src/test/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospectorTest.java
+++
b/src/test/java/org/apache/commons/beanutils2/FluentPropertyBeanIntrospectorTest.java
@@ -64,7 +64,7 @@ class FluentPropertyBeanIntrospectorTest {
*
* @param props the map with property descriptors
* @param name the name of the desired descriptor
- * @return the descriptor from the map
+ * @return The descriptor from the map
*/
private static PropertyDescriptor fetchDescriptor(final Map<String,
PropertyDescriptor> props, final String name) {
assertTrue(props.containsKey(name), "Property not found: " + name);
diff --git a/src/test/java/org/apache/commons/beanutils2/PropertyUtilsTest.java
b/src/test/java/org/apache/commons/beanutils2/PropertyUtilsTest.java
index d5f7c73d..5d03c1ee 100644
--- a/src/test/java/org/apache/commons/beanutils2/PropertyUtilsTest.java
+++ b/src/test/java/org/apache/commons/beanutils2/PropertyUtilsTest.java
@@ -102,7 +102,7 @@ class PropertyUtilsTest {
* Finds the descriptor of the name property.
*
* @param desc the array with descriptors
- * @return the found descriptor or null
+ * @return The found descriptor or null
*/
private static PropertyDescriptor findNameDescriptor(final
PropertyDescriptor[] desc) {
for (final PropertyDescriptor element : desc) {
diff --git
a/src/test/java/org/apache/commons/beanutils2/SuppressPropertiesBeanIntrospectorTest.java
b/src/test/java/org/apache/commons/beanutils2/SuppressPropertiesBeanIntrospectorTest.java
index b0c801ad..3cf4a6bc 100644
---
a/src/test/java/org/apache/commons/beanutils2/SuppressPropertiesBeanIntrospectorTest.java
+++
b/src/test/java/org/apache/commons/beanutils2/SuppressPropertiesBeanIntrospectorTest.java
@@ -60,7 +60,7 @@ class SuppressPropertiesBeanIntrospectorTest {
/**
* Returns the names of properties which have been removed.
*
- * @return the set with removed properties
+ * @return The set with removed properties
*/
public Set<String> getRemovedProperties() {
return removedProperties;
diff --git a/src/test/java/org/apache/commons/beanutils2/bugs/Jira339Test.java
b/src/test/java/org/apache/commons/beanutils2/bugs/Jira339Test.java
index 0870761d..9ac19144 100644
--- a/src/test/java/org/apache/commons/beanutils2/bugs/Jira339Test.java
+++ b/src/test/java/org/apache/commons/beanutils2/bugs/Jira339Test.java
@@ -44,7 +44,7 @@ class Jira339Test {
/**
* Gets the comparator.
*
- * @return the comparator
+ * @return The comparator
*/
public Comparator<?> getComparator() {
return comparator;
diff --git a/src/test/java/org/apache/commons/beanutils2/bugs/Jira347Test.java
b/src/test/java/org/apache/commons/beanutils2/bugs/Jira347Test.java
index 8bb115d3..5847f6b4 100644
--- a/src/test/java/org/apache/commons/beanutils2/bugs/Jira347Test.java
+++ b/src/test/java/org/apache/commons/beanutils2/bugs/Jira347Test.java
@@ -103,7 +103,7 @@ class Jira347Test {
* Gets the string representation of the mapped write method for the given
descriptor. This conversion is needed as there must not be strong reference
* to the Method object outside of this method as otherwise the garbage
collector will not clean up the soft reference within the
MappedPropertyDescriptor.
*
- * @return the string representation or null if mapped write method does
not exist
+ * @return The string representation or null if mapped write method does
not exist
*/
private String getMappedWriteMethod(final MappedPropertyDescriptor
descriptor) {
final Method m = descriptor.getMappedWriteMethod();
diff --git a/src/test/java/org/apache/commons/beanutils2/bugs/Jira456Test.java
b/src/test/java/org/apache/commons/beanutils2/bugs/Jira456Test.java
index be358855..707801da 100644
--- a/src/test/java/org/apache/commons/beanutils2/bugs/Jira456Test.java
+++ b/src/test/java/org/apache/commons/beanutils2/bugs/Jira456Test.java
@@ -43,7 +43,7 @@ class Jira456Test {
* Clears the reference to the write method in the property descriptor of
the test property. This simulates that the write method reference is freed by
the
* GC.
*
- * @return the bean instance used for testing
+ * @return The bean instance used for testing
* @throws Exception if an error occurs
*/
private FluentIntrospectionTestBean clearWriteMethodRef() throws Exception
{
diff --git
a/src/test/java/org/apache/commons/beanutils2/bugs/other/Jira61BeanFactory.java
b/src/test/java/org/apache/commons/beanutils2/bugs/other/Jira61BeanFactory.java
index 762e840e..4436729f 100644
---
a/src/test/java/org/apache/commons/beanutils2/bugs/other/Jira61BeanFactory.java
+++
b/src/test/java/org/apache/commons/beanutils2/bugs/other/Jira61BeanFactory.java
@@ -64,7 +64,7 @@ public class Jira61BeanFactory {
/**
* Gets simpleReadOnly
*
- * @return the simple value
+ * @return The simple value
*/
public String getSimpleReadOnly() {
return simple;
diff --git
a/src/test/java/org/apache/commons/beanutils2/converters/AbstractDateConverterTest.java
b/src/test/java/org/apache/commons/beanutils2/converters/AbstractDateConverterTest.java
index f2cb42ea..0e55f7b1 100644
---
a/src/test/java/org/apache/commons/beanutils2/converters/AbstractDateConverterTest.java
+++
b/src/test/java/org/apache/commons/beanutils2/converters/AbstractDateConverterTest.java
@@ -56,7 +56,7 @@ public abstract class AbstractDateConverterTest<T> {
* Gets the separator that precedes the AM/PM field in the US SHORT time
format. Java 20 and up (CLDR) use a narrow no-break space (U+202F) here,
* earlier versions use a regular space.
*
- * @return the separator that precedes the AM/PM field in the US SHORT
time format.
+ * @return The separator that precedes the AM/PM field in the US SHORT
time format.
*/
protected static String amPmSeparator() {
return DateFormat.getTimeInstance(DateFormat.SHORT,
Locale.US).format(new Date()).contains(NB_SPACE) ? NB_SPACE : " ";
diff --git
a/src/test/java/org/apache/commons/beanutils2/memoryleaktests/MemoryLeakTest.java
b/src/test/java/org/apache/commons/beanutils2/memoryleaktests/MemoryLeakTest.java
index 5b10b666..d044d563 100644
---
a/src/test/java/org/apache/commons/beanutils2/memoryleaktests/MemoryLeakTest.java
+++
b/src/test/java/org/apache/commons/beanutils2/memoryleaktests/MemoryLeakTest.java
@@ -140,7 +140,7 @@ public class MemoryLeakTest {
/**
* Gets the total, free, used memory stats.
*
- * @return the total, free, used memory stats
+ * @return The total, free, used memory stats
*/
private String getMemoryStats() {
final java.text.DecimalFormat fmt = new
java.text.DecimalFormat("#,##0");
diff --git
a/src/test/java/org/apache/commons/beanutils2/memoryleaktests/pojotests/CustomInteger.java
b/src/test/java/org/apache/commons/beanutils2/memoryleaktests/pojotests/CustomInteger.java
index 92fc2fc8..e77f45ae 100644
---
a/src/test/java/org/apache/commons/beanutils2/memoryleaktests/pojotests/CustomInteger.java
+++
b/src/test/java/org/apache/commons/beanutils2/memoryleaktests/pojotests/CustomInteger.java
@@ -44,7 +44,7 @@ public class CustomInteger extends Number {
/**
* Gets the double value.
*
- * @return the double value
+ * @return The double value
*/
@Override
public double doubleValue() {
@@ -54,7 +54,7 @@ public class CustomInteger extends Number {
/**
* Gets the float value.
*
- * @return the float value
+ * @return The float value
*/
@Override
public float floatValue() {
@@ -64,7 +64,7 @@ public class CustomInteger extends Number {
/**
* Gets the integer value.
*
- * @return the integer value
+ * @return The integer value
*/
@Override
public int intValue() {
@@ -74,7 +74,7 @@ public class CustomInteger extends Number {
/**
* Gets the long value.
*
- * @return the long value
+ * @return The long value
*/
@Override
public long longValue() {
diff --git
a/src/test/java/org/apache/commons/beanutils2/sql/DynaRowSetTest.java
b/src/test/java/org/apache/commons/beanutils2/sql/DynaRowSetTest.java
index 72f13445..d89bdf92 100644
--- a/src/test/java/org/apache/commons/beanutils2/sql/DynaRowSetTest.java
+++ b/src/test/java/org/apache/commons/beanutils2/sql/DynaRowSetTest.java
@@ -66,7 +66,7 @@ class DynaRowSetTest {
* Gets an columns's value
*
* @param columnName Name of the column
- * @return the column value
+ * @return The column value
* @throws SQLException if an error occurs
*/
@Override
