com.norconex.jef4.status

Class MutableJobStatus

java.lang.Object

com.norconex.jef4.status.MutableJobStatus

All Implemented Interfaces:

IJobStatus

public class MutableJobStatus
extends Object
implements IJobStatus

Constructor Summary

Constructors

Constructor and Description
MutableJobStatus(String jobId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
JobDuration	getDuration()
String	getJobId()
Date	getLastActivity() Gets the last activity.
String	getNote()
double	getProgress()
com.norconex.commons.lang.map.Properties	getProperties()
int	getResumeAttempts()
JobState	getState() Gets the job execution state.
int	hashCode()
void	incrementResumeAttempts()
boolean	isAborted() Checks whether the job was aborted or not (i.e.
boolean	isCompleted() Checks whether the job execution has completed.
boolean	isPrematurlyEnded() Checks whether the job ended before its time.
boolean	isResumed() Whether this status resumed from a previously failed or stopped job.
boolean	isRunning() Checks whether the job execution represented by this progress is still running.
boolean	isStarted() Checks whether the job was started or not.
boolean	isState(JobState... states) Checks whether the current progress status matches any of the supplied statuses.
boolean	isStopped()
boolean	isStopping()
boolean	isStopRequested()
void	setDuration(JobDuration duration)
void	setLastActivity(Date lastActivity) Sets the last activity.
void	setNote(String note)
void	setProgress(double progress)
void	setResumeAttempts(int resumeAttempts)
void	setStopRequested(boolean stopRequested)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MutableJobStatus

public MutableJobStatus(String jobId)

Method Detail

getJobId

public String getJobId()

Specified by:

getJobId in interface IJobStatus

getState

public JobState getState()

Gets the job execution state.

Specified by:

getState in interface IJobStatus

Returns:

execution state

isStopped

public boolean isStopped()

Specified by:

isStopped in interface IJobStatus

isStopping

public boolean isStopping()

Specified by:

isStopping in interface IJobStatus

isStopRequested

public boolean isStopRequested()

setStopRequested

public void setStopRequested(boolean stopRequested)

isResumed

public boolean isResumed()

Whether this status resumed from a previously failed or stopped job.

Specified by:

isResumed in interface IJobStatus

Returns:

true if the current job was resumed

Since:

1.1.1

isStarted

public boolean isStarted()

Checks whether the job was started or not. This is not an indication that a job is currently running.

Specified by:

isStarted in interface IJobStatus

Returns:

true if job was started

isPrematurlyEnded

public boolean isPrematurlyEnded()

Checks whether the job ended before its time. This may or may not be the result of an error. Prematurely ended jobs are eligible for resuming.

Specified by:

isPrematurlyEnded in interface IJobStatus

Returns:

true if job finished

isCompleted

public boolean isCompleted()

Checks whether the job execution has completed.

Specified by:

isCompleted in interface IJobStatus

Returns:

true if the job execution is complete

isAborted

public boolean isAborted()

Checks whether the job was aborted or not (i.e. killed). That is, if the job started and is no longer running, while it never marked as finished. Remember that under normal conditions, a job should always finish, whether it failed or not. An aborted progress is usually the results of a job suite which got "killed" in the middle of its execution (not having the chance to return properly).

Specified by:

isAborted in interface IJobStatus

Returns:

true if job was started

Since:

1.1

isRunning

public boolean isRunning()

Checks whether the job execution represented by this progress is still running.

Specified by:

isRunning in interface IJobStatus

Returns:

true if still running

isState

public boolean isState(JobState... states)

Checks whether the current progress status matches any of the supplied statuses.

Specified by:

isState in interface IJobStatus

Parameters:

states - one or more states to match

Returns:

true if progress status matches supplied statuses

Since:

2.0

getProgress

public double getProgress()

Specified by:

getProgress in interface IJobStatus

getNote

public String getNote()

Specified by:

getNote in interface IJobStatus

getDuration

public JobDuration getDuration()

Specified by:

getDuration in interface IJobStatus

getProperties

public com.norconex.commons.lang.map.Properties getProperties()

Specified by:

getProperties in interface IJobStatus

setProgress

public void setProgress(double progress)

setNote

public void setNote(String note)

setDuration

public void setDuration(JobDuration duration)

getLastActivity

public Date getLastActivity()

Gets the last activity.

Specified by:

getLastActivity in interface IJobStatus

Returns:

last activity

setLastActivity

public void setLastActivity(Date lastActivity)

Sets the last activity.

Parameters:

lastActivity - last activity

getResumeAttempts

public int getResumeAttempts()

Specified by:

getResumeAttempts in interface IJobStatus

setResumeAttempts

public void setResumeAttempts(int resumeAttempts)

incrementResumeAttempts

public void incrementResumeAttempts()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object