This is an automated email from the ASF dual-hosted git repository.
ggregory 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 a65e0813 Use Javadoc @code
a65e0813 is described below
commit a65e0813c8f4cb491131f70cfe061f0a44731b09
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Jul 29 08:49:56 2024 -0400
Use Javadoc @code
---
.../BeanPropertyValueChangeConsumer.java | 4 ++--
.../BeanPropertyValueEqualsPredicate.java | 8 ++++----
.../beanutils2/BeanToPropertyValueTransformer.java | 4 ++--
.../beanutils2/DynaBeanPropertyMapDecorator.java | 4 ++--
.../apache/commons/beanutils2/LazyDynaBean.java | 20 +++++++++---------
.../apache/commons/beanutils2/LazyDynaList.java | 24 +++++++++++-----------
.../apache/commons/beanutils2/WrapDynaBean.java | 4 ++--
.../apache/commons/beanutils2/WrapDynaClass.java | 4 ++--
.../beanutils2/converters/ColorConverter.java | 10 ++++-----
.../beanutils2/converters/DimensionConverter.java | 2 +-
.../apache/commons/beanutils2/package-info.java | 20 +++++++++---------
11 files changed, 52 insertions(+), 52 deletions(-)
diff --git
a/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueChangeConsumer.java
b/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueChangeConsumer.java
index 935d7a57..54ccc22b 100644
---
a/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueChangeConsumer.java
+++
b/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueChangeConsumer.java
@@ -49,14 +49,14 @@ import org.apache.commons.logging.LogFactory;
* <p>
* A typical usage might look like:
* </p>
- * <pre><code>
+ * <pre>{@code
* // create the closure
* BeanPropertyValueChangeClosure closure =
* new BeanPropertyValueChangeClosure( "activeEmployee", Boolean.TRUE );
*
* // update the Collection
* CollectionUtils.forAllDo( peopleCollection, closure );
- * </code></pre>
+ * }</pre>
*
* This would take a {@code Collection} of person objects and update the
* {@code activeEmployee</code> property of each object in the
<code>Collection} to
diff --git
a/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueEqualsPredicate.java
b/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueEqualsPredicate.java
index c090569f..9f181fa2 100644
---
a/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueEqualsPredicate.java
+++
b/src/main/java/org/apache/commons/beanutils2/BeanPropertyValueEqualsPredicate.java
@@ -56,14 +56,14 @@ import org.apache.commons.logging.LogFactory;
* <p>
* A typical usage might look like:
* </p>
- * <pre><code>
+ * <pre>{@code
* // create the closure
* BeanPropertyValueEqualsPredicate predicate =
* new BeanPropertyValueEqualsPredicate( "activeEmployee", Boolean.FALSE );
*
* // filter the Collection
* CollectionUtils.filter( peopleCollection, predicate );
- * </code></pre>
+ * }</pre>
* <p>
* This would take a {@code Collection} of person objects and filter out any
people whose
* {@code activeEmployee</code> property is <code>false}. Assuming...
@@ -81,14 +81,14 @@ import org.apache.commons.logging.LogFactory;
* <p>
* Another typical usage might look like:
* </p>
- * <pre><code>
+ * <pre>{@code
* // create the closure
* BeanPropertyValueEqualsPredicate predicate =
* new BeanPropertyValueEqualsPredicate( "personId", "456-12-1234" );
*
* // search the Collection
* CollectionUtils.find( peopleCollection, predicate );
- * </code></pre>
+ * }</pre>
* <p>
* This would search a {@code Collection} of person objects and return the
first object whose
* {@code personId</code> property value equals <code>456-12-1234}. Assuming...
diff --git
a/src/main/java/org/apache/commons/beanutils2/BeanToPropertyValueTransformer.java
b/src/main/java/org/apache/commons/beanutils2/BeanToPropertyValueTransformer.java
index a50e99dd..6ab13401 100644
---
a/src/main/java/org/apache/commons/beanutils2/BeanToPropertyValueTransformer.java
+++
b/src/main/java/org/apache/commons/beanutils2/BeanToPropertyValueTransformer.java
@@ -38,13 +38,13 @@ import org.apache.commons.logging.LogFactory;
* <p>
* A typical usage might look like:
* </p>
- * <pre><code>
+ * <pre>{@code
* // create the transformer
* BeanToPropertyValueTransformer transformer = new
BeanToPropertyValueTransformer( "person.address.city" );
*
* // transform the Collection
* Collection peoplesCities = CollectionUtils.collect( peopleCollection,
transformer );
- * </code></pre>
+ * }</pre>
*
* <p>
* This would take a {@code Collection</code> of person objects and return a
<code>Collection}
diff --git
a/src/main/java/org/apache/commons/beanutils2/DynaBeanPropertyMapDecorator.java
b/src/main/java/org/apache/commons/beanutils2/DynaBeanPropertyMapDecorator.java
index ccca998e..750488f7 100644
---
a/src/main/java/org/apache/commons/beanutils2/DynaBeanPropertyMapDecorator.java
+++
b/src/main/java/org/apache/commons/beanutils2/DynaBeanPropertyMapDecorator.java
@@ -47,8 +47,8 @@ package org.apache.commons.beanutils2;
* {@code DynaBeanPropertyMapDecorator} with the <b><em>read only</em></b>
* attribute set to {@code false}:</p>
*
- * <ul><li><code>Map<String, Object> fooMap =
- * new DynaBeanPropertyMapDecorator(fooDynaBean, false);</code></li></ul>
+ * <ul><li>{@code Map<String, Object> fooMap =
+ * new DynaBeanPropertyMapDecorator(fooDynaBean, false);}</li></ul>
*
* <h2>Limitations</h2>
* <p>In this implementation the {@code entrySet()</code>, <code>keySet()}
diff --git a/src/main/java/org/apache/commons/beanutils2/LazyDynaBean.java
b/src/main/java/org/apache/commons/beanutils2/LazyDynaBean.java
index bbaabd28..ab711503 100644
--- a/src/main/java/org/apache/commons/beanutils2/LazyDynaBean.java
+++ b/src/main/java/org/apache/commons/beanutils2/LazyDynaBean.java
@@ -54,10 +54,10 @@ import org.apache.commons.logging.LogFactory;
* <p>The {@code LazyDynaBean</code> will automatically add a property to
the <code>DynaClass}
* if it doesn't exist when the {@code set(name, value)} method is
called.</p>
*
- * <pre><code>
+ * <pre>{@code
* DynaBean myBean = new LazyDynaBean();
* myBean.set("myProperty", "myValue");
- * </code></pre>
+ * }</pre>
*
* <p><b><u>Setting Indexed Properties</u></b></p>
* <p>If the property <b>doesn't</b> exist, the {@code LazyDynaBean} will
automatically add
@@ -69,11 +69,11 @@ import org.apache.commons.logging.LogFactory;
* this can be easily changed by overriding the {@code
defaultIndexedProperty(name)}
* method.</p>
*
- * <pre><code>
+ * <pre>{@code
* DynaBean myBean = new LazyDynaBean();
* myBean.set("myIndexedProperty", 0, "myValue1");
* myBean.set("myIndexedProperty", 1, "myValue2");
- * </code></pre>
+ * }</pre>
*
* <p>If the indexed property <b>does</b> exist in the {@code DynaClass}
but is set to
* {@code null</code> in the <code>LazyDynaBean}, then it will
instantiate a
@@ -81,13 +81,13 @@ import org.apache.commons.logging.LogFactory;
* in the {@code DynaClass</code> and automatically <em>grow</em> the
<code>List}
* or {@code Array} so that it is big enough to accommodate the index
being set.</p>
*
- * <pre><code>
+ * <pre>{@code
* DynaBean myBean = new LazyDynaBean();
* MutableDynaClass myClass = (MutableDynaClass)myBean.getDynaClass();
* myClass.add("myIndexedProperty", int[].class);
* myBean.set("myIndexedProperty", 0, Integer.valueOf(10));
* myBean.set("myIndexedProperty", 1, Integer.valueOf(20));
- * </code></pre>
+ * }</pre>
*
* <p><b><u>Setting Mapped Properties</u></b></p>
* <p>If the property <b>doesn't</b> exist, the {@code LazyDynaBean} will
automatically add
@@ -97,21 +97,21 @@ import org.apache.commons.logging.LogFactory;
* mapped property that LazyDynaBean uses but this can be easily changed
by overriding
* the {@code defaultMappedProperty(name)} method.</p>
*
- * <pre><code>
+ * <pre>{@code
* DynaBean myBean = new LazyDynaBean();
* myBean.set("myMappedProperty", "myKey", "myValue");
- * </code></pre>
+ * }</pre>
*
* <p>If the mapped property <b>does</b> exist in the {@code DynaClass} but
is set to
* {@code null</code> in the <code>LazyDynaBean}, then it will
instantiate a
* new {@code Map</code> as specified by the property's type in the
<code>DynaClass}.</p>
*
- * <pre><code>
+ * <pre>{@code
* DynaBean myBean = new LazyDynaBean();
* MutableDynaClass myClass = (MutableDynaClass)myBean.getDynaClass();
* myClass.add("myMappedProperty", TreeMap.class);
* myBean.set("myMappedProperty", "myKey", "myValue");
- * </code></pre>
+ * }</pre>
*
* <p><b><u><em>Restricted</em> DynaClass</u></b></p>
* <p>{@code MutableDynaClass</code> have a facility to <em>restrict</em>
the <code>DynaClass}
diff --git a/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
b/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
index 26cc5f3d..cc0f8fe4 100644
--- a/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
+++ b/src/main/java/org/apache/commons/beanutils2/LazyDynaList.java
@@ -70,27 +70,27 @@ import java.util.Objects;
* <p>If you have an array of {@code java.util.Map[]} - you can put that into
* a {@code LazyDynaList}.</p>
*
- * <pre><code>
+ * <pre>{@code
* TreeMap[] myArray = .... // your Map[]
* List lazyList = new LazyDynaList(myArray);
- * </code></pre>
+ * }</pre>
*
* <p>New elements of the appropriate Map type are
* automatically populated:</p>
*
- * <pre><code>
+ * <pre>{@code
* // get(index) automatically grows the list
* DynaBean newElement = (DynaBean)lazyList.get(lazyList.size());
* newElement.put("someProperty", "someValue");
- * </code></pre>
+ * }</pre>
*
* <p>Once you've finished you can get back an Array of the
* elements of the appropriate type:</p>
*
- * <pre><code>
+ * <pre>{@code
* // Retrieve the array from the list
* TreeMap[] myArray = (TreeMap[])lazyList.toArray());
- * </code></pre>
+ * }</pre>
*
*
* <h2>Example 2</h2>
@@ -98,7 +98,7 @@ import java.util.Objects;
* specify the Class for List's elements. The LazyDynaList
* uses the Class to automatically populate elements:</p>
*
- * <pre><code>
+ * <pre>{@code
* // e.g. For Maps
* List lazyList = new LazyDynaList(TreeMap.class);
*
@@ -107,14 +107,14 @@ import java.util.Objects;
*
* // e.g. For DynaBeans
* List lazyList = new LazyDynaList(MyDynaBean.class);
- * </code></pre>
+ * }</pre>
*
* <h2>Example 3</h2>
* <p>Alternatively you can create an <em>empty</em> List and specify the
* DynaClass for List's elements. The LazyDynaList uses
* the DynaClass to automatically populate elements:</p>
*
- * <pre><code>
+ * <pre>{@code
* // e.g. For Maps
* DynaClass dynaClass = new LazyDynaMap(new HashMap());
* List lazyList = new LazyDynaList(dynaClass);
@@ -126,7 +126,7 @@ import java.util.Objects;
* // e.g. For DynaBeans
* DynaClass dynaClass = new BasicDynaClass(properties);
* List lazyList = new LazyDynaList(dynaClass);
- * </code></pre>
+ * }</pre>
*
* <p><strong>N.B.</strong> You may wonder why control the type
* using a {@code DynaClass</code> rather than the <code>Class}
@@ -142,7 +142,7 @@ import java.util.Objects;
* with the normal {@link java.util.List} methods (i.e.
* {@code add()}, {@code addAll()} or {@code set()}).</p>
*
- * <pre><code>
+ * <pre>{@code
* // Create a new LazyDynaList (100 element capacity)
* LazyDynaList lazyList = new LazyDynaList(100);
*
@@ -155,7 +155,7 @@ import java.util.Objects;
* // Populate from a collection
* lazyList.addAll(myCollection);
*
- * </code></pre>
+ * }</pre>
*
* @since 1.8.0
*/
diff --git a/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
b/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
index d8848f94..56c33ef8 100644
--- a/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
+++ b/src/main/java/org/apache/commons/beanutils2/WrapDynaBean.java
@@ -29,12 +29,12 @@ import java.lang.reflect.InvocationTargetException;
* (This makes it different from the typical use cases for other {@code
DynaBean}'s.)
* For example:
* </p>
- * <pre><code>
+ * <pre>{@code
* Object aJavaBean = ...;
* ...
* DynaBean db = new WrapDynaBean(aJavaBean);
* ...
- * </code></pre>
+ * }</pre>
*
* <p><strong>IMPLEMENTATION NOTE</strong> - This implementation does not
* support the {@code contains()</code> and <code>remove()} methods.</p>
diff --git a/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
b/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
index 0d5a1cd0..a1ebe4b9 100644
--- a/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
+++ b/src/main/java/org/apache/commons/beanutils2/WrapDynaClass.java
@@ -315,10 +315,10 @@ public class WrapDynaClass implements DynaClass {
* this method. It is usually better to create new
* {@code WrapDynaBean} instances by calling its constructor.
* For example:</p>
- * <pre><code>
+ * <pre>{@code
* Object javaBean = ...;
* DynaBean wrapper = new WrapDynaBean(javaBean);
- * </code></pre>
+ * }</pre>
* <p>
* (This method is needed for some kinds of {@code DynaBean} framework.)
* </p>
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/ColorConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/ColorConverter.java
index 5f5b5052..ed85c9a3 100644
--- a/src/main/java/org/apache/commons/beanutils2/converters/ColorConverter.java
+++ b/src/main/java/org/apache/commons/beanutils2/converters/ColorConverter.java
@@ -28,7 +28,7 @@ import java.util.regex.Pattern;
*
* <p>
* Will interpret hexadecimal colors similar to CSS engines, for example
#RGB is interpreted as
- * #RRGGBB. If using the literal hexadecimal value is desired, the value
should be prefixed with <code>0x</code>
+ * #RRGGBB. If using the literal hexadecimal value is desired, the value
should be prefixed with {@code 0x}
* instead of {@link #HEX_COLOR_PREFIX #}.
* </p>
*
@@ -164,10 +164,10 @@ public class ColorConverter extends
AbstractConverter<Color> {
*
* Accepts the following values:
* <ul>
- * <li><code>java.awt.Color[r=255,g=255,b=255]</code></li>
- * <li><code>[r=255,g=255,b=255]</code></li>
- * <li><code>r=255,g=255,b=255</code></li>
- * <li><code>255,255,255</code></li>
+ * <li>{@code java.awt.Color[r=255,g=255,b=255]}</li>
+ * <li>{@code [r=255,g=255,b=255]}</li>
+ * <li>{@code r=255,g=255,b=255}</li>
+ * <li>{@code 255,255,255}</li>
* </ul>
*
* @param value A color as represented by {@link Color#toString()}.
diff --git
a/src/main/java/org/apache/commons/beanutils2/converters/DimensionConverter.java
b/src/main/java/org/apache/commons/beanutils2/converters/DimensionConverter.java
index 7b82a41b..0d4de490 100644
---
a/src/main/java/org/apache/commons/beanutils2/converters/DimensionConverter.java
+++
b/src/main/java/org/apache/commons/beanutils2/converters/DimensionConverter.java
@@ -26,7 +26,7 @@ import java.util.regex.Pattern;
* {@link org.apache.commons.beanutils2.Converter} implementation that handles
conversion to and from {@link Dimension}.
*
* <p>
- * Accepts a single {@link Integer} value, or two {@link Integer} values
separated by the character <code>x</code>.
+ * Accepts a single {@link Integer} value, or two {@link Integer} values
separated by the character {@code x}.
* </p>
*
* <p>The dimensions must consist of non-negative {@link Integer} values
only.</p>
diff --git a/src/main/java/org/apache/commons/beanutils2/package-info.java
b/src/main/java/org/apache/commons/beanutils2/package-info.java
index e56f7fce..bd40962b 100644
--- a/src/main/java/org/apache/commons/beanutils2/package-info.java
+++ b/src/main/java/org/apache/commons/beanutils2/package-info.java
@@ -877,8 +877,8 @@
* locale aware. This gives them a cleaner interface and makes then easier to
use
* in situations where the locale is not important.</p>
* <p>Extended, locale-aware analogues can be found in
- * <code><a
href='locale/package-summary.html'>org.apache.commons.beanutils2.locale
- * </a></code>. These are built along the same
+ * <a href='locale/package-summary.html'>{@code
org.apache.commons.beanutils2.locale}</a>.
+ * These are built along the same
* lines as the basic classes but support localization.</p>
*
*
@@ -933,14 +933,14 @@
* so that all the beans in a collection can have a particular property set to
a particular value.
* </p>
* <p>For example, set the activeEmployee property to TRUE for an entire
collection:</p>
- * <pre><code>
+ * <pre>{@code
* // create the closure
* BeanPropertyValueChangeClosure closure =
* new BeanPropertyValueChangeClosure( "activeEmployee", Boolean.TRUE
);
*
* // update the Collection
* CollectionUtils.forAllDo( peopleCollection, closure );
- * </code></pre>
+ * }</pre>
*
* <a id="bean-property-predicate"></a>
* <h3>6.3 Querying Or Filtering Collections Of Beans</h3>
@@ -959,13 +959,13 @@
* to filter collections on the basis of a property value.
* </p>
* <p>For example, to filter a collection to find all beans where active
employee is false use:</p>
- * <pre><code>
+ * <pre>{@code
* BeanPropertyValueEqualsPredicate predicate =
* new BeanPropertyValueEqualsPredicate( "activeEmployee",
Boolean.FALSE );
*
* // filter the Collection
* CollectionUtils.filter( peopleCollection, predicate );
- * </code></pre>
+ * }</pre>
*
* <a href="bean-property-transformer"></a>
* <h3>6.4 Transforming Collections Of Beans</h3>
@@ -986,13 +986,13 @@
* For example, to find all cities that are contained in the address of each
person property of each bean in
* a collection:
* </p>
- * <pre><code>
+ * <pre>{@code
* // create the transformer
* BeanToPropertyValueTransformer transformer = new
BeanToPropertyValueTransformer( "person.address.city" );
*
* // transform the Collection
* Collection peoplesCities = CollectionUtils.collect( peopleCollection,
transformer );
- * </code></pre>
+ * }</pre>
*
* <a id="FAQ"></a>
* <h2>7. Frequently Asked Questions</h2>
@@ -1025,7 +1025,7 @@
* <p>
* For example:
* </p>
- * <pre><code>
+ * <pre>{@code
* import org.apache.commons.collections4.comparators.ComparableComparator;
* import org.apache.commons.collections4.comparators.ReverseComparator;
* import org.apache.commons.beanutils2.BeanComparator;
@@ -1034,6 +1034,6 @@
* = new BeanComparator("propertyName", new ReverseComparator(new
ComparableComparator()));
* Collections.sort(myList, reversedNaturalOrderBeanComparator);
* ...
- * </code></pre>
+ * }</pre>
*/
package org.apache.commons.beanutils2;
