Class BasicJavaScriptJob
- java.lang.Object
-
- org.htmlunit.javascript.background.BasicJavaScriptJob
-
- All Implemented Interfaces:
java.lang.Comparable<JavaScriptJob>
,java.lang.Runnable
,JavaScriptJob
- Direct Known Subclasses:
JavaScriptExecutionJob
,JavascriptXMLHttpRequestJob
,WorkerJob
public abstract class BasicJavaScriptJob extends java.lang.Object implements JavaScriptJob
A JavaScript-triggered background job managed by aJavaScriptJobManager
.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
executeAsap_
private java.lang.Integer
id_
The job ID.private int
initialDelay_
The initial amount of time to wait before executing this job.private java.lang.Integer
period_
The amount of time to wait between executions of this job (maybenull
).private long
targetExecutionTime_
The time at which this job should be executed.
-
Constructor Summary
Constructors Constructor Description BasicJavaScriptJob()
Creates a new job instance that executes once, immediately.BasicJavaScriptJob(int initialDelay, java.lang.Integer period)
Creates a new job instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(JavaScriptJob other)
java.lang.Integer
getId()
Returns the job ID.int
getInitialDelay()
Returns the initial amount of time to wait before executing this job.java.lang.Integer
getPeriod()
Returns the amount of time to wait between executions of this job (maybenull
).long
getTargetExecutionTime()
Returns the target execution time of the job.boolean
isExecuteAsap()
Returnstrue
if this job has to be executed asap.boolean
isPeriodic()
Returnstrue
if this job executes periodically.void
setId(java.lang.Integer id)
Sets the job ID.void
setTargetExecutionTime(long targetExecutionTime)
Sets the target execution time of the job.java.lang.String
toString()
-
-
-
Field Detail
-
id_
private java.lang.Integer id_
The job ID.
-
initialDelay_
private final int initialDelay_
The initial amount of time to wait before executing this job.
-
period_
private final java.lang.Integer period_
The amount of time to wait between executions of this job (maybenull
).
-
executeAsap_
private final boolean executeAsap_
-
targetExecutionTime_
private long targetExecutionTime_
The time at which this job should be executed. Note: the browser will make its best effort to execute the job at the target time, as specified by the timeout/interval. However, depending on other scheduled jobs, this target time may not be the actual time at which the job is executed.
-
-
Constructor Detail
-
BasicJavaScriptJob
public BasicJavaScriptJob()
Creates a new job instance that executes once, immediately.
-
BasicJavaScriptJob
BasicJavaScriptJob(int initialDelay, java.lang.Integer period)
Creates a new job instance.- Parameters:
initialDelay
- the initial amount of time to wait before executing this jobperiod
- the amount of time to wait between executions of this job (maybenull
)
-
-
Method Detail
-
setId
public void setId(java.lang.Integer id)
Sets the job ID.- Specified by:
setId
in interfaceJavaScriptJob
- Parameters:
id
- the job ID
-
getId
public java.lang.Integer getId()
Returns the job ID.- Specified by:
getId
in interfaceJavaScriptJob
- 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 java.lang.Integer getPeriod()
Returns the amount of time to wait between executions of this job (maybenull
).- Specified by:
getPeriod
in interfaceJavaScriptJob
- Returns:
- the amount of time to wait between executions of this job (maybe
null
)
-
isPeriodic
public boolean isPeriodic()
Returnstrue
if this job executes periodically.- Specified by:
isPeriodic
in interfaceJavaScriptJob
- Returns:
true
if this job executes periodically
-
isExecuteAsap
public boolean isExecuteAsap()
Returnstrue
if this job has to be executed asap.- Specified by:
isExecuteAsap
in interfaceJavaScriptJob
- Returns:
true
if this job has to be executed asap
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(JavaScriptJob other)
- Specified by:
compareTo
in interfacejava.lang.Comparable<JavaScriptJob>
-
getTargetExecutionTime
public long getTargetExecutionTime()
Returns the target execution time of the job.- Specified by:
getTargetExecutionTime
in interfaceJavaScriptJob
- 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 interfaceJavaScriptJob
- Parameters:
targetExecutionTime
- the new target execution time.
-
-