org.rvpf.base.sync

Class Crontab

Object

Crontab

@Immutable
public final class Crontab
extends Object

Crontab.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Crontab.BadItemException Bad item exception.

Method Summary

Modifier and Type	Method and Description
DateTime	change(DateTime dateTime, ZoneId zoneId, boolean forward) Changes to the next (or previous) time.
boolean	equals(Object other)
boolean[]	getDays() Gets the days.
boolean[]	getDaysOfWeek() Gets the days of week.
String	getEntry() Gets the entry.
boolean[]	getHours() Gets the hours.
boolean[]	getMinutes() Gets the minutes.
boolean[]	getMonths() Gets the months.
int	hashCode()
boolean	isInSchedule(DateTime dateTime, ZoneId zoneId) Asks if the date-time is in schedule.
static Crontab	parse(String entry) Parses a crontab entry.
static Crontab	readExternal(ObjectInput input) Reads in an external representation of a crontab.
String	toString()
static void	writeExternal(Crontab crontab, ObjectOutput output) Writes out an external representation of a crontab.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

parse

@Nonnull
 @CheckReturnValue
public static Crontab parse(@Nonnull
                                                          String entry)
                                                   throws Crontab.BadItemException

Parses a crontab entry.

Parameters:

entry - The crontab entry.

Returns:

A filled crontab object.

Throws:

Crontab.BadItemException - When there is a bad item in the entry.

readExternal

@Nonnull
 @CheckReturnValue
public static Crontab readExternal(@Nonnull
                                                                 ObjectInput input)
                                                          throws IOException

Reads in an external representation of a crontab.

This is a helper method for Externalizable objects containing a Crontab.

Parameters:

input - The external representation.

Returns:

The crontab.

Throws:

IOException - When an I/O error occurs.

writeExternal

public static void writeExternal(@Nonnull
                                 Crontab crontab,
                                 @Nonnull
                                 ObjectOutput output)
                          throws IOException

Writes out an external representation of a crontab.

This is a helper method for Externalizable objects containing a crontab.

Parameters:

crontab - The crontab.

output - The external representation.

Throws:

IOException - When an I/O error occurs.

change

public DateTime change(@Nonnull
                       DateTime dateTime,
                       @Nonnull
                       ZoneId zoneId,
                       boolean forward)

Changes to the next (or previous) time.

Parameters:

dateTime - The current date-time.

zoneId - The zone id.

forward - True for next (otherwise previous).

Returns:

The new date-time.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getDays

@Nonnull
 @CheckReturnValue
public boolean[] getDays()

Gets the days.

Returns:

The days.

getDaysOfWeek

@Nonnull
 @CheckReturnValue
public boolean[] getDaysOfWeek()

Gets the days of week.

Returns:

The days of week.

getEntry

@Nonnull
 @CheckReturnValue
public String getEntry()

Gets the entry.

Returns:

The entry.

getHours

@Nonnull
 @CheckReturnValue
public boolean[] getHours()

Gets the hours.

Returns:

The hours.

getMinutes

@Nonnull
 @CheckReturnValue
public boolean[] getMinutes()

Gets the minutes.

Returns:

The minutes.

getMonths

@Nonnull
 @CheckReturnValue
public boolean[] getMonths()

Gets the months.

Returns:

The months.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInSchedule

@CheckReturnValue
public boolean isInSchedule(@Nonnull
                                               DateTime dateTime,
                                               @Nonnull
                                               ZoneId zoneId)

Asks if the date-time is in schedule.

Parameters:

dateTime - The current date-time.

zoneId - The zone id.

Returns:

True if the date-time is in schedule.

toString

public String toString()

Overrides:

toString in class Object