com.netflix.spectator.impl

Enum Scheduler.Policy

java.lang.Object

java.lang.Enum<Scheduler.Policy>

com.netflix.spectator.impl.Scheduler.Policy

All Implemented Interfaces:

Serializable, Comparable<Scheduler.Policy>

Enclosing class:

Scheduler

public static enum Scheduler.Policy
extends Enum<Scheduler.Policy>

Repetition schedulingPolicy for scheduled tasks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED_DELAY Run a task repeatedly using a fixed delay between executions.
FIXED_RATE_SKIP_IF_LONG Run a task repeatedly attempting to maintain a consistent rate of execution.
RUN_ONCE Run a task once.

Method Summary

Modifier and Type	Method and Description
static Scheduler.Policy	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scheduler.Policy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RUN_ONCE

public static final Scheduler.Policy RUN_ONCE

Run a task once.

FIXED_DELAY

public static final Scheduler.Policy FIXED_DELAY

Run a task repeatedly using a fixed delay between executions.

FIXED_RATE_SKIP_IF_LONG

public static final Scheduler.Policy FIXED_RATE_SKIP_IF_LONG

Run a task repeatedly attempting to maintain a consistent rate of execution. If the execution time is less than the desired frequencyMillis, then the start times will be at a consistent interval. If the execution time exceeds the frequencyMillis, then some executions will be skipped. The primary use case for this mode is when we want to maintain a consistent frequencyMillis, but want to avoid queuing up many tasks if the system cannot keep up. Fixed delay is often inappropriate because for the normal case it will drift by the execution time of the task.

Method Detail

values

public static Scheduler.Policy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Scheduler.Policy c : Scheduler.Policy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Scheduler.Policy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null