Package org.htmlunit.javascript.background

Class BasicJavaScriptJob

java.lang.Object
org.htmlunit.javascript.background.BasicJavaScriptJob
All Implemented Interfaces:
Comparable<JavaScriptJob>, Runnable, JavaScriptJob
Direct Known Subclasses:
JavaScriptExecutionJob, JavascriptXMLHttpRequestJob, WorkerJob
public abstract class BasicJavaScriptJob extends Object implements JavaScriptJob
A JavaScript-triggered background job managed by a JavaScriptJobManager.

  • Field Details

    • id_

      private Integer id_
      The job ID.

    • initialDelay_

      private final int initialDelay_
      The initial amount of time to wait before executing this job.

    • period_

      private final Integer period_
      The amount of time to wait between executions of this job (maybe null).

    • 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 Details

    • BasicJavaScriptJob

      public BasicJavaScriptJob()
      Creates a new job instance that executes once, immediately.

    • BasicJavaScriptJob

      BasicJavaScriptJob(int initialDelay, Integer period)
      Creates a new job instance.
      Parameters:
      initialDelay - the initial amount of time to wait before executing this job
      period - the amount of time to wait between executions of this job (maybe null)

  • Method Details

    • 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.