QuartzSchedulerHelper (ph-schedule 5.0.0 API)

java.lang.Object
- com.helger.schedule.quartz.QuartzSchedulerHelper

@Immutable
public final class QuartzSchedulerHelper
extends Object

Misc utility methods around Quartz schedulers

Author:: Philip Helger

Field Summary

Fields
Modifier and Type Field Description

static boolean DEFAULT_START_AUTOMATICALLY

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static com.helger.quartz.IScheduler`	`getScheduler()`
`static com.helger.quartz.IScheduler`	`getScheduler(boolean bStartAutomatically)`	Get the underlying Quartz scheduler
`static com.helger.quartz.ISchedulerFactory`	`getSchedulerFactory()`
`static com.helger.quartz.SchedulerMetaData`	`getSchedulerMetaData()`	Get the metadata of the scheduler.
`static ESchedulerState`	`getSchedulerState()`

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

- Field Detail
  - DEFAULT_START_AUTOMATICALLY
```
public static final boolean DEFAULT_START_AUTOMATICALLY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getSchedulerFactory
```
@Nonnull
public static com.helger.quartz.ISchedulerFactory getSchedulerFactory()
```
    Returns:
    
    The global scheduler factory that is used. Never null.
    
    Since:
    
    1.8.2
  - getScheduler
```
@Nonnull
public static com.helger.quartz.IScheduler getScheduler()
```
    Returns:
    
    The single IScheduler instance that is ensured to be started. Never null.
    
    See Also:
    
    getScheduler(boolean)
  - getScheduler
```
@Nonnull
public static com.helger.quartz.IScheduler getScheduler(boolean bStartAutomatically)
```
    Get the underlying Quartz scheduler
    
    Parameters:
    
    bStartAutomatically - If true the returned scheduler is automatically started. If false the state is not changed.
    
    Returns:
    
    The underlying Quartz scheduler. Never null.
  - getSchedulerMetaData
```
@Nonnull
public static com.helger.quartz.SchedulerMetaData getSchedulerMetaData()
```
    Get the metadata of the scheduler. The state of the scheduler is not changed within this method.
    
    Returns:
    
    The metadata of the underlying scheduler.
  - getSchedulerState
```
@Nonnull
public static ESchedulerState getSchedulerState()
```
    Returns:
    
    The state of the scheduler. Never null.