org.docascode.api.event

Class ProgressEvent

java.lang.Object

java.util.EventObject

org.docascode.api.event.Event

org.docascode.api.event.ProgressEvent

All Implemented Interfaces:

Serializable

public class ProgressEvent
extends Event

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.docascode.api.event.Event

Event.Level

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(Object source) Constructs a prototypical Event.

Method Summary

Modifier and Type	Method and Description
int	getProgress()
int	getTotal()
ProgressEvent	setProgress(int progress)
ProgressEvent	setTotal(int total)

Methods inherited from class org.docascode.api.event.Event

getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressEvent

public ProgressEvent(Object source)

Constructs a prototypical Event.

Parameters:

source - The object on which the Event initially occurred.

Throws:

IllegalArgumentException - if source is null.

Method Detail

setProgress

public ProgressEvent setProgress(int progress)

getProgress

public int getProgress()

setTotal

public ProgressEvent setTotal(int total)

getTotal

public int getTotal()