com.atlassian.crowd.manager.directory

Class BulkRemoveResult<T>

java.lang.Object

com.atlassian.crowd.manager.directory.BulkRemoveResult<T>

public class BulkRemoveResult<T>
extends Object

Represents the results from a 'removeAll' operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkRemoveResult.Builder<T>

Method Summary

Modifier and Type	Method and Description
static <T> BulkRemoveResult.Builder<T>	builder(long attemptingToRemove)
long	getAttemptedToRemove()
Collection<T>	getFailedEntities() Returns the entities which failed to be removed during the bulk remove process.
Collection<T>	getMissingEntities() Returns the entities which were missing and hence which were not attempted to be removed.
long	getRemovedSuccessfully() Amount of entities successfully removed, which is calculated as the amount of entities which were attempted to be removed minus both the entities which were missing (and hence could not be removed) and the entities which failed to be removed.

Methods inherited from class java.lang.Object

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

Method Detail

getFailedEntities

public Collection<T> getFailedEntities()

Returns the entities which failed to be removed during the bulk remove process.

Returns:

failed entities.

getMissingEntities

public Collection<T> getMissingEntities()

Returns the entities which were missing and hence which were not attempted to be removed.

Returns:

missing entities.

getAttemptedToRemove

public long getAttemptedToRemove()

Returns:

the number of entities that was asked to be bulk removed.

getRemovedSuccessfully

public long getRemovedSuccessfully()

Amount of entities successfully removed, which is calculated as the amount of entities which were attempted to be removed minus both the entities which were missing (and hence could not be removed) and the entities which failed to be removed.

Returns:

attemptedToRemove - failedEntities - missingEntities

builder

public static <T> BulkRemoveResult.Builder<T> builder(long attemptingToRemove)