Package io.github.projectunified.cronutils.model.field.definition

Class FieldDefinitionBuilder

java.lang.Object

io.github.projectunified.cronutils.model.field.definition.FieldDefinitionBuilder

Direct Known Subclasses:

FieldQuestionMarkDefinitionBuilder

public class FieldDefinitionBuilder
extends Object

Provides means to define cron field definitions.

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldConstraintsBuilder	constraints
protected CronDefinitionBuilder	cronDefinitionBuilder
protected final CronFieldName	fieldName
protected boolean	optional

Constructor Summary

Constructors

Constructor	Description
FieldDefinitionBuilder(CronDefinitionBuilder cronDefinitionBuilder, CronFieldName fieldName)	Constructor.

Method Summary

Modifier and Type	Method	Description
CronDefinitionBuilder	and()	Registers CronField in ParserDefinitionBuilder and returns its instance.
FieldDefinitionBuilder	optional()	Allows to tag a field as optional.
FieldDefinitionBuilder	withIntMapping(int source, int dest)	Provides means to define int values mappings between equivalent values.
FieldDefinitionBuilder	withStrictRange()	Specifies that defined range for given field must be a strict range.
FieldDefinitionBuilder	withValidRange(int startRange, int endRange)	Allows to set a range of valid values for field.

Methods inherited from class java.lang.Object

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

Field Details

cronDefinitionBuilder

protected CronDefinitionBuilder cronDefinitionBuilder

fieldName

protected final CronFieldName fieldName

constraints

protected FieldConstraintsBuilder constraints

optional

protected boolean optional

Constructor Details

FieldDefinitionBuilder

public FieldDefinitionBuilder(CronDefinitionBuilder cronDefinitionBuilder,
 CronFieldName fieldName)

Constructor.

Parameters:

cronDefinitionBuilder - - ParserDefinitionBuilder instance - if null, a NullPointerException will be raised

fieldName - - CronFieldName instance - if null, a NullPointerException will be raised

Method Details

withIntMapping

public FieldDefinitionBuilder withIntMapping(int source,
 int dest)

Provides means to define int values mappings between equivalent values. As a convention, higher values are mapped into lower ones

Parameters:

source - - higher value

dest - - lower value with equivalent meaning to source

Returns:

this instance

withValidRange

public FieldDefinitionBuilder withValidRange(int startRange,
 int endRange)

Allows to set a range of valid values for field.

Parameters:

startRange - - start range value

endRange - - end range value

Returns:

same FieldDefinitionBuilder instance

withStrictRange

public FieldDefinitionBuilder withStrictRange()

Specifies that defined range for given field must be a strict range. We understand strict range as a range defined as: "lowValue - highValue" If some range value such as "highValue-lowValue" is specified in a field, it will fail to parse the field.

Returns:

same FieldDefinitionBuilder instance

optional

public FieldDefinitionBuilder optional()

Allows to tag a field as optional.

Returns:

this instance

and

public CronDefinitionBuilder and()

Registers CronField in ParserDefinitionBuilder and returns its instance.

Returns:

ParserDefinitionBuilder instance obtained from constructor