Components.Timer

java.lang.Object

org.jgrapes.core.Components.Timer

Enclosing class:: Components

public static class Components.Timer extends Object

Represents a timer as created by Components.schedule(TimeoutHandler, Instant).

Method Summary

Modifier and Type

Method

Description

void

cancel()

Cancels this timer.

void

reschedule(Duration scheduledFor)

Reschedules the timer for the given duration after now.

void

reschedule(Instant scheduledFor)

Reschedules the timer for the given instant.

Instant

scheduledFor()

Returns the instant that this handler is scheduled for.

Components.TimeoutHandler

timeoutHandler()

Returns the timeout handler of this timer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- reschedule
  
  public void reschedule(Instant scheduledFor)
  
  Reschedules the timer for the given instant.
  
  Parameters:
  
  scheduledFor - the instant
- reschedule
  
  public void reschedule(Duration scheduledFor)
  
  Reschedules the timer for the given duration after now.
  
  Parameters:
  
  scheduledFor - the timeout
- timeoutHandler
  
  public Components.TimeoutHandler timeoutHandler()
  
  Returns the timeout handler of this timer.
  
  Returns:
  
  the handler
- scheduledFor
  
  public Instant scheduledFor()
  
  Returns the instant that this handler is scheduled for.
  
  Returns:
  
  the instant or null if the timer has been cancelled.
- cancel
  
  public void cancel()
  
  Cancels this timer.