com.cronutils.model.field.definition

Class FieldDefinition

java.lang.Object

com.cronutils.model.field.definition.FieldDefinition

Direct Known Subclasses:

DayOfWeekFieldDefinition

public class FieldDefinition
extends Object

Represents a definition of allowed values for a cron field.

Constructor Summary

Constructors

Constructor and Description
FieldDefinition(CronFieldName fieldName, FieldConstraints constraints) Constructor

Method Summary

Modifier and Type	Method and Description
static Comparator<FieldDefinition>	createFieldDefinitionComparator() Creates a field definition comparator.
FieldConstraints	getConstraints() Get field constraints
CronFieldName	getFieldName() Retrieve field name

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDefinition

public FieldDefinition(CronFieldName fieldName,
                       FieldConstraints constraints)

Constructor

Parameters:

fieldName - - CronFieldName; name of the field if null, a NullPointerException will be raised.

constraints - - FieldConstraints, constraints; if null, a NullPointerException will be raised.

Method Detail

getFieldName

public CronFieldName getFieldName()

Retrieve field name

Returns:

CronFieldName instance, never null;

getConstraints

public FieldConstraints getConstraints()

Get field constraints

Returns:

FieldConstraints instance, never null;

createFieldDefinitionComparator

public static Comparator<FieldDefinition> createFieldDefinitionComparator()

Creates a field definition comparator. Will compare by CronFieldName order value;

Returns:

Comparator for FieldDefinition instance, never null;