net.proteusframework.core.progress

Class Progress<V>

java.lang.Object

net.proteusframework.core.progress.Progress<V>

Type Parameters:

V - the value type.

public class Progress<V>
extends Object

Represents progress made by a task.

Author:

Russ Tennant (russ@i2rd.com)

Constructor Summary

Constructors

Constructor and Description
Progress(V value, V target) Create a new Progress.

Method Summary

Modifier and Type	Method and Description
Class<V>	getProgressType() Get the progress type.
V	getTarget() Get the target.
V	getValue() Get the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Progress

public Progress(@Nonnull
                V value,
                @Nonnull
                V target)

Create a new Progress.

Parameters:

value - the current value. For example, this could be the current number of bytes that have been processed.

target - the target value. For example, this could be the total number of bytes being processed.

Method Detail

getProgressType

public Class<V> getProgressType()

Get the progress type.

Returns:

the progress type.

getTarget

@Nonnull
public V getTarget()

Get the target. For example, this could be the total number of bytes being processed.

Returns:

the target.

getValue

@Nonnull
public V getValue()

Get the value. For example, this could be the current number of bytes that have been processed.

Returns:

the value.