com.unboundid.util

Class LDAPSDKException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.unboundid.util.LDAPSDKException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ArgumentException, ASN1Exception, AuditLogException, CertException, ChangeLogEntryAttributeExceededMaxValuesException, EntrySourceException, JSONException, LDAPException, LDIFException, LogException, LogSyntaxException, TaskException

@NotExtensible
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public abstract class LDAPSDKException
extends java.lang.Exception

This class serves as the base class for all custom checked exception types defined in the LDAP SDK.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LDAPSDKException(java.lang.String message) Creates a new instance of this exception with the provided message.
protected	LDAPSDKException(java.lang.String message, java.lang.Throwable cause) Creates a new instance of this exception with the provided message and cause.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getExceptionMessage() Retrieves a string representation of this exception suitable for use in messages.
java.lang.String	getExceptionMessage(boolean includeCause, boolean includeStackTrace) Retrieves a string representation of this exception suitable for use in messages.
java.lang.String	toString() Retrieves a string representation of this exception.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this exception to the provided buffer.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSDKException

protected LDAPSDKException(@NotNull
                java.lang.String message)

Creates a new instance of this exception with the provided message.

Parameters:

message - The message to use for this exception.

LDAPSDKException

protected LDAPSDKException(@NotNull
                java.lang.String message,
                @Nullable
                java.lang.Throwable cause)

Creates a new instance of this exception with the provided message and cause.

Parameters:

message - The message to use for this exception.

cause - The underlying cause for this exception. It may be null if no cause is available.

Method Detail

toString

@NotNull
public final java.lang.String toString()

Retrieves a string representation of this exception.

Overrides:

toString in class java.lang.Throwable

Returns:

A string representation of this exception.

toString

public void toString(@NotNull
            java.lang.StringBuilder buffer)

Appends a string representation of this exception to the provided buffer.

Parameters:

buffer - The buffer to which the string representation of this exception is to be appended.

getExceptionMessage

@NotNull
public java.lang.String getExceptionMessage()

Retrieves a string representation of this exception suitable for use in messages.

Returns:

A string representation of this exception suitable for use in messages.

getExceptionMessage

@NotNull
public java.lang.String getExceptionMessage(boolean includeCause,
                                           boolean includeStackTrace)

Retrieves a string representation of this exception suitable for use in messages.

Parameters:

includeCause - Indicates whether to include information about the cause (if any) in the exception message.

includeStackTrace - Indicates whether to include a condensed representation of the stack trace in the exception message.

Returns:

A string representation of this exception suitable for use in messages.