coldbox.system.async.tasks

Class ScheduledFuture

lucee.Component
    extended by coldbox.system.async.tasks.FutureTask
      extended by coldbox.system.async.tasks.ScheduledFuture

This is a ColdBox Scheduled Future object modeled and backed by Java's ScheduledFuture & Future interface but with Dynamic Goodness!

Class Attributes:
  • synchronized : false
    •  
  • see : https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledFuture.html
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Constructor Summary
    init([any native])
          Build the ColdBox ScheduledFuture with the Java native class.
    Method Summary
    numeric getDelay([any timeUnit='milliseconds'])
         Get the delay of the scheduled task in the given time unit.
    boolean isPeriodic()
         Returns true if the scheduled task is periodic or not.
     
    Methods inherited from class coldbox.system.async.tasks.FutureTask
    cancel, get, getNative, isCancelled, isDone, setNative
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init([any native])

    Build the ColdBox ScheduledFuture with the Java native class

    Parameters:
    native - The native ScheduledFuture class we are wrapping
    Method Detail

    getDelay

    public numeric getDelay([any timeUnit='milliseconds'])

    Get the delay of the scheduled task in the given time unit

    Parameters:
    timeUnit - The time unit to use, available units are: days, hours, microseconds, milliseconds, minutes, nanoseconds, and seconds. The default is milliseconds

    isPeriodic

    public boolean isPeriodic()

    Returns true if the scheduled task is periodic or not