Package org.jivesoftware.openfire.pubsub

Class PubSubSubscriptionMaintenance.Progress

java.lang.Object

org.jivesoftware.openfire.pubsub.PubSubSubscriptionMaintenance.Progress

Enclosing class:

PubSubSubscriptionMaintenance

public static final class PubSubSubscriptionMaintenance.Progress
extends Object

Immutable snapshot of cleanup progress. New instances are published atomically as the cleanup proceeds.

Method Summary

Modifier and Type	Method	Description
String	getError()
int	getPercentComplete()
PubSubSubscriptionMaintenance.Phase	getPhase()
long	getRemoved()
long	getTotalToRemove()

Methods inherited from class java.lang.Object

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

Method Details

getPhase

public PubSubSubscriptionMaintenance.Phase getPhase()

Returns:

the current phase of the cleanup.

getTotalToRemove

public long getTotalToRemove()

Returns:

the number of rows the cleanup set out to remove (0 until known).

getRemoved

public long getRemoved()

Returns:

the number of rows removed so far (or in total, when completed).

getPercentComplete

public int getPercentComplete()

Returns:

completion as a percentage in [0, 100]. Returns 100 for a completed cleanup, and 0 when the total is not yet known.

getError

@Nullable
public String getError()

Returns:

the error message if the cleanup failed, otherwise null.