Package com.unboundid.directory.sdk.ds.types

Class LDIFPluginResult

java.lang.Object

com.unboundid.directory.sdk.ds.types.LDIFPluginResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDIFPluginResult
extends java.lang.Object
implements java.io.Serializable

This class defines a structure which may be used to provide information about the result of the processing performed by an LDIF import or export plugin.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static LDIFPluginResult	SUCCESS	A predefined result instance that indicates all processing completed successfully.

Constructor Summary

Constructors

Constructor	Description
LDIFPluginResult(boolean continuePluginProcessing, boolean includeEntry, java.lang.CharSequence excludeReason)	Creates a new LDIF plugin result with the provided information.

Method Summary

Modifier and Type	Method	Description
boolean	continuePluginProcessing()	Indicates whether to continue processing other LDIF import or export plugins for the entry.
java.lang.String	getExcludeReason()	Retrieves a message with additional information about the reason the entry should be excluded, if applicable.
boolean	includeEntry()	Indicates whether the associated entry should be still be included in the LDIF import or export.
java.lang.String	toString()	Retrieves a string representation of this LDIF plugin result.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final LDIFPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

LDIFPluginResult

public LDIFPluginResult(boolean continuePluginProcessing,
                        boolean includeEntry,
                        java.lang.CharSequence excludeReason)

Creates a new LDIF plugin result with the provided information.

Parameters:

continuePluginProcessing - Indicates whether to continue processing other LDIF import or export plugins.

includeEntry - Indicates whether the associated entry should continue to be included in the LDIF import or export.

excludeReason - An optional message providing additional information about the reason the entry should be excluded from the import or export. It may be null if the entry should still be included.

Method Detail

continuePluginProcessing

public boolean continuePluginProcessing()

Indicates whether to continue processing other LDIF import or export plugins for the entry.

Returns:

true if the server should continue processing other LDIF import or export plugins for the entry, or false if not.

includeEntry

public boolean includeEntry()

Indicates whether the associated entry should be still be included in the LDIF import or export.

Returns:

true if the associated entry should be still be included in the LDIF import or export, or false if it should be excluded.

getExcludeReason

public java.lang.String getExcludeReason()

Retrieves a message with additional information about the reason the entry should be excluded, if applicable.

Returns:

A message with additional information about the reason the entry should be excluded, or null if none is available or the entry should be included in the import or export.

toString

public java.lang.String toString()

Retrieves a string representation of this LDIF plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this LDIF plugin result.