com.unboundid.ldap.sdk.persist
Class LDAPPersistException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.unboundid.util.LDAPSDKException
              extended by com.unboundid.ldap.sdk.LDAPException
                  extended by com.unboundid.ldap.sdk.persist.LDAPPersistException
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPPersistException
extends LDAPException

This class defines an exception that may be thrown if a problem occurs while attempting to perform processing related to persisting Java objects in an LDAP directory server.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.unboundid.ldap.sdk.LDAPException
NO_CONTROLS, NO_REFERRALS
 
Constructor Summary
LDAPPersistException(LDAPException e)
          Creates a new LDAP persist exception that wraps the provided LDAP exception.
LDAPPersistException(java.lang.String message)
          Creates a new LDAP persist exception with the provided message.
LDAPPersistException(java.lang.String message, java.lang.Object partiallyDecodedObject, java.lang.Throwable cause)
          Creates a new LDAP persist exception with the provided message and cause.
LDAPPersistException(java.lang.String message, java.lang.Throwable cause)
          Creates a new LDAP persist exception with the provided message and cause.
 
Method Summary
 java.lang.Object getPartiallyDecodedObject()
          Retrieves the partially-decoded object in the process of being initialized when this exception was thrown.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this exception to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPException
getDiagnosticMessage, getExceptionMessage, getMatchedDN, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl, toLDAPResult
 
Methods inherited from class com.unboundid.util.LDAPSDKException
toString
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDAPPersistException

public LDAPPersistException(LDAPException e)
Creates a new LDAP persist exception that wraps the provided LDAP exception.

Parameters:
e - The LDAP exception to wrap with this LDAP persist exception.

LDAPPersistException

public LDAPPersistException(java.lang.String message)
Creates a new LDAP persist exception with the provided message.

Parameters:
message - The message for this exception.

LDAPPersistException

public LDAPPersistException(java.lang.String message,
                            java.lang.Throwable cause)
Creates a new LDAP persist exception with the provided message and cause.

Parameters:
message - The message for this exception.
cause - The underlying cause for this exception.

LDAPPersistException

public LDAPPersistException(java.lang.String message,
                            java.lang.Object partiallyDecodedObject,
                            java.lang.Throwable cause)
Creates a new LDAP persist exception with the provided message and cause.

Parameters:
message - The message for this exception.
partiallyDecodedObject - The object that was in the process of being decoded when this exception was thrown. It may be null if the exception was thrown outside of the context of decoding an object. If an object is available, then it will likely be only partially initialized.
cause - The underlying cause for this exception.
Method Detail

getPartiallyDecodedObject

public java.lang.Object getPartiallyDecodedObject()
Retrieves the partially-decoded object in the process of being initialized when this exception was thrown.

Returns:
The partially-decoded object in the process of being initialized when this exception was thrown, or null if none is available or the exception was not thrown while decoding an object.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this exception to the provided buffer.

Overrides:
toString in class LDAPException
Parameters:
buffer - The buffer to which the string representation of this exception is to be appended.