Save This Page
Home » commons-lang-2.4-src » org.apache.commons » lang » [javadoc | source]
org.apache.commons.lang
public class: NullArgumentException [javadoc | source]
java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         java.lang.RuntimeException
            java.lang.IllegalArgumentException
               org.apache.commons.lang.NullArgumentException

All Implemented Interfaces:
    Serializable

Thrown to indicate that an argument was null and should not have been. This exception supplements the standard IllegalArgumentException by providing a more semantically rich description of the problem.

NullArgumentException represents the case where a method takes in a parameter that must not be null. Some coding standards would use NullPointerException for this case, others will use IllegalArgumentException. Thus this exception would be used in place of IllegalArgumentException, yet it still extends it.

public void foo(String str) {
if (str == null) {
throw new NullArgumentException("str");
}
// do something with the string
}
Constructor:
 public NullArgumentException(String argName) 

    Instantiates with the given argument name.

    Parameters:
    argName - the name of the argument that was null.
Methods from java.lang.Throwable:
fillInStackTrace,   getCause,   getLocalizedMessage,   getMessage,   getStackTrace,   initCause,   printStackTrace,   printStackTrace,   printStackTrace,   setStackTrace,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait