org.opends.server.util.cli
Class CLIException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.opends.server.types.OpenDsException
              org.opends.server.types.IdentifiedException
                  org.opends.server.util.cli.CLIException

All Implemented Interfaces:

java.io.Serializable

public class CLIException
extends IdentifiedException

Thrown to indicate that a problem occurred when interacting with the client. For example, if input provided by the client was invalid.

See Also:

Serialized Form

Constructor Summary

CLIException(Message message)
Creates a new CLI exception with the provided message.

CLIException(Message message, java.lang.Throwable cause)
Creates a new CLI exception with the provided message and cause.

Method Summary

static CLIException

adaptInputException(java.lang.Throwable cause) Adapts any exception that may have occurred whilst reading input from the console.

Methods inherited from class org.opends.server.types.OpenDsException

getMessageObject

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

CLIException

public CLIException(Message message)

Creates a new CLI exception with the provided message.

Parameters:

message - The message explaining the problem that occurred.

CLIException

public CLIException(Message message,
                    java.lang.Throwable cause)

Creates a new CLI exception with the provided message and cause.

Parameters:

message - The message explaining the problem that occurred.

cause - The cause of this exception.

Method Detail

adaptInputException

public static CLIException adaptInputException(java.lang.Throwable cause)

Adapts any exception that may have occurred whilst reading input from the console.

Parameters:

cause - The exception that occurred whilst reading input from the console.

Returns:

Returns a new CLI exception describing a problem that occurred whilst reading input from the console.