@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFPluginResult extends java.lang.Object implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static LDIFPluginResult |
SUCCESS
A predefined result instance that indicates all processing completed
successfully.
|
Constructor and Description |
---|
LDIFPluginResult(boolean continuePluginProcessing,
boolean includeEntry,
java.lang.CharSequence excludeReason)
Creates a new LDIF plugin result with the provided information.
|
Modifier and Type | Method and 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.
|
public static final LDIFPluginResult SUCCESS
public LDIFPluginResult(boolean continuePluginProcessing, boolean includeEntry, java.lang.CharSequence excludeReason)
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.public boolean continuePluginProcessing()
true
if the server should continue processing other LDIF
import or export plugins for the entry, or false
if not.public boolean includeEntry()
true
if the associated entry should be still be included
in the LDIF import or export, or false
if it should be
excluded.public java.lang.String getExcludeReason()
null
if none is available or the
entry should be included in the import or export.public java.lang.String toString()
toString
in class java.lang.Object