oracle.javatools.util
Class NullArgumentException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              java.lang.NullPointerException
                  oracle.javatools.util.NullArgumentException

All Implemented Interfaces:

java.io.Serializable

public class NullArgumentException
extends java.lang.NullPointerException

Thrown to indicate that a null argument has been passed to a method that requires a non-null argument. Convention dictates that a NullPointerException be thrown in this case. This subclass of NullPointerException allows this case of a null argument to be distinguished from a NullPointerException within the method that is not related to a null argument. This distinction may be useful, for example, to an automatic bug filer so it can file the bug against the caller of the method, rather than against the method itself.

See Also:

Serialized Form

Constructor Summary

NullArgumentException()
Constructs an instance with no detail message.

NullArgumentException(java.lang.String message)
Constructs an instance with a detail message.

NullArgumentException(java.lang.String message, int apiDepth)
Construct an instance with a detail message and API depth.

Method Summary

int	getApiDepth() Get the API depth of this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NullArgumentException

public NullArgumentException(java.lang.String message,
                             int apiDepth)

Construct an instance with a detail message and API depth. The API depth can be used if argument validity is checked in an internal implementation method. This specifies the stack depth of the caller of the public API entry point.

Parameters:

message - the message

apiDepth - the stack depth of the caller

NullArgumentException

public NullArgumentException(java.lang.String message)

Constructs an instance with a detail message.

Parameters:

message - the detail message

NullArgumentException

public NullArgumentException()

Constructs an instance with no detail message.

Method Detail

getApiDepth

public int getApiDepth()

Get the API depth of this exception.

Returns:

the API depth