org.apache.commons.lang: public class: NotImplementedException

org.apache.commons.lang
public class: NotImplementedException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         java.lang.RuntimeException
            java.lang.UnsupportedOperationException
               org.apache.commons.lang.NotImplementedException

All Implemented Interfaces:
Nestable, Serializable

Thrown to indicate that a block of code has not been implemented. This exception supplements UnsupportedOperationException by providing a more semantically rich description of the problem.

NotImplementedException represents the case where the author has yet to implement the logic at this point in the program. This can act as an exception based TODO tag. Because this logic might be within a catch block, this exception suports exception chaining.

public void foo() {
try {
// do something that throws an Exception
} catch (Exception ex) {
// don't know what to do here yet
throw new NotImplementedException("TODO", ex);
}
}

author: Matthew - Hawthorne

author: Stephen - Colebourne

since: 2.0 -

version: $ - Id: NotImplementedException.java 437554 2006-08-28 06:21:41Z bayard $

Constructor:

Constructor:
public NotImplementedException() { //----------------------------------------------------------------------- super(DEFAULT_MESSAGE); } Constructs a new `NotImplementedException` with default message. since: `2.1` -
public NotImplementedException(String msg) { super(msg == null ? DEFAULT_MESSAGE : msg); } Constructs a new `NotImplementedException` with specified detail message. Parameters: `msg` - the error message.
public NotImplementedException(Throwable cause) { super(DEFAULT_MESSAGE); this.cause = cause; } Constructs a new `NotImplementedException` with specified nested `Throwable` and default message. Parameters: `cause` - the exception that caused this exception to be thrown since: `2.1` -
public NotImplementedException(Class clazz) { super(clazz == null ? DEFAULT_MESSAGE : DEFAULT_MESSAGE + " in " + clazz); } Constructs a new `NotImplementedException` referencing the specified class. Parameters: `clazz` - the `Class` that has not implemented the method
public NotImplementedException(String msg, Throwable cause) { super(msg == null ? DEFAULT_MESSAGE : msg); this.cause = cause; } Constructs a new `NotImplementedException` with specified detail message and nested `Throwable`. Parameters: `msg` - the error message `cause` - the exception that caused this exception to be thrown since: `2.1` -

 public NotImplementedException() {
    //-----------------------------------------------------------------------
        super(DEFAULT_MESSAGE);
}

Constructs a new NotImplementedException with default message.

since: 2.1 -

 public NotImplementedException(String msg) {
        super(msg == null ? DEFAULT_MESSAGE : msg);
}

NotImplementedException

Parameters:

msg - the error message.

 public NotImplementedException(Throwable cause) {
        super(DEFAULT_MESSAGE);
        this.cause = cause;
}

NotImplementedException

Throwable

Parameters:

cause - the exception that caused this exception to be thrown

since: 2.1 -

 public NotImplementedException(Class clazz) {
        super(clazz == null ? DEFAULT_MESSAGE : DEFAULT_MESSAGE + " in " + clazz);
}

NotImplementedException

Parameters:

clazz - the Class that has not implemented the method

 public NotImplementedException(String msg,
    Throwable cause) {
        super(msg == null ? DEFAULT_MESSAGE : msg);
        this.cause = cause;
}

NotImplementedException

Throwable

Parameters:

msg - the error message

cause - the exception that caused this exception to be thrown

since: 2.1 -

Method from org.apache.commons.lang.NotImplementedException Summary:
getCause, getMessage, getMessage, getMessages, getThrowable, getThrowableCount, getThrowables, indexOfThrowable, indexOfThrowable, printPartialStackTrace, printStackTrace, printStackTrace, printStackTrace

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

Method from org.apache.commons.lang.NotImplementedException Detail:
public Throwable getCause() { return cause; } Gets the root cause of this exception.
public String getMessage() { if (super.getMessage() != null) { return super.getMessage(); } else if (cause != null) { return cause.toString(); } else { return null; } } Gets the combined the error message of this and any nested errors.
public String getMessage(int index) { if (index == 0) { return super.getMessage(); } return delegate.getMessage(index); } Returns the error message of the `Throwable` in the chain of `Throwable`s at the specified index, numbered from 0.
public String[] getMessages() { return delegate.getMessages(); } Returns the error message of this and any nested `Throwable` objects. Each throwable returns a message, a null string is included in the array if there is no message for a particular `Throwable`.
public Throwable getThrowable(int index) { return delegate.getThrowable(index); } Returns the `Throwable` in the chain by index.
public int getThrowableCount() { return delegate.getThrowableCount(); } Returns the number of nested `Throwable`s represented by this `Nestable`, including this `Nestable`.
public Throwable[] getThrowables() { return delegate.getThrowables(); } Returns this `Nestable` and any nested `Throwable`s in an array of `Throwable`s, one element for each `Throwable`.
public int indexOfThrowable(Class type) { return delegate.indexOfThrowable(type, 0); } Returns the index of the first occurrence of the specified type. If there is no match, `-1` is returned.
public int indexOfThrowable(Class type, int fromIndex) { return delegate.indexOfThrowable(type, fromIndex); } Returns the index of the first occurrence of the specified type starting from the specified index. If there is no match, `-1` is returned.
public final void printPartialStackTrace(PrintWriter out) { super.printStackTrace(out); } Prints the stack trace for this exception only (root cause not included) using the specified writer.
public void printStackTrace() { delegate.printStackTrace(); } Prints the stack trace of this exception. Includes information from the exception, if any, which caused this exception.
public void printStackTrace(PrintStream out) { delegate.printStackTrace(out); } Prints the stack trace of this exception to the specified stream. Includes information from the exception, if any, which caused this exception.
public void printStackTrace(PrintWriter out) { delegate.printStackTrace(out); } Prints the stack trace of this exception to the specified writer. Includes information from the exception, if any, which caused this exception.

Method from org.apache.commons.lang.NotImplementedException Detail:

 public Throwable getCause() {
        return cause;
}

Gets the root cause of this exception.

 public String getMessage() {
        if (super.getMessage() != null) {
            return super.getMessage();
        } else if (cause != null) {
            return cause.toString();
        } else {
            return null;
        }
}

Gets the combined the error message of this and any nested errors.

 public String getMessage(int index) {
        if (index == 0) {
            return super.getMessage();
        }
        return delegate.getMessage(index);
}

Throwable

 public String[] getMessages() {
        return delegate.getMessages();
}

Throwable

 public Throwable getThrowable(int index) {
        return delegate.getThrowable(index);
}

Throwable

 public int getThrowableCount() {
        return delegate.getThrowableCount();
}

Throwable

Nestable

 public Throwable[] getThrowables() {
        return delegate.getThrowables();
}

Nestable

Throwable

 public int indexOfThrowable(Class type) {
        return delegate.indexOfThrowable(type, 0);
}

-1

 public int indexOfThrowable(Class type,
    int fromIndex) {
        return delegate.indexOfThrowable(type, fromIndex);
}

-1

 public final  void printPartialStackTrace(PrintWriter out) {
        super.printStackTrace(out);
}

Prints the stack trace for this exception only (root cause not included) using the specified writer.

 public  void printStackTrace() {
        delegate.printStackTrace();
}

Prints the stack trace of this exception. Includes information from the exception, if any, which caused this exception.

 public  void printStackTrace(PrintStream out) {
        delegate.printStackTrace(out);
}

Prints the stack trace of this exception to the specified stream. Includes information from the exception, if any, which caused this exception.

 public  void printStackTrace(PrintWriter out) {
        delegate.printStackTrace(out);
}

Prints the stack trace of this exception to the specified writer. Includes information from the exception, if any, which caused this exception.