Schedule (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.jobs.Schedule

```
public class Schedule
extends Object
```
A data structure representing the schedule for a recurring task, with helper methods to find the next recurring time.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Schedule.NextDateTimeFinder
Helper class to actually do the work of finding the next run time.

Nested Classes
Modifier and Type	Class and Description
`class`	`Schedule.NextDateTimeFinder` Helper class to actually do the work of finding the next run time.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FRIDAY`
`static int`	`MONDAY`
`static int`	`SATURDAY`
`static int`	`SUNDAY`
`static int`	`THURSDAY`
`static int`	`TUESDAY`
`static int`	`WEDNESDAY`

Constructor Summary

Constructors
Constructor and Description

Schedule()

Constructors
Constructor and Description
`Schedule()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Schedule`	`daily()` Get a schedule instance that will run every night, at some random minute during the 5AM hour
`Schedule`	`daysBiweekly(Long startingAt, DayOfWeek... days)` Runs the given days of the week, every other week.
`Schedule`	`daysOfMonth(Integer... daysOfMonth)` Set the days of the month on which the schedule is to run.
`Schedule`	`daysOfWeek(DayOfWeek... days)` Set the days of the week on which the task is to run.
`Schedule`	`daysOfWeekMonth(DayOfWeek dayOfWeek, Integer... weeksOfMonth)` Set the day of the week and which weeks of the month combination the schedule is to match.
`Schedule`	`everyDay()` Set the task to run every single day
`Schedule`	`everyHour()` Set the task to run each hour of the day
`Schedule`	`everyMinute()` Set the schedule to run every minute
`Schedule`	`everyMonth()` Runs every month
`ZoneId`	`getZoneId()`
`static Schedule`	`hourly()` Run at the top of every hour
`Schedule`	`hours(Integer... hours)` Set which hours of the day the task should run at
`boolean`	`matchesDateTime(ZonedDateTime dt)` Returns true if this schedule matches the passed in datetime
`Schedule`	`minutes(Integer... minutes)` Set which minutes of the hour the task will run at
`Schedule`	`months(Integer... months)` Set to runs on the given month(s)
`ZonedDateTime`	`nextAt()` Gets the next datetime matching the schedule, in the Users timezone
`ZonedDateTime`	`nextAt(ZonedDateTime startingFrom)` Gets the next datetime matching the schedule, passing in the current date from which to look.
`static Schedule`	`paydays()` Get a schedule instance that will run on at 5AM UTC on the second and fourth Friday, every month
`Schedule`	`randomMinute()` Set the schedule to run on a random minute every hour
`ZonedDateTime`	`serverLocalNextAt()` Gets the next datetime matching the schedule, in the application timezone, as defined in the settings
`Schedule`	`timezone(String timeZoneId)`
`ZonedDateTime`	`utcNextAt()` Gets the next datetime matching the schedule, in UTC
`Schedule`	`verify()` Verify that this is a valid schedule.

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

- Field Detail
  - MONDAY
```
public static final int MONDAY
```
    See Also:
    
    Constant Field Values
  - TUESDAY
```
public static final int TUESDAY
```
    See Also:
    
    Constant Field Values
  - WEDNESDAY
```
public static final int WEDNESDAY
```
    See Also:
    
    Constant Field Values
  - THURSDAY
```
public static final int THURSDAY
```
    See Also:
    
    Constant Field Values
  - FRIDAY
```
public static final int FRIDAY
```
    See Also:
    
    Constant Field Values
  - SATURDAY
```
public static final int SATURDAY
```
    See Also:
    
    Constant Field Values
  - SUNDAY
```
public static final int SUNDAY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Schedule
```
public Schedule()
```
- Method Detail
  - nextAt
```
public ZonedDateTime nextAt()
```
    Gets the next datetime matching the schedule, in the Users timezone
    
    Returns:
  - getZoneId
```
public ZoneId getZoneId()
```
  - utcNextAt
```
public ZonedDateTime utcNextAt()
```
    Gets the next datetime matching the schedule, in UTC
    
    Returns:
  - serverLocalNextAt
```
public ZonedDateTime serverLocalNextAt()
```
    Gets the next datetime matching the schedule, in the application timezone, as defined in the settings
    
    Returns:
  - nextAt
```
public ZonedDateTime nextAt(ZonedDateTime startingFrom)
```
    Gets the next datetime matching the schedule, passing in the current date from which to look. Used for testing.
    
    Parameters:
    
    startingFrom -
    
    Returns:
  - matchesDateTime
```
public boolean matchesDateTime(ZonedDateTime dt)
```
    Returns true if this schedule matches the passed in datetime
    
    Parameters:
    
    dt -
    
    Returns:
  - daily
```
public static Schedule daily()
```
    Get a schedule instance that will run every night, at some random minute during the 5AM hour
    
    Returns:
  - hourly
```
public static Schedule hourly()
```
    Run at the top of every hour
    
    Returns:
  - paydays
```
public static Schedule paydays()
```
    Get a schedule instance that will run on at 5AM UTC on the second and fourth Friday, every month
  - minutes
```
public Schedule minutes(Integer... minutes)
```
    Set which minutes of the hour the task will run at
    
    Parameters:
    
    minutes -
    
    Returns:
  - everyMinute
```
public Schedule everyMinute()
```
    Set the schedule to run every minute
    
    Returns:
  - randomMinute
```
public Schedule randomMinute()
```
    Set the schedule to run on a random minute every hour
    
    Returns:
  - hours
```
public Schedule hours(Integer... hours)
```
    Set which hours of the day the task should run at
    
    Parameters:
    
    hours -
    
    Returns:
  - everyHour
```
public Schedule everyHour()
```
    Set the task to run each hour of the day
    
    Returns:
  - everyDay
```
public Schedule everyDay()
```
    Set the task to run every single day
    
    Returns:
  - daysOfMonth
```
public Schedule daysOfMonth(Integer... daysOfMonth)
```
    Set the days of the month on which the schedule is to run.
    
    Parameters:
    
    daysOfMonth -
    
    Returns:
  - daysOfWeek
```
public Schedule daysOfWeek(DayOfWeek... days)
```
    Set the days of the week on which the task is to run.
    
    Parameters:
    
    days -
    
    Returns:
  - daysOfWeekMonth
```
public Schedule daysOfWeekMonth(DayOfWeek dayOfWeek,
                                Integer... weeksOfMonth)
```
    Set the day of the week and which weeks of the month combination the schedule is to match.
    
    Parameters:
    
    dayOfWeek -
    
    weeksOfMonth -
    
    Returns:
  - daysBiweekly
```
public Schedule daysBiweekly(Long startingAt,
                             DayOfWeek... days)
```
    Runs the given days of the week, every other week.
    
    Parameters:
    
    startingAt -
    
    days -
    
    Returns:
  - everyMonth
```
public Schedule everyMonth()
```
    Runs every month
    
    Returns:
  - months
```
public Schedule months(Integer... months)
```
    Set to runs on the given month(s)
    
    Parameters:
    
    months -
    
    Returns:
  - verify
```
public Schedule verify()
                throws ConfigException
```
    Verify that this is a valid schedule.
    
    Returns:
    
    Throws:
    
    ConfigException
  - timezone
```
public Schedule timezone(String timeZoneId)
```

Class Schedule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Constructor Detail

Schedule

Method Detail

nextAt

getZoneId

utcNextAt

serverLocalNextAt

nextAt

matchesDateTime

daily

hourly

paydays

minutes

everyMinute

randomMinute

hours

everyHour

everyDay

daysOfMonth

daysOfWeek

daysOfWeekMonth

daysBiweekly

everyMonth

months

verify

timezone