act.handler.builtin.controller

Class ControllerProgressGauge

java.lang.Object

act.util.DestroyableBase

act.util.SimpleProgressGauge

act.handler.builtin.controller.ControllerProgressGauge

All Implemented Interfaces:

Destroyable, ProgressGauge

public class ControllerProgressGauge
extends SimpleProgressGauge

Used for track async request handler method progress

Nested Class Summary

Nested classes/interfaces inherited from interface act.util.ProgressGauge

ProgressGauge.Listener

Nested classes/interfaces inherited from interface act.Destroyable

Destroyable.Util

Field Summary

Fields inherited from class act.util.SimpleProgressGauge

currentSteps, delegate, error, maxHint, NULL

Fields inherited from interface act.util.ProgressGauge

PAYLOAD_MESSAGE

Constructor Summary

Constructors

Constructor and Description
ControllerProgressGauge()

Method Summary

Modifier and Type	Method and Description
void	commitFinalState()
void	fail(String error) Mark the progress has failed with an error message
void	stepBy(int steps) Advances the progress by specified steps
void	stepTo(int steps) Log progress

Methods inherited from class act.util.SimpleProgressGauge

addListener, clearPayload, currentProgressPercent, currentSteps, error, getCurrentSteps, getId, getMaxHint, getPayload, getProgressPercent, incrMaxHint, incrMaxHintBy, isDone, isFailed, markAsDone, maxHint, releaseResources, setId, setPayload, step, triggerUpdateEvent, triggerUpdateEvent, updateMaxHint, wrap, wsJobProgressTag

Methods inherited from class act.util.DestroyableBase

addSubResource, destroy, isDestroyed, reload, scope

Methods inherited from class java.lang.Object

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

Methods inherited from interface act.Destroyable

destroy, isDestroyed, scope

Constructor Detail

ControllerProgressGauge

public ControllerProgressGauge()

Method Detail

fail

public void fail(String error)

Description copied from interface: ProgressGauge

Mark the progress has failed with an error message

Specified by:

fail in interface ProgressGauge

Overrides:

fail in class SimpleProgressGauge

Parameters:

error - the error message

stepBy

public void stepBy(int steps)

Description copied from interface: ProgressGauge

Advances the progress by specified steps

Specified by:

stepBy in interface ProgressGauge

Overrides:

stepBy in class SimpleProgressGauge

Parameters:

steps - the step size

stepTo

public void stepTo(int steps)

Description copied from interface: ProgressGauge

Log progress

Specified by:

stepTo in interface ProgressGauge

Overrides:

stepTo in class SimpleProgressGauge

Parameters:

steps - the new progress value

commitFinalState

public void commitFinalState()