Top Description Fields Constructors Methods
org.apache.commons.lang3

public Class NotImplementedException

extends UnsupportedOperationException
Class Inheritance
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.

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);
  }
}
This class was originally added in Lang 2.0, but removed in 3.0.
Since
3.2

Field Summary

Modifier and TypeField and Description
private final String
code

A resource for more information regarding the lack of implementation.

private static final long
serialVersionUID

Hides java.lang.UnsupportedOperationException.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
NotImplementedException()

Constructs a NotImplementedException.

public
NotImplementedException(final String
description of the exception
message)

Constructs a NotImplementedException.

public
NotImplementedException(final String
description of the exception
message, final String
code indicating a resource for more information regarding the lack of implementation
code)

Constructs a NotImplementedException.

public
NotImplementedException(final String
description of the exception
message, final Throwable
cause of the exception
cause)

Constructs a NotImplementedException.

public
NotImplementedException(final String
description of the exception
message, final Throwable
cause of the exception
cause, final String
code indicating a resource for more information regarding the lack of implementation
code)

Constructs a NotImplementedException.

public
NotImplementedException(final Throwable
cause of the exception
cause)

Constructs a NotImplementedException.

public
NotImplementedException(final Throwable
cause of the exception
cause, final String
code indicating a resource for more information regarding the lack of implementation
code)

Constructs a NotImplementedException.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a code indicating a resource for more information regarding the lack of implementation
getCode()

Obtain the not implemented code.

Field Detail

codeback to summary
private final String code

A resource for more information regarding the lack of implementation.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.UnsupportedOperationException.serialVersionUID.

Constructor Detail

NotImplementedExceptionback to summary
public NotImplementedException()

Constructs a NotImplementedException.

Since
3.10
NotImplementedExceptionback to summary
public NotImplementedException(final String message)

Constructs a NotImplementedException.

Parameters
message:String

description of the exception

Since
3.2
NotImplementedExceptionback to summary
public NotImplementedException(final String message, final String code)

Constructs a NotImplementedException.

Parameters
message:String

description of the exception

code:String

code indicating a resource for more information regarding the lack of implementation

Since
3.2
NotImplementedExceptionback to summary
public NotImplementedException(final String message, final Throwable cause)

Constructs a NotImplementedException.

Parameters
message:String

description of the exception

cause:Throwable

cause of the exception

Since
3.2
NotImplementedExceptionback to summary
public NotImplementedException(final String message, final Throwable cause, final String code)

Constructs a NotImplementedException.

Parameters
message:String

description of the exception

cause:Throwable

cause of the exception

code:String

code indicating a resource for more information regarding the lack of implementation

Since
3.2
NotImplementedExceptionback to summary
public NotImplementedException(final Throwable cause)

Constructs a NotImplementedException.

Parameters
cause:Throwable

cause of the exception

Since
3.2
NotImplementedExceptionback to summary
public NotImplementedException(final Throwable cause, final String code)

Constructs a NotImplementedException.

Parameters
cause:Throwable

cause of the exception

code:String

code indicating a resource for more information regarding the lack of implementation

Since
3.2

Method Detail

getCodeback to summary
public String getCode()

Obtain the not implemented code. This is an unformatted piece of text intended to point to further information regarding the lack of implementation. It might, for example, be an issue tracker ID or a URL.

Returns:String

a code indicating a resource for more information regarding the lack of implementation