com.unboundid.util

Class LDAPSDKUsageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.unboundid.util.LDAPSDKRuntimeException

com.unboundid.util.LDAPSDKUsageException

All Implemented Interfaces:

java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPSDKUsageException
extends LDAPSDKRuntimeException

This class provides a runtime exception that may be thrown by the LDAP SDK if it detects a problem with the usage of the SDK itself (e.g., a null value provided for an argument that must not be null, or an argument value that violates a documented constraint).

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this exception to the provided buffer.

Methods inherited from class com.unboundid.util.LDAPSDKRuntimeException

getExceptionMessage, getExceptionMessage, toString

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

LDAPSDKUsageException

public LDAPSDKUsageException(@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.

LDAPSDKUsageException

public LDAPSDKUsageException(@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

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

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

Overrides:

toString in class LDAPSDKRuntimeException

Parameters:

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