This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch 1.X
in repository https://gitbox.apache.org/repos/asf/commons-beanutils.git
The following commit(s) were added to refs/heads/1.X by this push:
new 2fd2ed18 Javadoc
2fd2ed18 is described below
commit 2fd2ed189eacee9790151fee071814c5102851d1
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:12 2026 -0400
Javadoc
---
.../java/org/apache/commons/beanutils/BasicDynaBean.java | 2 +-
src/main/java/org/apache/commons/beanutils/BeanMap.java | 14 +++++++-------
src/main/java/org/apache/commons/beanutils/BeanUtils.java | 2 +-
.../org/apache/commons/beanutils/ConstructorUtils.java | 2 +-
.../apache/commons/beanutils/ContextClassLoaderLocal.java | 2 +-
.../commons/beanutils/DefaultIntrospectionContext.java | 2 +-
.../java/org/apache/commons/beanutils/DynaProperty.java | 2 +-
.../org/apache/commons/beanutils/IntrospectionContext.java | 2 +-
.../java/org/apache/commons/beanutils/LazyDynaBean.java | 4 ++--
.../org/apache/commons/beanutils/PropertyUtilsBean.java | 2 +-
.../beanutils/SuppressPropertiesBeanIntrospector.java | 2 +-
.../java/org/apache/commons/beanutils/WeakFastHashMap.java | 2 +-
.../commons/beanutils/converters/AbstractConverter.java | 2 +-
.../beanutils/converters/BooleanArrayConverter.java | 2 +-
.../beanutils/FluentPropertyBeanIntrospectorTest.java | 2 +-
.../commons/beanutils/bugs/other/Jira273BeanFactory.java | 12 ++++++------
.../commons/beanutils/bugs/other/Jira298BeanFactory.java | 2 +-
.../commons/beanutils/bugs/other/Jira61BeanFactory.java | 2 +-
18 files changed, 30 insertions(+), 30 deletions(-)
diff --git a/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
b/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
index ecb5cee7..f6b7a2ca 100644
--- a/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
+++ b/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
@@ -230,7 +230,7 @@ public class BasicDynaBean implements DynaBean,
Serializable {
* </p>
* <ul><li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li></ul>
*
- * @return a Map representation of this DynaBean
+ * @return A Map representation of this DynaBean
* @since 1.8.0
*/
public Map<String, Object> getMap() {
diff --git a/src/main/java/org/apache/commons/beanutils/BeanMap.java
b/src/main/java/org/apache/commons/beanutils/BeanMap.java
index ccc11574..b03974e5 100644
--- a/src/main/java/org/apache/commons/beanutils/BeanMap.java
+++ b/src/main/java/org/apache/commons/beanutils/BeanMap.java
@@ -235,7 +235,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
* <li>If anything fails along the way, throw a
CloneNotSupportedException.</li>
* </ul>
*
- * @return a cloned instance of this bean map
+ * @return A cloned instance of this bean map
* @throws CloneNotSupportedException if the underlying bean cannot be
cloned
*/
@Override
@@ -356,7 +356,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
*
* @param method the mutator method
* @param value the value to pass to the mutator method
- * @return an array containing one object that is either the given value
or a transformed value
+ * @return An array containing one object that is either the given value
or a transformed value
* @throws IllegalAccessException if {@link #convertType(Class,Object)}
raises it
* @throws IllegalArgumentException if any other exception is raised by
{@link #convertType(Class,Object)}
* @throws ClassCastException if an error occurs creating the method
args
@@ -381,7 +381,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
/**
* Convenience method for getting an iterator over the entries.
*
- * @return an iterator over the entries
+ * @return An iterator over the entries
*/
public Iterator<Map.Entry<Object, Object>> entryIterator() {
final Iterator<String> iter = keyIterator();
@@ -514,7 +514,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
* Returns a transformer for the given primitive type.
*
* @param aType the primitive type whose transformer to return
- * @return a transformer that will convert strings into that type, or null
if the given type is not a primitive type
+ * @return A transformer that will convert strings into that type, or null
if the given type is not a primitive type
*/
protected Transformer getTypeTransformer(final Class<?> aType) {
return typeTransformers.get(aType);
@@ -581,7 +581,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
* <p>
* Write-only properties will not be returned in the iterator.
*
- * @return an iterator over the keys
+ * @return An iterator over the keys
*/
public Iterator<String> keyIterator() {
return readMethods.keySet().iterator();
@@ -706,7 +706,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
/**
* Renders a string representation of this object.
*
- * @return a {@code String} representation of this object
+ * @return A {@code String} representation of this object
*/
@Override
public String toString() {
@@ -716,7 +716,7 @@ public class BeanMap extends AbstractMap<Object, Object>
implements Cloneable {
/**
* Convenience method for getting an iterator over the values.
*
- * @return an iterator over the values
+ * @return An iterator over the values
*/
public Iterator<Object> valueIterator() {
final Iterator<?> iter = keyIterator();
diff --git a/src/main/java/org/apache/commons/beanutils/BeanUtils.java
b/src/main/java/org/apache/commons/beanutils/BeanUtils.java
index a362a1db..0478dd33 100644
--- a/src/main/java/org/apache/commons/beanutils/BeanUtils.java
+++ b/src/main/java/org/apache/commons/beanutils/BeanUtils.java
@@ -118,7 +118,7 @@ public class BeanUtils {
*
* @param <K> The key type of the cache
* @param <V> The value type of the cache
- * @return a new cache
+ * @return A new cache
* @since 1.8.0
*/
public static <K, V> Map<K, V> createCache() {
diff --git a/src/main/java/org/apache/commons/beanutils/ConstructorUtils.java
b/src/main/java/org/apache/commons/beanutils/ConstructorUtils.java
index 5730f260..c2de3f20 100644
--- a/src/main/java/org/apache/commons/beanutils/ConstructorUtils.java
+++ b/src/main/java/org/apache/commons/beanutils/ConstructorUtils.java
@@ -129,7 +129,7 @@ public class ConstructorUtils {
* @param <T> The type of the class to be inspected
* @param clazz find constructor for this class
* @param parameterTypes find method with compatible parameters
- * @return a valid Constructor object. If there's no matching constructor,
returns {@code null}.
+ * @return A valid Constructor object. If there's no matching constructor,
returns {@code null}.
*/
private static <T> Constructor<T> getMatchingAccessibleConstructor(
final Class<T> clazz,
diff --git
a/src/main/java/org/apache/commons/beanutils/ContextClassLoaderLocal.java
b/src/main/java/org/apache/commons/beanutils/ContextClassLoaderLocal.java
index f384d9ad..edf2fc31 100644
--- a/src/main/java/org/apache/commons/beanutils/ContextClassLoaderLocal.java
+++ b/src/main/java/org/apache/commons/beanutils/ContextClassLoaderLocal.java
@@ -157,7 +157,7 @@ public class ContextClassLoaderLocal<T> {
* will call an appropriate constructor and return the newly constructed
* object.
*
- * @return a new Object to be used as an initial value for this
ContextClassLoaderLocal
+ * @return A new Object to be used as an initial value for this
ContextClassLoaderLocal
*/
protected T initialValue() {
return null;
diff --git
a/src/main/java/org/apache/commons/beanutils/DefaultIntrospectionContext.java
b/src/main/java/org/apache/commons/beanutils/DefaultIntrospectionContext.java
index 5147daa8..48bcbf67 100644
---
a/src/main/java/org/apache/commons/beanutils/DefaultIntrospectionContext.java
+++
b/src/main/java/org/apache/commons/beanutils/DefaultIntrospectionContext.java
@@ -87,7 +87,7 @@ class DefaultIntrospectionContext implements
IntrospectionContext {
* Returns an array with all descriptors added to this context. This method
* is used to obtain the results of introspection.
*
- * @return an array with all known property descriptors
+ * @return An array with all known property descriptors
*/
public PropertyDescriptor[] getPropertyDescriptors() {
return descriptors.values().toArray(EMPTY_DESCRIPTORS);
diff --git a/src/main/java/org/apache/commons/beanutils/DynaProperty.java
b/src/main/java/org/apache/commons/beanutils/DynaProperty.java
index 3d767f1f..b43c088b 100644
--- a/src/main/java/org/apache/commons/beanutils/DynaProperty.java
+++ b/src/main/java/org/apache/commons/beanutils/DynaProperty.java
@@ -273,7 +273,7 @@ public class DynaProperty implements Serializable {
/**
* Return a String representation of this Object.
*
- * @return a String representation of the dyna property
+ * @return A String representation of the dyna property
*/
@Override
public String toString() {
diff --git
a/src/main/java/org/apache/commons/beanutils/IntrospectionContext.java
b/src/main/java/org/apache/commons/beanutils/IntrospectionContext.java
index 78602aa9..cf4ad742 100644
--- a/src/main/java/org/apache/commons/beanutils/IntrospectionContext.java
+++ b/src/main/java/org/apache/commons/beanutils/IntrospectionContext.java
@@ -86,7 +86,7 @@ public interface IntrospectionContext {
/**
* Returns a set with the names of all properties known to this context.
*
- * @return a set with the known property names
+ * @return A set with the known property names
*/
Set<String> propertyNames();
diff --git a/src/main/java/org/apache/commons/beanutils/LazyDynaBean.java
b/src/main/java/org/apache/commons/beanutils/LazyDynaBean.java
index c58b42bc..817c491c 100644
--- a/src/main/java/org/apache/commons/beanutils/LazyDynaBean.java
+++ b/src/main/java/org/apache/commons/beanutils/LazyDynaBean.java
@@ -618,7 +618,7 @@ protected static final BigInteger BigInteger_ZERO = new
BigInteger("0");
* </p>
* <ul><li>{@code ${myDynaBean.<strong>map</strong>.fooProperty}}</li></ul>
*
- * @return a Map representation of this DynaBean
+ * @return A Map representation of this DynaBean
*/
public Map<String, Object> getMap() {
// cache the Map
@@ -739,7 +739,7 @@ protected static final BigInteger BigInteger_ZERO = new
BigInteger("0");
/**
* <p>Creates a new instance of the {@code Map}.</p>
*
- * @return a new Map instance
+ * @return A new Map instance
*/
protected Map<String, Object> newMap() {
return new HashMap<>();
diff --git a/src/main/java/org/apache/commons/beanutils/PropertyUtilsBean.java
b/src/main/java/org/apache/commons/beanutils/PropertyUtilsBean.java
index 6c6f03fa..b3c5ecd3 100644
--- a/src/main/java/org/apache/commons/beanutils/PropertyUtilsBean.java
+++ b/src/main/java/org/apache/commons/beanutils/PropertyUtilsBean.java
@@ -341,7 +341,7 @@ public class PropertyUtilsBean {
* added to this instance.
*
* @param beanClass the class to be inspected
- * @return a data object with the results of introspection
+ * @return A data object with the results of introspection
*/
private BeanIntrospectionData fetchIntrospectionData(final Class<?>
beanClass) {
final DefaultIntrospectionContext ictx = new
DefaultIntrospectionContext(beanClass);
diff --git
a/src/main/java/org/apache/commons/beanutils/SuppressPropertiesBeanIntrospector.java
b/src/main/java/org/apache/commons/beanutils/SuppressPropertiesBeanIntrospector.java
index 514cb047..bae5c393 100644
---
a/src/main/java/org/apache/commons/beanutils/SuppressPropertiesBeanIntrospector.java
+++
b/src/main/java/org/apache/commons/beanutils/SuppressPropertiesBeanIntrospector.java
@@ -80,7 +80,7 @@ public class SuppressPropertiesBeanIntrospector implements
BeanIntrospector {
* Returns a (unmodifiable) set with the names of the properties which are
suppressed
* by this {@code BeanIntrospector}.
*
- * @return a set with the names of the suppressed properties
+ * @return A set with the names of the suppressed properties
*/
public Set<String> getSuppressedProperties() {
return propertyNames;
diff --git a/src/main/java/org/apache/commons/beanutils/WeakFastHashMap.java
b/src/main/java/org/apache/commons/beanutils/WeakFastHashMap.java
index 96ae5137..6f27beef 100644
--- a/src/main/java/org/apache/commons/beanutils/WeakFastHashMap.java
+++ b/src/main/java/org/apache/commons/beanutils/WeakFastHashMap.java
@@ -408,7 +408,7 @@ class WeakFastHashMap<K, V> extends HashMap<K, V> {
* Return a shallow copy of this {@code FastHashMap} instance.
* The keys and values themselves are not copied.
*
- * @return a clone of this map
+ * @return A clone of this map
*/
@Override
public Object clone() {
diff --git
a/src/main/java/org/apache/commons/beanutils/converters/AbstractConverter.java
b/src/main/java/org/apache/commons/beanutils/converters/AbstractConverter.java
index a6ffd8ed..ef2977d7 100644
---
a/src/main/java/org/apache/commons/beanutils/converters/AbstractConverter.java
+++
b/src/main/java/org/apache/commons/beanutils/converters/AbstractConverter.java
@@ -104,7 +104,7 @@ public abstract class AbstractConverter implements
Converter {
*
* @param type the target type
* @param value the value to be converted
- * @return a {@code ConversionException} with a standard message
+ * @return A {@code ConversionException} with a standard message
* @since 1.9
*/
protected ConversionException conversionException(final Class<?> type,
final Object value) {
diff --git
a/src/main/java/org/apache/commons/beanutils/converters/BooleanArrayConverter.java
b/src/main/java/org/apache/commons/beanutils/converters/BooleanArrayConverter.java
index e2d20cad..517b6d5c 100644
---
a/src/main/java/org/apache/commons/beanutils/converters/BooleanArrayConverter.java
+++
b/src/main/java/org/apache/commons/beanutils/converters/BooleanArrayConverter.java
@@ -151,7 +151,7 @@ public final class BooleanArrayConverter extends
AbstractArrayConverter {
* case of this BooleanArrayConverter class, this value is ignored.
*
* @param value is the input value to be converted.
- * @return an object of type boolean[], or the default value if there was
+ * @return An object of type boolean[], or the default value if there was
* any sort of error during conversion and the constructor
* was provided with a default value.
*
diff --git
a/src/test/java/org/apache/commons/beanutils/FluentPropertyBeanIntrospectorTest.java
b/src/test/java/org/apache/commons/beanutils/FluentPropertyBeanIntrospectorTest.java
index aa05fd83..e9bbf232 100644
---
a/src/test/java/org/apache/commons/beanutils/FluentPropertyBeanIntrospectorTest.java
+++
b/src/test/java/org/apache/commons/beanutils/FluentPropertyBeanIntrospectorTest.java
@@ -45,7 +45,7 @@ public class FluentPropertyBeanIntrospectorTest extends
TestCase {
* Puts all property descriptors into a map so that they can be accessed
by property name.
*
* @param descs the array with descriptors
- * @return a map with property names as keys
+ * @return A map with property names as keys
*/
private static Map<String, PropertyDescriptor> createDescriptorMap(final
PropertyDescriptor[] descs) {
final Map<String, PropertyDescriptor> map = new HashMap<>();
diff --git
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira273BeanFactory.java
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira273BeanFactory.java
index 1947dc1e..c1d35091 100644
---
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira273BeanFactory.java
+++
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira273BeanFactory.java
@@ -60,7 +60,7 @@ public class Jira273BeanFactory {
* Factory method which creates annonymous
* {@link PublicBeanWithMethod} with method overriden.
*
- * @return a new annonymous {@link PublicBeanWithMethod}.
+ * @return A new annonymous {@link PublicBeanWithMethod}.
*/
public static Object createAnnonymousNotOverriden() {
return new PublicBeanWithMethod() {
@@ -71,7 +71,7 @@ public class Jira273BeanFactory {
* Factory method which creates annonymous
* {@link PublicBeanWithMethod} with method NOT overriden.
*
- * @return a new annonymous {@link PublicBeanWithMethod}.
+ * @return A new annonymous {@link PublicBeanWithMethod}.
*/
public static Object createAnnonymousOverriden() {
return new PublicBeanWithMethod() {
@@ -85,7 +85,7 @@ public class Jira273BeanFactory {
/**
* Factory method which creates a PrivatePrivatePublicNotOverriden bean.
*
- * @return a new a PrivatePrivatePublicNotOverriden bean.
+ * @return A new a PrivatePrivatePublicNotOverriden bean.
*/
public static Object createPrivatePrivatePublicNotOverriden() {
return new PrivatePrivatePublicNotOverriden();
@@ -94,7 +94,7 @@ public class Jira273BeanFactory {
/**
* Factory method which creates a PrivatePrivatePublicOverriden bean.
*
- * @return a new a PrivatePrivatePublicOverriden bean.
+ * @return A new a PrivatePrivatePublicOverriden bean.
*/
public static Object createPrivatePrivatePublicOverriden() {
return new PrivatePrivatePublicOverriden();
@@ -103,7 +103,7 @@ public class Jira273BeanFactory {
/**
* Factory method which creates a PrivatePublicNotOverriden bean.
*
- * @return a new a PrivatePublicNotOverriden bean.
+ * @return A new a PrivatePublicNotOverriden bean.
*/
public static Object createPrivatePublicNotOverriden() {
return new PrivatePublicNotOverriden();
@@ -112,7 +112,7 @@ public class Jira273BeanFactory {
/**
* Factory method which creates a PrivatePublicOverriden bean.
*
- * @return a new a PrivatePublicOverriden bean.
+ * @return A new a PrivatePublicOverriden bean.
*/
public static Object createPrivatePublicOverriden() {
return new PrivatePublicOverriden();
diff --git
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira298BeanFactory.java
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira298BeanFactory.java
index c214f82f..d1f33962 100644
---
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira298BeanFactory.java
+++
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira298BeanFactory.java
@@ -45,7 +45,7 @@ public class Jira298BeanFactory {
/**
* Factory method which creates ImplX.
*
- * @return a new ImplX.
+ * @return A new ImplX.
*/
public static IX createImplX() {
return new ImplX();
diff --git
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira61BeanFactory.java
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira61BeanFactory.java
index d8a2895b..63a8b4d7 100644
---
a/src/test/java/org/apache/commons/beanutils/bugs/other/Jira61BeanFactory.java
+++
b/src/test/java/org/apache/commons/beanutils/bugs/other/Jira61BeanFactory.java
@@ -105,7 +105,7 @@ public class Jira61BeanFactory {
/**
* Factory method which creates a new {@link TestBean}.
*
- * @return a new {@link TestBean}.
+ * @return A new {@link TestBean}.
*/
public static TestBean createBean() {
return new TestBean();
