Add since tags

Update javadoc


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137317 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/lang/IllegalClassException.java

@@ -57,14 +57,16 @@ package org.apache.commons.lang;
  * Thrown when an object is an instance of an unexpected class.
  * 
  * @author Matthew Hawthorne
- * @version $Id: IllegalClassException.java,v 1.1 2003/05/15 04:05:11 bayard Exp $
+ * @since 2.0
+ * @version $Id: IllegalClassException.java,v 1.2 2003/05/16 16:14:16 scolebourne Exp $
  */
 public class IllegalClassException extends IllegalArgumentException {
 
     /**
      * Instantiates with the specified classes.
-     * @param expected the expected type
+     * 
-     * @param actual the actual type
+     * @param expected  the expected type
+     * @param actual  the actual type
      */
     public IllegalClassException(Class expected, Class actual) {
         super(
@@ -76,7 +78,8 @@ public class IllegalClassException extends IllegalArgumentException {
 
     /**
      * Instantiates with the specified classes.
-     * @param message the exception message
+     * 
+     * @param message  the exception message
      */
     public IllegalClassException(String message) {
         super(message);
@@ -84,11 +87,12 @@ public class IllegalClassException extends IllegalArgumentException {
 
     /**
      * Gets a classname without throwing an Exception.
-     * @param c a <code>Class</code>
+     * 
+     * @param cls  a <code>Class</code>
      * @return the name of <code>c</code>, or a <code>null</code> <code>String</code>
      */
-    private static final String safeGetClassName(Class c) {
+    private static final String safeGetClassName(Class cls) {
-        return c == null ? null : c.getName();
+        return cls == null ? null : cls.getName();
     }
 
 }

src/java/org/apache/commons/lang/IncompleteArgumentException.java

@@ -59,13 +59,15 @@ import java.util.Arrays;
  * Thrown to indicate an incomplete argument to a method.
  * 
  * @author Matthew Hawthorne
- * @version $Id: IncompleteArgumentException.java,v 1.1 2003/05/15 04:05:11 bayard Exp $
+ * @since 2.0
+ * @version $Id: IncompleteArgumentException.java,v 1.2 2003/05/16 16:14:17 scolebourne Exp $
  */
 public class IncompleteArgumentException extends IllegalArgumentException {
 
     /**
      * Instantiates with the specified description.
-     * @param argName a description of the incomplete argument
+     * 
+     * @param argName  a description of the incomplete argument
      */
     public IncompleteArgumentException(String argName) {
         super(argName + " is incomplete.");
@@ -73,7 +75,9 @@ public class IncompleteArgumentException extends IllegalArgumentException {
 
     /**
      * Instantiates with the specified description.
-     * @param item a description of the incomplete argument
+     * 
+     * @param argName  a description of the incomplete argument
+     * @param items  an array describing the arguments missing
      */
     public IncompleteArgumentException(String argName, String[] items) {
         super(
@@ -84,7 +88,8 @@ public class IncompleteArgumentException extends IllegalArgumentException {
 
     /**
      * Converts an array to a string without throwing an exception.
-     * @param array an array
+     * 
+     * @param array  an array
      * @return the array as a string
      */
     private static final String safeArrayToString(Object[] array) {

src/java/org/apache/commons/lang/NotImplementedException.java

@@ -57,13 +57,15 @@ package org.apache.commons.lang;
  * Thrown to indicate that a method has not been implemented.
  * 
  * @author Matthew Hawthorne
- * @version $Id: NotImplementedException.java,v 1.1 2003/05/15 04:05:11 bayard Exp $
+ * @since 2.0
+ * @version $Id: NotImplementedException.java,v 1.2 2003/05/16 16:14:17 scolebourne Exp $
  */
 public class NotImplementedException extends UnsupportedOperationException {
 
     /**
-     * Instantites with the specified class.
+     * Constructes the exception with the specified class.
-     * @param clazz the <code>Class</code> that has not implemented the method
+     * 
+     * @param clazz  the <code>Class</code> that has not implemented the method
      */
     public NotImplementedException(Class clazz) {
         super(
@@ -72,8 +74,9 @@ public class NotImplementedException extends UnsupportedOperationException {
     }
 
     /**
-     * Instantites with the specified msg.
+     * Constructs the exception with the specified message.
-     * @param msg the exception message.
+     * 
+     * @param msg  the exception message.
      */
     public NotImplementedException(String msg) {
         super(msg);

src/java/org/apache/commons/lang/NullArgumentException.java

@@ -57,13 +57,15 @@ package org.apache.commons.lang;
  * Thrown to indicate that an argument was null and should not have been.
  * 
  * @author Matthew Hawthorne
- * @version $Id: NullArgumentException.java,v 1.1 2003/05/15 04:05:11 bayard Exp $
+ * @since 2.0
+ * @version $Id: NullArgumentException.java,v 1.2 2003/05/16 16:14:17 scolebourne Exp $
  */
 public class NullArgumentException extends IllegalArgumentException {
 
 	/**
 	 * Instantiates with the given argument name.
-	 * @param argName - the name of the argument that was null.
+     * 
+	 * @param argName  the name of the argument that was null.
 	 */
 	public NullArgumentException(String argName) {
 		super(argName + " cannot be null.");

src/java/org/apache/commons/lang/UnhandledException.java

@@ -60,14 +60,26 @@ import org.apache.commons.lang.exception.NestableRuntimeException;
  * or throw a checked exception.
  * 
  * @author Matthew Hawthorne
- * @version $Id: UnhandledException.java,v 1.1 2003/05/15 04:05:11 bayard Exp $
+ * @since 2.0
+ * @version $Id: UnhandledException.java,v 1.2 2003/05/16 16:14:17 scolebourne Exp $
  */
 public class UnhandledException extends NestableRuntimeException {
 
+    /**
+     * Constructs the exception using a cause.
+     * 
+     * @param cause  the underlying cause
+     */
 	public UnhandledException(Throwable cause) {
 		super(cause);
 	}
 
+    /**
+     * Constructs the exception using a message and cause.
+     * 
+     * @param message  the message to use
+     * @param cause  the underlying cause
+     */
 	public UnhandledException(String message, Throwable cause) {
 		super(message, cause);
 	}