commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r905266 - in /commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang: mutable/ text/ time/
Date Mon, 01 Feb 2010 11:59:41 GMT
Author: niallp
Date: Mon Feb  1 11:59:40 2010
New Revision: 905266

URL: http://svn.apache.org/viewvc?rev=905266&view=rev
Log:
Javadoc corrections

Modified:
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableBoolean.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableByte.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableFloat.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableInt.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableLong.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableShort.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/text/ExtendedMessageFormat.java
    commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/time/DateUtils.java

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableBoolean.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableBoolean.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableBoolean.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableBoolean.java
Mon Feb  1 11:59:40 2010
@@ -166,7 +166,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      *  where false is less than true
      */

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableByte.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableByte.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableByte.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableByte.java
Mon Feb  1 11:59:40 2010
@@ -252,7 +252,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      * @throws ClassCastException if the argument is not a MutableByte
      */

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableFloat.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableFloat.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableFloat.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableFloat.java
Mon Feb  1 11:59:40 2010
@@ -285,7 +285,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      */
     public int compareTo(Object obj) {

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableInt.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableInt.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableInt.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableInt.java
Mon Feb  1 11:59:40 2010
@@ -243,7 +243,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      * @throws ClassCastException if the argument is not a MutableInt
      */

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableLong.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableLong.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableLong.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableLong.java
Mon Feb  1 11:59:40 2010
@@ -243,7 +243,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      * @throws ClassCastException if the argument is not a MutableLong
      */

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableShort.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableShort.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableShort.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/mutable/MutableShort.java
Mon Feb  1 11:59:40 2010
@@ -252,7 +252,7 @@
     /**
      * Compares this mutable to another in ascending order.
      * 
-     * @param other  the other mutable to compare to, not null
+     * @param obj the other mutable to compare to, not null
      * @return negative if this is less, zero if equal, positive if greater
      * @throws ClassCastException if the argument is not a MutableShort
      */

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/text/ExtendedMessageFormat.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/text/ExtendedMessageFormat.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/text/ExtendedMessageFormat.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/text/ExtendedMessageFormat.java
Mon Feb  1 11:59:40 2010
@@ -214,6 +214,7 @@
     }
 
     /**
+     * {@inheritDoc}
      * @throws UnsupportedOperationException
      */
     public void setFormatByArgumentIndex(int argumentIndex, Format newFormat) {
@@ -229,6 +230,7 @@
     }
 
     /**
+     * {@inheritDoc}
      * @throws UnsupportedOperationException
      */
     public void setFormatsByArgumentIndex(Format[] newFormats) {

Modified: commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/time/DateUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/time/DateUtils.java?rev=905266&r1=905265&r2=905266&view=diff
==============================================================================
--- commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/time/DateUtils.java
(original)
+++ commons/proper/lang/branches/LANG_2_X/src/main/java/org/apache/commons/lang/time/DateUtils.java
Mon Feb  1 11:59:40 2010
@@ -299,15 +299,29 @@
      * 
      * @param str  the date to parse, not null
      * @param parsePatterns  the date format patterns to use, see SimpleDateFormat, not null
-     * @param lenient Specify whether or not date/time parsing is to be lenient.
      * @return the parsed date
      * @throws IllegalArgumentException if the date string or pattern array is null
      * @throws ParseException if none of the date patterns were suitable
-     * @see java.util.Calender#isLenient()
      */
     public static Date parseDateStrictly(String str, String[] parsePatterns) throws ParseException
{
         return parseDateWithLeniency(str, parsePatterns, false);
     }
+
+    /**
+     * <p>Parses a string representing a date by trying a variety of different parsers.</p>
+     * 
+     * <p>The parse will try each parse pattern in turn.
+     * A parse is only deemed successful if it parses the whole of the input string.
+     * If no parse patterns match, a ParseException is thrown.</p>
+     * 
+     * @param str  the date to parse, not null
+     * @param parsePatterns  the date format patterns to use, see SimpleDateFormat, not null
+     * @param lenient Specify whether or not date/time parsing is to be lenient.
+     * @return the parsed date
+     * @throws IllegalArgumentException if the date string or pattern array is null
+     * @throws ParseException if none of the date patterns were suitable
+     * @see java.util.Calender#isLenient()
+     */
     private static Date parseDateWithLeniency(String str, String[] parsePatterns,
             boolean lenient) throws ParseException {
         if (str == null || parsePatterns == null) {



Mime
View raw message