com.unboundid.ldap.sdk
Class EntrySourceException

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.EntrySourceException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
SearchResultReferenceEntrySourceException

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class EntrySourceException
extends LDAPSDKException

This class defines an exception that may be thrown if a problem occurs while trying to access an entry in an entry source (e.g., because the entry source is no longer available, because an entry could not be parsed, or because the next element returned was a search result reference rather than a search result entry).

See Also:
Serialized Form

Constructor Summary
EntrySourceException(boolean mayContinueReading, java.lang.String message, java.lang.Throwable cause)
          Creates a new entry source exception with the provided information.
EntrySourceException(boolean mayContinueReading, java.lang.Throwable cause)
          Creates a new entry source exception with the provided information.
 
Method Summary
 boolean mayContinueReading()
          Indicates whether it is possible to continue attempting to iterate through subsequent entries in the entry source.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this exception to the provided buffer.
 
Methods inherited from class com.unboundid.util.LDAPSDKException
getExceptionMessage, 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

EntrySourceException

public EntrySourceException(boolean mayContinueReading,
                            java.lang.Throwable cause)
Creates a new entry source exception with the provided information.

Parameters:
mayContinueReading - Indicates whether it is possible to continue attempting to iterate through subsequent entries in the entry source.
cause - The underlying exception that triggered this exception. It must not be null.

EntrySourceException

public EntrySourceException(boolean mayContinueReading,
                            java.lang.String message,
                            java.lang.Throwable cause)
Creates a new entry source exception with the provided information.

Parameters:
mayContinueReading - Indicates whether it is possible to continue attempting to iterate through subsequent entries in the entry source.
message - A message explaining the problem that occurred. It must not be null.
cause - The underlying exception that triggered this exception. It must not be null.
Method Detail

mayContinueReading

public final boolean mayContinueReading()
Indicates whether it is possible to continue attempting to iterate through subsequent entries in the entry source.

Returns:
true if it is possible to continue attempting to read from the entry source, or false if it is not possible to continue.

toString

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

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