|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.types.LDIFPluginResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFPluginResult
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.
Field Summary | |
---|---|
static LDIFPluginResult |
SUCCESS
A predefined result instance that indicates all processing completed successfully. |
Constructor Summary | |
---|---|
LDIFPluginResult(boolean continuePluginProcessing,
boolean includeEntry,
java.lang.CharSequence excludeReason)
Creates a new LDIF plugin result with the provided information. |
Method Summary | |
---|---|
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 |
---|
public static final LDIFPluginResult SUCCESS
Constructor Detail |
---|
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.Method Detail |
---|
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |