|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.unboundid.util.LDAPSDKException
com.unboundid.ldif.LDIFException
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFException
This class defines an exception that may be thrown if a problem occurs while attempting to decode data read from an LDIF source. It has a flag to indicate whether it is possible to try to continue reading additional information from the LDIF source, and also the approximate line number on which the problem was encountered.
Constructor Summary | |
---|---|
LDIFException(java.lang.String message,
long lineNumber,
boolean mayContinueReading)
Creates a new LDIF exception with the provided information. |
|
LDIFException(java.lang.String message,
long lineNumber,
boolean mayContinueReading,
java.lang.CharSequence[] dataLines,
java.lang.Throwable cause)
Creates a new LDIF exception with the provided information. |
|
LDIFException(java.lang.String message,
long lineNumber,
boolean mayContinueReading,
java.util.List<? extends java.lang.CharSequence> dataLines,
java.lang.Throwable cause)
Creates a new LDIF exception with the provided information. |
|
LDIFException(java.lang.String message,
long lineNumber,
boolean mayContinueReading,
java.lang.Throwable cause)
Creates a new LDIF exception with the provided information. |
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getDataLines()
Retrieves the lines comprising the data that could not be parsed as valid LDIF, if available. |
java.lang.String |
getExceptionMessage()
Retrieves a string representation of this exception suitable for use in messages. |
long |
getLineNumber()
Retrieves the line number on which the problem occurred. |
boolean |
mayContinueReading()
Indicates whether it is possible to continue attempting to read from the LDIF 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 |
---|
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 |
---|
public LDIFException(java.lang.String message, long lineNumber, boolean mayContinueReading)
message
- A message explaining the problem that occurred.
It must not be null
.lineNumber
- The line number in the LDIF source on which the
problem occurred.mayContinueReading
- Indicates whether it is possible to continue
attempting to read from the LDIF source.public LDIFException(java.lang.String message, long lineNumber, boolean mayContinueReading, java.lang.Throwable cause)
message
- A message explaining the problem that occurred.
It must not be null
.lineNumber
- The line number in the LDIF source on which the
problem occurred.mayContinueReading
- Indicates whether it is possible to continue
attempting to read from the LDIF source.cause
- The underlying exception that triggered this
exception.public LDIFException(java.lang.String message, long lineNumber, boolean mayContinueReading, java.lang.CharSequence[] dataLines, java.lang.Throwable cause)
message
- A message explaining the problem that occurred.
It must not be null
.lineNumber
- The line number in the LDIF source on which the
problem occurred.mayContinueReading
- Indicates whether it is possible to continue
attempting to read from the LDIF source.dataLines
- The lines that comprise the data that could not
be parsed as valid LDIF. It may be
null
if this is not available.cause
- The underlying exception that triggered this
exception.public LDIFException(java.lang.String message, long lineNumber, boolean mayContinueReading, java.util.List<? extends java.lang.CharSequence> dataLines, java.lang.Throwable cause)
message
- A message explaining the problem that occurred.
It must not be null
.lineNumber
- The line number in the LDIF source on which the
problem occurred.mayContinueReading
- Indicates whether it is possible to continue
attempting to read from the LDIF source.dataLines
- The lines that comprise the data that could not
be parsed as valid LDIF. It may be
null
if this is not available.cause
- The underlying exception that triggered this
exception.Method Detail |
---|
public long getLineNumber()
public boolean mayContinueReading()
true
if it is possible to continue attempting to read from
the LDIF source, or false
if it is not possible to
continue.public java.util.List<java.lang.String> getDataLines()
null
if that is not
available.public void toString(java.lang.StringBuilder buffer)
toString
in class LDAPSDKException
buffer
- The buffer to which the string representation of this
exception is to be appended.public java.lang.String getExceptionMessage()
getExceptionMessage
in class LDAPSDKException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |