Author: bayard
Date: Fri Jun 29 00:29:41 2007
New Revision: 551821

URL: http://svn.apache.org/viewvc?view=rev&rev=551821
Log:
Adding some javadoc

Modified:
    
jakarta/commons/proper/cli/branches/cli-1.0.x/src/java/org/apache/commons/cli/Option.java

Modified: 
jakarta/commons/proper/cli/branches/cli-1.0.x/src/java/org/apache/commons/cli/Option.java
URL: 
http://svn.apache.org/viewvc/jakarta/commons/proper/cli/branches/cli-1.0.x/src/java/org/apache/commons/cli/Option.java?view=diff&rev=551821&r1=551820&r2=551821
==============================================================================
--- 
jakarta/commons/proper/cli/branches/cli-1.0.x/src/java/org/apache/commons/cli/Option.java
 (original)
+++ 
jakarta/commons/proper/cli/branches/cli-1.0.x/src/java/org/apache/commons/cli/Option.java
 Fri Jun 29 00:29:41 2007
@@ -632,6 +632,16 @@
         return result;
     }
 
+    /**
+     * A rather odd clone method - due to incorrect code in 1.0 it is public 
+     * and in 1.1 rather than throwing a CloneNotSupportedException it throws 
+     * a RuntimeException so as to maintain backwards compat at the API level. 
+     *
+     * After calling this method, it is very likely you will want to call 
+     * clearValues(). 
+     *
+     * @throws RuntimeException
+     */
     public Object clone() {
         try {
             Option option = (Option) super.clone();
@@ -653,6 +663,12 @@
         this.values.clear();
     }
 
+    /**
+     * This method is not intended to be used. It was a piece of internal 
+     * API that was made public in 1.0. It currently throws an 
UnsupportedOperationException. 
+     * @deprecated
+     * @throws UnsupportedOperationException
+     */
     public boolean addValue(String value) {
         throw new UnsupportedOperationException(
            "The addValue method is not intended for client use. " + 



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to