Package io.github.projectunified.cronutils.parser

Class CronParserField

java.lang.Object

io.github.projectunified.cronutils.parser.CronParserField

public class CronParserField
extends Object

Represents a cron field.

Constructor Summary

Constructors

Constructor	Description
CronParserField(CronFieldName fieldName, FieldConstraints constraints)	Mandatory CronParserField Constructor.
CronParserField(CronFieldName fieldName, FieldConstraints constraints, boolean optional)	Constructor.

Method Summary

Modifier and Type	Method	Description
static Comparator<CronParserField>	createFieldTypeComparator()	Create a Comparator that compares CronField instances using CronFieldName value.
CronFieldName	getField()	Returns field name.
final boolean	isOptional()	Returns optional tag.
CronField	parse(String expression)	Parses a String cron expression.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CronParserField

public CronParserField(CronFieldName fieldName,
 FieldConstraints constraints)

Mandatory CronParserField Constructor.

Parameters:

fieldName - - CronFieldName instance

constraints - - FieldConstraints, constraints

CronParserField

public CronParserField(CronFieldName fieldName,
 FieldConstraints constraints,
 boolean optional)

Constructor.

Parameters:

fieldName - - CronFieldName instance

constraints - - FieldConstraints, constraints

optional - - optional tag

Method Details

getField

public CronFieldName getField()

Returns field name.

Returns:

CronFieldName, never null

isOptional

public final boolean isOptional()

Returns optional tag.

Returns:

optional tag

parse

public CronField parse(String expression)

Parses a String cron expression.

Parameters:

expression - - cron expression

Returns:

parse result as CronFieldParseResult instance - never null. May throw a RuntimeException if cron expression is bad.

createFieldTypeComparator

public static Comparator<CronParserField> createFieldTypeComparator()

Create a Comparator that compares CronField instances using CronFieldName value.

Returns:

Comparator for CronField instance, never null.

toString

public String toString()

Overrides:

toString in class Object