Package com.unboundid.util

Class SubtreeDeleterResult

java.lang.Object
com.unboundid.util.SubtreeDeleterResult
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SubtreeDeleterResult extends Object implements Serializable
This class provides a data structure with information about the results of a subtree delete attempt.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    completelySuccessful()
    Indicates whether the SubtreeDeleter processing was completely successful.
    SortedMap<DN,LDAPResult>
    getDeleteErrors()
    Retrieves an unmodifiable sorted map of the DNs of entries that could not be successfully deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure.
    SortedMap<DN,LDAPResult>
    getDeleteErrorsDescendingMap()
    Retrieves an unmodifiable sorted map of the DNs of entries that could not be successfully deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure.
    long
    getEntriesDeleted()
    Retrieves the number of entries that were successfully deleted.
    SearchResult
    getSearchError()
    Retrieves a search result with information about an error that occurred during search processing that prevented identifying all of the entries in the target subtree.
    LDAPResult
    getSetSubtreeAccessibilityError()
    Retrieves an LDAPResult that provides information about an error that occurred while trying to make the target subtree inaccessible before subtree delete processing, or if an error occurred while trying to remove the subtree accessibility restriction after all other processing had completed successfully.
    boolean
    subtreeInaccessible()
    Indicates whether the target subtree was left in an inaccessible state after some error occurred during subtree delete processing.
    String
    toString()
    Retrieves a string representation of this subtree deleter result.
    void
    toString(StringBuilder buffer)
    Appends a string representation of this subtree deleter result to the provided buffer.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • completelySuccessful

      public boolean completelySuccessful()
      Indicates whether the SubtreeDeleter processing was completely successful.
      Returns:
      true if the subtree deleter processing was completely successful, or false if not.

    • getSetSubtreeAccessibilityError

      @Nullable public LDAPResult getSetSubtreeAccessibilityError()
      Retrieves an LDAPResult that provides information about an error that occurred while trying to make the target subtree inaccessible before subtree delete processing, or if an error occurred while trying to remove the subtree accessibility restriction after all other processing had completed successfully. This may be null if no attempts was made to alter the subtree accessibility, or if no error occurred during processing.

      If the return value is non-null and subtreeInaccessible returns false, then the error occurred while attempting to make the target subtree inaccessible. If the return value is non-null and isSubtreeInaccessible returns true, then the error occurred while attempting to remove the subtree accessibility restriction.
      Returns:
      An LDAPResult that provides information about an error that occurred while attempting to alter the accessibility of the target subtree, or null if no such error occurred.

    • subtreeInaccessible

      public boolean subtreeInaccessible()
      Indicates whether the target subtree was left in an inaccessible state after some error occurred during subtree delete processing.
      Returns:
      true if the subtree was set inaccessible at the start of subtree delete processing and remains inaccessible after an error occurred during processing, or false if the subtree accessibility was not altered or if the accessibility restriction was removed after all processing completed successfully.

    • getSearchError

      @Nullable public SearchResult getSearchError()
      Retrieves a search result with information about an error that occurred during search processing that prevented identifying all of the entries in the target subtree.
      Returns:
      A search result with information about an error that occurred during search processing that prevented identifying all of the entries in the target subtree, or null if no error occurred during search processing.

    • getEntriesDeleted

      public long getEntriesDeleted()
      Retrieves the number of entries that were successfully deleted.
      Returns:
      The number of entries that were successfully deleted.

    • getDeleteErrors

      @NotNull public SortedMap<DN,LDAPResult> getDeleteErrors()
      Retrieves an unmodifiable sorted map of the DNs of entries that could not be successfully deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure. The map will be ordered in ascending order using the comparator provided by the DN class (that is, with ancestor entries before their descendants).
      Returns:
      An unmodifiable sorted map of the DNs of the entries that could not be deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure.

    • getDeleteErrorsDescendingMap

      @NotNull public SortedMap<DN,LDAPResult> getDeleteErrorsDescendingMap()
      Retrieves an unmodifiable sorted map of the DNs of entries that could not be successfully deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure. The map will be ordered in descending order using the comparator provided by the DN class (that is, with descendant entries before their ancestors).
      Returns:
      An unmodifiable sorted map of the DNs of the entries that could not be deleted, each of which is associated with an LDAPResult indicating the reason for the delete failure.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this subtree deleter result.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this subtree deleter result.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this subtree deleter result to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation should be appended.