Package org.forgerock.opendj.ldap

Class DecodeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.forgerock.opendj.ldap.DecodeException

All Implemented Interfaces:

Serializable, LocalizableException

public final class DecodeException
extends IOException
implements LocalizableException

Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way. By default decoding exceptions are fatal, indicating that the associated input source is no longer usable.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static DecodeException	error(Throwable cause)	Creates a new non-fatal decode exception with the provided root cause.
static DecodeException	error(LocalizableMessage message)	Creates a new non-fatal decode exception with the provided message.
static DecodeException	error(LocalizableMessage message, Throwable cause)	Creates a new non-fatal decode exception with the provided message and root cause.
static DecodeException	fatalError(Throwable cause)	Creates a new fatal decode exception with the provided root cause.
static DecodeException	fatalError(LocalizableMessage message)	Creates a new fatal decode exception with the provided message.
static DecodeException	fatalError(LocalizableMessage message, Throwable cause)	Creates a new fatal decode exception with the provided message and root cause.
LocalizableMessage	getMessageObject()	Returns the localizable message that explains the problem that occurred.
boolean	isFatal()	Indicates whether the error was fatal and the associated input source can no longer be used.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

error

public static DecodeException error(LocalizableMessage message)

Creates a new non-fatal decode exception with the provided message.

Parameters:

message - The message that explains the problem that occurred.

Returns:

The new non-fatal decode exception.

error

public static DecodeException error(Throwable cause)

Creates a new non-fatal decode exception with the provided root cause.

Parameters:

cause - The underlying cause of this exception.

Returns:

The new non-fatal decode exception.

error

public static DecodeException error(LocalizableMessage message,
 Throwable cause)

Creates a new non-fatal decode exception with the provided message and root cause.

Parameters:

message - The message that explains the problem that occurred.

cause - The underlying cause of this exception.

Returns:

The new non-fatal decode exception.

fatalError

public static DecodeException fatalError(LocalizableMessage message)

Creates a new fatal decode exception with the provided message. The associated input source can no longer be used.

Parameters:

message - The message that explains the problem that occurred.

Returns:

The new fatal decode exception.

fatalError

public static DecodeException fatalError(Throwable cause)

Creates a new fatal decode exception with the provided root cause. The associated input source can no longer be used.

Parameters:

cause - The underlying cause of this exception.

Returns:

The new fatal decode exception.

fatalError

public static DecodeException fatalError(LocalizableMessage message,
 Throwable cause)

Creates a new fatal decode exception with the provided message and root cause. The associated input source can no longer be used.

Parameters:

message - The message that explains the problem that occurred.

cause - The underlying cause of this exception.

Returns:

The new fatal decode exception.

getMessageObject

public LocalizableMessage getMessageObject()

Description copied from interface: LocalizableException

Returns the localizable message that explains the problem that occurred.

Specified by:

getMessageObject in interface LocalizableException

Returns:

The localizable message that explains the problem that occurred.

isFatal

public boolean isFatal()

Indicates whether the error was fatal and the associated input source can no longer be used.

Returns:

true if the error was fatal and the associated input source can no longer be used, otherwise false .