com.cronutils.model

Class SingleCron

java.lang.Object

com.cronutils.model.SingleCron

All Implemented Interfaces:

Cron, Serializable

public class SingleCron
extends Object
implements Cron

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleCron(CronDefinition cronDefinition, List<CronField> fields) Creates a Cron with the iven cron definition and the given 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() Validates this Cron instance by validating its cron expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleCron

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

Creates a Cron with the iven cron definition and the given fields.

Parameters:

cronDefinition - the definition to use for this Cron

fields - the fields that should be used

Method Detail

retrieve

public CronField retrieve(CronFieldName name)

Retrieve value for cron field.

Specified by:

retrieve in interface Cron

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.

Specified by:

retrieveFieldsAsMap in interface Cron

Returns:

unmodifiable Map with key CronFieldName and values CronField, never null

asString

public String asString()

Specified by:

asString in interface Cron

getCronDefinition

public CronDefinition getCronDefinition()

Specified by:

getCronDefinition in interface Cron

validate

public Cron validate()

Validates this Cron instance by validating its cron expression.

Specified by:

validate in interface Cron

Returns:

this Cron instance

Throws:

IllegalArgumentException - if the cron expression is invalid

equivalent

public boolean equivalent(CronMapper cronMapper,
                          Cron cron)

Provides means to compare if two cron expressions are equivalent.

Specified by:

equivalent in interface Cron

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.

Specified by:

equivalent in interface Cron

Parameters:

cron - - any cron instance, never null

Returns:

boolean - true if equivalent; false otherwise.