Package io.fluxcapacitor.javaclient.scheduling

Annotation Type Periodic

@Documented @Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited public @interface Periodic
Annotation placed on the payload class of a Schedule handled by HandleSchedule annotated methods. If this annotation is present the same payload will be rescheduled after handling using a given delay in ms.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    long
    value
    Returns the schedule delay in milliseconds.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoStart
    Returns true if this periodic schedule should be automatically started if it's not already active.
    boolean
    continueOnError
    Returns true if the schedule should continue after an error.
    long
    initialDelay
    Returns the initial schedule delay in milliseconds.
    String
    scheduleId
    Returns the id of the periodic schedule.

  • Element Details

    • value

      long value
      Returns the schedule delay in milliseconds. Must be positive.

    • autoStart

      boolean autoStart
      Returns true if this periodic schedule should be automatically started if it's not already active. Defaults to true.
      Default:
      true

    • initialDelay

      long initialDelay
      Returns the initial schedule delay in milliseconds. Only relevant when autoStart() is true.
      Default:
      0L

    • continueOnError

      boolean continueOnError
      Returns true if the schedule should continue after an error. Defaults to true.
      Default:
      true

    • scheduleId

      String scheduleId
      Returns the id of the periodic schedule. Defaults to the fully qualified name of the schedule class.
      Default:
      ""