org.researchstack.backbone.task

Class Task.TaskProgress

java.lang.Object

org.researchstack.backbone.task.Task.TaskProgress

Enclosing class:

Task

public static class Task.TaskProgress
extends java.lang.Object

A structure that represents how far a task has progressed.

Objects that extend Task return the task progress structure to indicate to the ViewTaskActivity how far the task has progressed.

Note that the values in an Task.TaskProgress structure are used only for display; you don't use the values to access the steps in a task.

Constructor Summary

Constructors

Constructor and Description
TaskProgress(int current, int total) Constructor specifying current index and total number of steps in the task.

Method Summary

Modifier and Type	Method and Description
int	getCurrent() Gets the current step number in the task, zero-based.
int	getTotal() Gets the current total number of steps in the task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskProgress

public TaskProgress(int current,
                    int total)

Constructor specifying current index and total number of steps in the task.

Parameters:

current - current step number, zero-based

total - number of steps in the task

Method Detail

getCurrent

public int getCurrent()

Gets the current step number in the task, zero-based.

Returns:

current step number

getTotal

public int getTotal()

Gets the current total number of steps in the task.

Returns:

the total number of steps