Package io.quarkus.scheduler.runtime

Enum SchedulerRuntimeConfig.StartMode

java.lang.Object

java.lang.Enum<SchedulerRuntimeConfig.StartMode>

io.quarkus.scheduler.runtime.SchedulerRuntimeConfig.StartMode

All Implemented Interfaces:

Serializable, Comparable<SchedulerRuntimeConfig.StartMode>

Enclosing class:

SchedulerRuntimeConfig

public static enum SchedulerRuntimeConfig.StartMode
extends Enum<SchedulerRuntimeConfig.StartMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORCED	The scheduler will be started even if no scheduled business methods are found.
HALTED	Just like the FORCED mode but the scheduler will not start triggering jobs until Scheduler.resume() is called.
NORMAL	The scheduler is not started unless a Scheduled business method is found.

Method Summary

Modifier and Type	Method	Description
static SchedulerRuntimeConfig.StartMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SchedulerRuntimeConfig.StartMode[]	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

NORMAL

public static final SchedulerRuntimeConfig.StartMode NORMAL

The scheduler is not started unless a Scheduled business method is found.

FORCED

public static final SchedulerRuntimeConfig.StartMode FORCED

The scheduler will be started even if no scheduled business methods are found.

This is necessary for "pure" programmatic scheduling.

HALTED

public static final SchedulerRuntimeConfig.StartMode HALTED

Just like the FORCED mode but the scheduler will not start triggering jobs until Scheduler.resume() is called.

This can be useful to run some intialization logic that needs to be performed before the scheduler starts.

Method Detail

values

public static SchedulerRuntimeConfig.StartMode[] 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 (SchedulerRuntimeConfig.StartMode c : SchedulerRuntimeConfig.StartMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SchedulerRuntimeConfig.StartMode 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