com.unboundid.ldap.sdk.unboundidds.logs
Class LogException

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.unboundidds.logs.LogException
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LogException
extends LDAPSDKException

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines an exception that may be thrown if a problem occurs while attempting to parse a log message.

See Also:
Serialized Form

Constructor Summary
LogException(java.lang.String logMessage, java.lang.String explanation)
          Creates a new log exception with the provided information.
LogException(java.lang.String logMessage, java.lang.String explanation, java.lang.Throwable cause)
          Creates a new log exception with the provided information.
 
Method Summary
 java.lang.String getLogMessage()
          Retrieves the malformed log message string that triggered this exception.
 
Methods inherited from class com.unboundid.util.LDAPSDKException
getExceptionMessage, toString, 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

LogException

public LogException(java.lang.String logMessage,
                    java.lang.String explanation)
Creates a new log exception with the provided information.

Parameters:
logMessage - The malformed log message string that triggered this exception. It must not be null.
explanation - A message explaining the problem that occurred. It must not be null.

LogException

public LogException(java.lang.String logMessage,
                    java.lang.String explanation,
                    java.lang.Throwable cause)
Creates a new log exception with the provided information.

Parameters:
logMessage - The malformed log message string that triggered this exception. It must not be null.
explanation - A message explaining the problem that occurred. It must not be null.
cause - An underlying exception that triggered this exception.
Method Detail

getLogMessage

public java.lang.String getLogMessage()
Retrieves the malformed log message string that triggered this exception.

Returns:
The malformed log message string that triggered this exception.