org.htmlunit.javascript.background

Class BasicJavaScriptJob

java.lang.Object

org.htmlunit.javascript.background.BasicJavaScriptJob

All Implemented Interfaces:

Comparable<JavaScriptJob>, Runnable, JavaScriptJob

public abstract class BasicJavaScriptJob
extends Object
implements JavaScriptJob

A JavaScript-triggered background job managed by a JavaScriptJobManager.

Author:

Daniel Gredler, Amit Manjhi

Constructor Summary

Constructors

Constructor and Description
BasicJavaScriptJob() Creates a new job instance that executes once, immediately.

Method Summary

Modifier and Type	Method and Description
int	compareTo(JavaScriptJob other)
Integer	getId() Returns the job ID.
int	getInitialDelay() Returns the initial amount of time to wait before executing this job.
Integer	getPeriod() Returns the amount of time to wait between executions of this job (maybe null).
long	getTargetExecutionTime() Returns the target execution time of the job.
boolean	isExecuteAsap() Returns true if this job has to be executed asap.
boolean	isPeriodic() Returns true if this job executes periodically.
void	setId(Integer id) Sets the job ID.
void	setTargetExecutionTime(long targetExecutionTime) Sets the target execution time of the job.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

BasicJavaScriptJob

public BasicJavaScriptJob()

Creates a new job instance that executes once, immediately.

Method Detail

setId

public void setId(Integer id)

Sets the job ID.

Specified by:

setId in interface JavaScriptJob

Parameters:

id - the job ID

getId

public Integer getId()

Returns the job ID.

Specified by:

getId in interface JavaScriptJob

Returns:

the job ID

getInitialDelay

public int getInitialDelay()

Returns the initial amount of time to wait before executing this job.

Returns:

the initial amount of time to wait before executing this job

getPeriod

public Integer getPeriod()

Returns the amount of time to wait between executions of this job (maybe null).

Specified by:

getPeriod in interface JavaScriptJob

Returns:

the amount of time to wait between executions of this job (maybe null)

isPeriodic

public boolean isPeriodic()

Returns true if this job executes periodically.

Specified by:

isPeriodic in interface JavaScriptJob

Returns:

true if this job executes periodically

isExecuteAsap

public boolean isExecuteAsap()

Returns true if this job has to be executed asap.

Specified by:

isExecuteAsap in interface JavaScriptJob

Returns:

true if this job has to be executed asap

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(JavaScriptJob other)

Specified by:

compareTo in interface Comparable<JavaScriptJob>

getTargetExecutionTime

public long getTargetExecutionTime()

Returns the target execution time of the job.

Specified by:

getTargetExecutionTime in interface JavaScriptJob

Returns:

the target execution time in ms

setTargetExecutionTime

public void setTargetExecutionTime(long targetExecutionTime)

Sets the target execution time of the job.

Specified by:

setTargetExecutionTime in interface JavaScriptJob

Parameters:

targetExecutionTime - the new target execution time.