com.cronutils.model.definition

Class CronDefinitionBuilder

java.lang.Object

com.cronutils.model.definition.CronDefinitionBuilder

public class CronDefinitionBuilder
extends Object

Builder that allows to define and create CronDefinition instances.

Method Summary

Modifier and Type	Method and Description
static CronDefinitionBuilder	defineCron() Creates a builder instance.
CronDefinition	instance() Creates a new CronDefinition instance with provided field definitions.
static CronDefinition	instanceDefinitionFor(CronType cronType) Creates CronDefinition instance matching cronType specification.
CronDefinitionBuilder	matchDayOfWeekAndDayOfMonth() Sets matchDayOfWeekAndDayOfMonth value to true.
void	register(FieldDefinition definition) Registers a certain FieldDefinition.
CronDefinitionBuilder	withCronValidation(CronConstraint validation) Adds a cron validation.
FieldSpecialCharsDefinitionBuilder	withDayOfMonth() Adds definition for day of month field.
FieldDayOfWeekDefinitionBuilder	withDayOfWeek() Adds definition for day of week field.
FieldQuestionMarkDefinitionBuilder	withDayOfYear() Adds definition for day of year field.
FieldDefinitionBuilder	withHours() Adds definition for hours field.
FieldDefinitionBuilder	withMinutes() Adds definition for minutes field.
FieldDefinitionBuilder	withMonth() Adds definition for month field.
FieldDefinitionBuilder	withSeconds() Adds definition for seconds field.
FieldDefinitionBuilder	withYear() Adds definition for year field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

defineCron

public static CronDefinitionBuilder defineCron()

Creates a builder instance.

Returns:

new CronDefinitionBuilder instance

withSeconds

public FieldDefinitionBuilder withSeconds()

Adds definition for seconds field.

Returns:

new FieldDefinitionBuilder instance

withMinutes

public FieldDefinitionBuilder withMinutes()

Adds definition for minutes field.

Returns:

new FieldDefinitionBuilder instance

withHours

public FieldDefinitionBuilder withHours()

Adds definition for hours field.

Returns:

new FieldDefinitionBuilder instance

withDayOfMonth

public FieldSpecialCharsDefinitionBuilder withDayOfMonth()

Adds definition for day of month field.

Returns:

new FieldSpecialCharsDefinitionBuilder instance

withMonth

public FieldDefinitionBuilder withMonth()

Adds definition for month field.

Returns:

new FieldDefinitionBuilder instance

withDayOfWeek

public FieldDayOfWeekDefinitionBuilder withDayOfWeek()

Adds definition for day of week field.

Returns:

new FieldSpecialCharsDefinitionBuilder instance

withYear

public FieldDefinitionBuilder withYear()

Adds definition for year field.

Returns:

new FieldDefinitionBuilder instance

withDayOfYear

public FieldQuestionMarkDefinitionBuilder withDayOfYear()

Adds definition for day of year field.

Returns:

new FieldDefinitionBuilder instance

matchDayOfWeekAndDayOfMonth

public CronDefinitionBuilder matchDayOfWeekAndDayOfMonth()

Sets matchDayOfWeekAndDayOfMonth value to true.

Returns:

this CronDefinitionBuilder instance

withCronValidation

public CronDefinitionBuilder withCronValidation(CronConstraint validation)

Adds a cron validation.

Returns:

this CronDefinitionBuilder instance

register

public void register(FieldDefinition definition)

Registers a certain FieldDefinition.

Parameters:

definition - - FieldDefinition instance, never null

instance

public CronDefinition instance()

Creates a new CronDefinition instance with provided field definitions.

Returns:

returns CronDefinition instance, never null

instanceDefinitionFor

public static CronDefinition instanceDefinitionFor(CronType cronType)

Creates CronDefinition instance matching cronType specification.

Parameters:

cronType - - some cron type. If null, a RuntimeException will be raised.

Returns:

CronDefinition instance if definition is found; a RuntimeException otherwise.