org.opends.server.util

Class LDIFException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opends.server.types.OpenDsException

org.opends.server.types.IdentifiedException

org.opends.server.util.LDIFException

All Implemented Interfaces:

Serializable, LocalizableException

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class LDIFException
extends IdentifiedException

This class defines an exception that may be thrown while attempting to parse LDIF content.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDIFException(LocalizableMessage message) Creates a new LDIF exception with the provided information.
LDIFException(LocalizableMessage message, Number lineNumber, boolean canContinueReading) Creates a new LDIF exception with the provided information.
LDIFException(LocalizableMessage message, Number lineNumber, boolean canContinueReading, Throwable cause) Creates a new configuration exception with the provided message and underlying cause.
LDIFException(LocalizableMessage message, Throwable cause) Creates a new LDIF exception with the provided information.

Method Summary

Modifier and Type	Method and Description
boolean	canContinueReading() Indicates whether the nature of this exception allows the caller to continue reading LDIF data.
long	getLineNumber() Retrieves the line number of the last line read from the LDIF source.

Methods inherited from class org.opends.server.types.OpenDsException

getMessageObject

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

Constructor Detail

LDIFException

public LDIFException(LocalizableMessage message)

Creates a new LDIF exception with the provided information.

Parameters:

message - The message to use for this LDIF exception.

LDIFException

public LDIFException(LocalizableMessage message,
                     Throwable cause)

Creates a new LDIF exception with the provided information.

Parameters:

message - The message to use for this LDIF exception.

cause - The underlying cause that triggered this LDIF exception.

LDIFException

public LDIFException(LocalizableMessage message,
                     Number lineNumber,
                     boolean canContinueReading)

Creates a new LDIF exception with the provided information.

Parameters:

message - The message to use for this LDIF exception.

lineNumber - The line number of the last line read from the LDIF source.

canContinueReading - Indicates whether it is possible to continue reading from the LDIF input source.

LDIFException

public LDIFException(LocalizableMessage message,
                     Number lineNumber,
                     boolean canContinueReading,
                     Throwable cause)

Creates a new configuration exception with the provided message and underlying cause.

Parameters:

message - The message to use for this LDIF exception.

canContinueReading - Indicates whether it is possible to continue reading from the LDIF input source.

lineNumber - The line number of the last line read from the LDIF source.

cause - The underlying cause that triggered this LDIF exception.

Method Detail

getLineNumber

public long getLineNumber()

Retrieves the line number of the last line read from the LDIF source.

Returns:

The line number of the last line read from the LDIF source.

canContinueReading

public boolean canContinueReading()

Indicates whether the nature of this exception allows the caller to continue reading LDIF data. If this method returns false, then the associated reader should be closed by the caller.

Returns:

true if the problem was with a single entry but it is possible to continue reading with the next entry, or false if the problem was such that it is no longer possible to continue reading the data.