org.jenkinsci.plugins.lucene.search.databackend

Class Progress

java.lang.Object

org.jenkinsci.plugins.lucene.search.databackend.Progress

Direct Known Subclasses:

ManagerProgress

public class Progress
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Progress.ProgressState

Field Summary

Fields

Modifier and Type	Field and Description
protected long	startTime

Constructor Summary

Constructors

Constructor and Description
Progress()
Progress(String name)

Method Summary

Modifier and Type	Method and Description
void	assertNoErrors()
void	completedWithErrors(Exception reason)
int	getCurrent()
long	getElapsedTime()
int	getMax()
String	getName()
Throwable	getReason()
String	getReasonMessage()
Progress.ProgressState	getState()
void	incCurrent()
boolean	isFinished()
void	setCurrent(int current)
void	setElapsedTime(long elapsedTime)
void	setFinished() Work complete.
void	setMax(int max)
void	setName(String name)
void	setReasonMessage(String reasonMessage)
void	setSuccessfullyCompleted() Work has been successfully completed.
void	withReason(Exception reason)

Methods inherited from class java.lang.Object

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

Field Detail

startTime

protected long startTime

Constructor Detail

Progress

public Progress()

Progress

public Progress(String name)

Method Detail

assertNoErrors

public void assertNoErrors()
                    throws Exception

Throws:

Exception

completedWithErrors

public void completedWithErrors(Exception reason)

setFinished

public void setFinished()

Work complete. Does NOT imply success, only that no more processing will be done

setSuccessfullyCompleted

public void setSuccessfullyCompleted()

Work has been successfully completed. Current will be one less than max.

getState

public Progress.ProgressState getState()

isFinished

public boolean isFinished()

getReason

public Throwable getReason()

getMax

public int getMax()

setMax

public void setMax(int max)

getCurrent

public int getCurrent()

setCurrent

public void setCurrent(int current)

incCurrent

public void incCurrent()

getName

public String getName()

setName

public void setName(String name)

getElapsedTime

public long getElapsedTime()

setElapsedTime

public void setElapsedTime(long elapsedTime)

withReason

public void withReason(Exception reason)

getReasonMessage

public String getReasonMessage()

setReasonMessage

public void setReasonMessage(String reasonMessage)