com.cronutils.model

Class Cron

java.lang.Object

com.cronutils.model.Cron

public class Cron
extends Object

Represents a cron expression

Constructor Summary

Constructors

Constructor and Description
Cron(CronDefinition cronDefinition, List<CronField> fields)

Method Summary

Modifier and Type	Method and Description
String	asString()
boolean	equivalent(Cron cron) Provides means to compare if two cron expressions are equivalent.
boolean	equivalent(CronMapper cronMapper, Cron cron) Provides means to compare if two cron expressions are equivalent.
CronDefinition	getCronDefinition()
CronField	retrieve(CronFieldName name) Retrieve value for cron field
Map<CronFieldName,CronField>	retrieveFieldsAsMap() Retrieve all cron field values as map
Cron	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cron

public Cron(CronDefinition cronDefinition,
            List<CronField> fields)

Method Detail

retrieve

public CronField retrieve(CronFieldName name)

Retrieve value for cron field

Parameters:

name - - cron field name. If null, a NullPointerException will be raised.

Returns:

CronField that corresponds to given CronFieldName

retrieveFieldsAsMap

public Map<CronFieldName,CronField> retrieveFieldsAsMap()

Retrieve all cron field values as map

Returns:

unmodifiable Map with key CronFieldName and values CronField, never null

asString

public String asString()

getCronDefinition

public CronDefinition getCronDefinition()

validate

public Cron validate()

equivalent

public boolean equivalent(CronMapper cronMapper,
                          Cron cron)

Provides means to compare if two cron expressions are equivalent.

Parameters:

cronMapper - - maps 'cron' parameter to this instance definition;

cron - - any cron instance, never null

Returns:

boolean - true if equivalent; false otherwise.

equivalent

public boolean equivalent(Cron cron)

Provides means to compare if two cron expressions are equivalent. Assumes same cron definition.

Parameters:

cron - - any cron instance, never null

Returns:

boolean - true if equivalent; false otherwise.