org.opends.admin.ads
Class ADSContextException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
              extended by org.opends.admin.ads.ADSContextException
All Implemented Interfaces:
java.io.Serializable

public class ADSContextException
extends OpenDsException

This is the exception that is thrown in ADSContext.

See Also:
ADSContext, Serialized Form

Nested Class Summary
static class ADSContextException.ErrorType
          The enumeration containing the different error types.
 
Constructor Summary
ADSContextException(ADSContextException.ErrorType error)
          Creates an ADSContextException of the given error type.
ADSContextException(ADSContextException.ErrorType error, java.lang.Throwable x)
          Creates an ADSContextException of the given error type with the provided error cause.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the throwable that caused this exception.
 ADSContextException.ErrorType getError()
          Returns the error type of this exception.
 Message getReason()
          Retrieves a message providing the reason for this exception.
 void printStackTrace()
          
 
Methods inherited from class org.opends.server.types.OpenDsException
getMessageObject
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ADSContextException

public ADSContextException(ADSContextException.ErrorType error)
Creates an ADSContextException of the given error type.

Parameters:
error - the error type.

ADSContextException

public ADSContextException(ADSContextException.ErrorType error,
                           java.lang.Throwable x)
Creates an ADSContextException of the given error type with the provided error cause.

Parameters:
error - the error type.
x - the throwable that generated this exception.
Method Detail

getError

public ADSContextException.ErrorType getError()
Returns the error type of this exception.

Returns:
the error type of this exception.

getCause

public java.lang.Throwable getCause()
Returns the throwable that caused this exception. It might be null.

Overrides:
getCause in class java.lang.Throwable
Returns:
the throwable that caused this exception.

getReason

public Message getReason()
Retrieves a message providing the reason for this exception.

Returns:
A message providing the reason for this exception.

printStackTrace

public void printStackTrace()

Overrides:
printStackTrace in class java.lang.Throwable