Package com.unboundid.ldif

Class LDIFException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.unboundid.util.LDAPSDKException
com.unboundid.ldif.LDIFException
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFException extends LDAPSDKException
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.
See Also:

  • Constructor Details

    • LDIFException

      public LDIFException(@NotNull String message, long lineNumber, boolean mayContinueReading)
      Creates a new LDIF exception with the provided information.
      Parameters:
      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.

    • LDIFException

      public LDIFException(@NotNull String message, long lineNumber, boolean mayContinueReading, @Nullable Throwable cause)
      Creates a new LDIF exception with the provided information.
      Parameters:
      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.

    • LDIFException

      public LDIFException(@NotNull String message, long lineNumber, boolean mayContinueReading, @Nullable CharSequence[] dataLines, @Nullable Throwable cause)
      Creates a new LDIF exception with the provided information.
      Parameters:
      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.

    • LDIFException

      public LDIFException(@NotNull String message, long lineNumber, boolean mayContinueReading, @Nullable List<? extends CharSequence> dataLines, @Nullable Throwable cause)
      Creates a new LDIF exception with the provided information.
      Parameters:
      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 Details

    • getLineNumber

      public long getLineNumber()
      Retrieves the line number on which the problem occurred.
      Returns:
      The line number on which the problem occurred.

    • mayContinueReading

      public boolean mayContinueReading()
      Indicates whether it is possible to continue attempting to read from the LDIF source.
      Returns:
      true if it is possible to continue attempting to read from the LDIF source, or false if it is not possible to continue.

    • getDataLines

      @Nullable public List<String> getDataLines()
      Retrieves the lines comprising the data that could not be parsed as valid LDIF, if available.
      Returns:
      An unmodifiable list of the lines comprising the data that could not be parsed as valid LDIF, or null if that is not available.

    • toString

      public void toString(@NotNull 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.

    • toString

      public void toString(@NotNull StringBuilder buffer, boolean includeCause, boolean includeStackTrace)
      Appends a string representation of this LDIFException to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended. This must not be null.
      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. If a stack trace is included, then the cause (if any) will automatically be included, regardless of the value of the includeCause argument.

    • getExceptionMessage

      @NotNull public String getExceptionMessage()
      Retrieves a string representation of this exception suitable for use in messages.
      Overrides:
      getExceptionMessage in class LDAPSDKException
      Returns:
      A string representation of this exception suitable for use in messages.

    • getExceptionMessage

      @NotNull public String getExceptionMessage(boolean includeCause, boolean includeStackTrace)
      Retrieves a string representation of this exception suitable for use in messages.
      Overrides:
      getExceptionMessage in class LDAPSDKException
      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.