You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by st...@apache.org on 2016/09/24 19:00:35 UTC
svn commit: r1762144 - in
/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils:
./ converters/
Author: stain
Date: Sat Sep 24 19:00:34 2016
New Revision: 1762144
URL: http://svn.apache.org/viewvc?rev=1762144&view=rev
Log:
BEANUTILS-497 Fix some of the doclint errors
Modified:
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaBean.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaProperty.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/WrapDynaClass.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ArrayConverter.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ConverterFacade.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/DateTimeConverter.java
commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/package-info.java
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BaseDynaBeanMapDecorator.java Sat Sep 24 19:00:34 2016
@@ -103,7 +103,7 @@ public abstract class BaseDynaBeanMapDec
/**
* clear() operation is not supported.
*
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException because clear() is not supported
*/
public void clear() {
throw new UnsupportedOperationException();
@@ -268,7 +268,7 @@ public abstract class BaseDynaBeanMapDec
*
* @param key The {@link DynaBean}'s property name
* @return the value removed
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException because remove() is not supported
*/
public Object remove(final Object key) {
throw new UnsupportedOperationException();
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/BasicDynaBean.java Sat Sep 24 19:00:34 2016
@@ -80,7 +80,7 @@ public class BasicDynaBean implements Dy
/**
* Return a Map representation of this DynaBean.
- * </p>
+ * <p>
* This, for example, could be used in JSTL in the following way to access
* a DynaBean's <code>fooProperty</code>:
* <ul><li><code>${myDynaBean.<b>map</b>.fooProperty}</code></li></ul>
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaBean.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaBean.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaBean.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaBean.java Sat Sep 24 19:00:34 2016
@@ -38,7 +38,7 @@ public interface DynaBean {
*
* @param name Name of the property to check
* @param key Name of the key to check
- * @return <code>true<code> if the mapped property contains a value for
+ * @return <code>true</code> if the mapped property contains a value for
* the specified key, otherwise <code>false</code>
*
* @throws IllegalArgumentException if there is no property
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaProperty.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaProperty.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaProperty.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/DynaProperty.java Sat Sep 24 19:00:34 2016
@@ -45,7 +45,8 @@ public class DynaProperty implements Ser
// ----------------------------------------------------------- Constants
- /*
+ private static final long serialVersionUID = -3084907613499830175L;
+ /*
* There are issues with serializing primitive class types on certain JVM versions
* (including java 1.3).
* This class uses a custom serialization implementation that writes an integer
@@ -269,6 +270,9 @@ public class DynaProperty implements Ser
* There are issues with serializing primitive class types on certain JVM versions
* (including java 1.3).
* This method provides a workaround.
+ *
+ * @param out {@link ObjectOutputStream} to write object to
+ * @throws IOException if the object can't be written
*/
private void writeObject(final ObjectOutputStream out) throws IOException {
@@ -322,8 +326,10 @@ public class DynaProperty implements Ser
* There are issues with serializing primitive class types on certain JVM versions
* (including java 1.3).
* This method provides a workaround.
- *
+ *
+ * @param in {@link ObjectInputStream} to read object from
* @throws StreamCorruptedException when the stream data values are outside expected range
+ * @throws IOException if the input stream can't be read
*/
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/WrapDynaClass.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/WrapDynaClass.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/WrapDynaClass.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/WrapDynaClass.java Sat Sep 24 19:00:34 2016
@@ -31,19 +31,18 @@ import java.util.WeakHashMap;
/**
- * <p>Implementation of <code>DynaClass</code> for DynaBeans that wrap
+ * Implementation of {@link DynaClass} that wrap
* standard JavaBean instances.</p>
- *
* <p>
- * It is suggested that this class should not usually need to be used directly
- * to create new <code>WrapDynaBean</code> instances.
- * It's usually better to call the <code>WrapDynaBean</code> constructor directly.
- * For example:</p>
- * <code><pre>
+ * This class should not usually need to be used directly
+ * to create new {@link WrapDynaBean} instances -
+ * it's usually better to call the {@link WrapDynaBean} constructor.
+ * For example:
+ * </p>
+ * <pre>
* Object javaBean = ...;
* DynaBean wrapper = new WrapDynaBean(javaBean);
- * </pre></code>
- * <p>
+ * </pre>
*
* @version $Id$
*/
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ArrayConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ArrayConverter.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ArrayConverter.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ArrayConverter.java Sat Sep 24 19:00:34 2016
@@ -57,7 +57,7 @@ import org.apache.commons.beanutils.Conv
* <li><b>Multi Dimensional Arrays</b> - it is possible to convert a <code>String</code>
* to a multi-dimensional arrays, by embedding {@link ArrayConverter}
* within each other - see example below.</li>
- * <li><b>Default Value</b></li>
+ * <li><b>Default Value</b>
* <ul>
* <li><b><i>No Default</b></i> - use the
* {@link ArrayConverter#ArrayConverter(Class, Converter)}
@@ -77,6 +77,7 @@ import org.apache.commons.beanutils.Conv
* in the array will be <code>null</code>)</li>
* </ul>
* </ul>
+ * </li>
* </ul>
*
* <h3>Parsing Delimited Lists</h3>
@@ -335,7 +336,7 @@ public class ArrayConverter extends Abst
/**
* Converts non-array values to a Collection prior
* to being converted either to an array or a String.
- * </p>
+ * <p>
* <ul>
* <li>{@link Collection} values are returned unchanged</li>
* <li>{@link Number}, {@link Boolean} and {@link java.util.Date}
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ConverterFacade.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ConverterFacade.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ConverterFacade.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/ConverterFacade.java Sat Sep 24 19:00:34 2016
@@ -22,7 +22,7 @@ import org.apache.commons.beanutils.Conv
* Provides a facade for {@link Converter} implementations
* preventing access to any public API in the implementation,
* other than that specified by {@link Converter}.
- * <p />
+ * <p>
* This implementation can be used to prevent registered {@link Converter}
* implementations that provide configuration options from being
* retrieved and modified.
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/DateTimeConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/DateTimeConverter.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/DateTimeConverter.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/converters/DateTimeConverter.java Sat Sep 24 19:00:34 2016
@@ -44,25 +44,29 @@ import org.apache.commons.beanutils.Conv
* This class provides a number of ways in which date/time
* conversions to/from Strings can be achieved:
* <ul>
- * <li>Using the SHORT date format for the default Locale, configure using:</li>
+ * <li>Using the SHORT date format for the default Locale, configure using:
* <ul>
* <li><code>setUseLocaleFormat(true)</code></li>
* </ul>
- * <li>Using the SHORT date format for a specified Locale, configure using:</li>
+ * </li>
+ * <li>Using the SHORT date format for a specified Locale, configure using:
* <ul>
* <li><code>setLocale(Locale)</code></li>
* </ul>
- * <li>Using the specified date pattern(s) for the default Locale, configure using:</li>
+ * </li>
+ * <li>Using the specified date pattern(s) for the default Locale, configure using:
* <ul>
* <li>Either <code>setPattern(String)</code> or
* <code>setPatterns(String[])</code></li>
* </ul>
- * <li>Using the specified date pattern(s) for a specified Locale, configure using:</li>
+ * </li>
+ * <li>Using the specified date pattern(s) for a specified Locale, configure using:
* <ul>
* <li><code>setPattern(String)</code> or
* <code>setPatterns(String[]) and...</code></li>
* <li><code>setLocale(Locale)</code></li>
* </ul>
+ * </li>
* <li>If none of the above are configured the
* <code>toDate(String)</code> method is used to convert
* from String to Date and the Dates's
@@ -72,7 +76,7 @@ import org.apache.commons.beanutils.Conv
*
* <p>
* The <b>Time Zone</b> to use with the date format can be specified
- * using the <code>setTimeZone()</code> method.
+ * using the {@link #setTimeZone(TimeZone)} method.
*
* @version $Id$
* @since 1.8.0
@@ -475,7 +479,7 @@ public abstract class DateTimeConverter
}
/**
- * Return a <code>DateFormat<code> for the Locale.
+ * Return a <code>DateFormat</code> for the Locale.
* @param locale The Locale to create the Format with (may be null)
* @param timeZone The Time Zone create the Format with (may be null)
*
Modified: commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/package-info.java?rev=1762144&r1=1762143&r2=1762144&view=diff
==============================================================================
--- commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/package-info.java (original)
+++ commons/proper/beanutils/trunk/src/main/java/org/apache/commons/beanutils/package-info.java Sat Sep 24 19:00:34 2016
@@ -797,7 +797,7 @@
* <h1>4. Data Type Conversions</h1>
*
* <a name="conversion.background"></a>
- * <h3>4.1 Background</h3>
+ * <h2>4.1 Background</h2>
*
* <p>So far, we've only considered the cases where the data types of the
* dynamically accessed properties are known, and where we can use Java casts
@@ -807,7 +807,7 @@
* for performing this task as well.</p>
*
* <a name="conversion.beanutils"></a>
- * <h3>4.2 <code>BeanUtils</code> and <code>ConvertUtils</code> Conversions</h3>
+ * <h2>4.2 <code>BeanUtils</code> and <code>ConvertUtils</code> Conversions</h2>
*
* <p>A very common use case (and the situation that caused the initial creation
* of the <em>BeanUtils</em> package) was the desire to convert the set of request
@@ -854,7 +854,7 @@
* new code should not be written with reliance on ConvertUtils.</p>
*
* <a name="conversion.defining"></a>
- * <h3>4.3 Defining Your Own Converters</h3>
+ * <h2>4.3 Defining Your Own Converters</h2>
*
* <p>The <code>ConvertUtils</code> class supports the ability to define and
* register your own String --> Object conversions for any given Java class.
@@ -872,7 +872,7 @@
* </ul>
*
* <a name="conversion.i18n"></a>
- * <h3>4.4 Locale Aware Conversions</h3>
+ * <h2>4.4 Locale Aware Conversions</h2>
* <p>The standard classes in <code>org.apache.commons.beanutils</code> are not
* locale aware. This gives them a cleaner interface and makes then easier to use
* in situations where the locale is not important.</p>
@@ -885,7 +885,7 @@
* <a name="instances"></a>
* <h1>5. Utility Objects And Static Utility Classes</h1>
* <a name="instances.background"></a>
- * <h3>Background</h3>
+ * <h2>Background</h2>
* <p>
* So far, the examples have covered the static utility classes (<code>BeanUtils</code>,
* <code>ConvertUtils</code> and <code>PropertyUtils</code>). These are easy to use but are
@@ -912,13 +912,13 @@
* <a name="collections"></a>
* <h1>6. Collections</h1>
* <a name="bean-comparator"></a>
- * <h3>6.1 Comparing Beans</h3>
+ * <h2>6.1 Comparing Beans</h2>
* <p>
* <code>org.apache.commons.beanutils.BeanComparator</code> is a <code>Comparator</code> implementation
* that compares beans based on a shared property value.
* </p>
* <a name="bean-property-closure"></a>
- * <h3>6.2 Operating On Collections Of Beans</h3>
+ * <h2>6.2 Operating On Collections Of Beans</h2>
* <p>
* The <code>Closure</code> interface in <code>commons-collections</code> encapsulates a block of code that
* executes on an arbitrary input Object. <code>Commons-collections</code> contains code that allows
@@ -944,7 +944,7 @@
* </p>
*
* <a name="bean-property-predicate"></a>
- * <h3>6.3 Querying Or Filtering Collections Of Beans</h3>
+ * <h2>6.3 Querying Or Filtering Collections Of Beans</h2>
* <p>
* The <code>Predicate</code> interface in <code>commons-collections</code> encapsulates an evaluation
* of an input Object that returns either true or false. <code>Commons-collections</code> contains code
@@ -971,7 +971,7 @@
* </p>
*
* <a href="bean-property-transformer"></a>
- * <h3>6.4 Transforming Collections Of Beans</h3>
+ * <h2>6.4 Transforming Collections Of Beans</h2>
* <p>
* The <code>Transformer</code> interface in <code>commons-collections</code> encapsulates the transformation
* of an input Object into an output object. <code>Commons-collections</code> contains code
@@ -1001,7 +1001,7 @@
* <h1>7. Frequently Asked Questions</h1>
*
* <a name="FAQ.property"></a>
- * <h3>Why Can't BeanUtils Find My Method?</h3>
+ * <h2>Why Can't BeanUtils Find My Method?</h2>
* <p>The <em>BeanUtils</em> package relies on <em>introspection</em> rather than
* <em>reflection</em>. This means that it will find only
* <a href='http://java.sun.com/products/javabeans'><em>JavaBean</em>
@@ -1017,7 +1017,7 @@
* </ul>
* </p>
* <a name="FAQ.bc.order"></a>
- * <h3>How Do I Set The BeanComparator Order To Be Ascending/Descending?</h3>
+ * <h2>How Do I Set The BeanComparator Order To Be Ascending/Descending?</h2>
* <p>
* BeanComparator relies on an internal Comparator to perform the actual
* comparisions. By default,