com.cronutils.descriptor

Class CronDescriptor

java.lang.Object

com.cronutils.descriptor.CronDescriptor

public class CronDescriptor
extends Object

Provides human readable description for a given cron.

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DEFAULT_LOCALE

Constructor Summary

Constructors

Constructor and Description
CronDescriptor(ResourceBundle resourceBundle) Constructor creating a descriptor for given ResourceBundle.

Method Summary

Modifier and Type	Method and Description
String	describe(Cron cron) Provide a description of given CronFieldParseResult list.
String	describeDayOfMonth(Map<CronFieldName,CronField> fields) Provide description for day of month.
String	describeDayOfWeek(Map<CronFieldName,CronField> fields, Map<CronFieldName,FieldDefinition> definitions) Provide description for day of week.
String	describeHHmmss(Map<CronFieldName,CronField> fields) Provide description for hours, minutes and seconds.
String	describeMonth(Map<CronFieldName,CronField> fields) Provide description for month.
String	describeYear(Map<CronFieldName,CronField> fields) Provide description for a year.
ResourceBundle	getResourceBundle() Gets the current resource bundle that is in use to allow custom reuse of text phrases.
static CronDescriptor	instance() Creates an instance with UK locale.
static CronDescriptor	instance(Locale locale) Creates and instance with given locale.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

Constructor Detail

CronDescriptor

public CronDescriptor(ResourceBundle resourceBundle)

Constructor creating a descriptor for given ResourceBundle.

Parameters:

resourceBundle - - ResourceBundle which contains descriptions

Method Detail

describe

public String describe(Cron cron)

Provide a description of given CronFieldParseResult list.

Parameters:

cron - - Cron instance, never null if null, will throw NullPointerException

Returns:

description - String

describeHHmmss

public String describeHHmmss(Map<CronFieldName,CronField> fields)

Provide description for hours, minutes and seconds.

Parameters:

fields - - fields to describe;

Returns:

description - String

describeDayOfMonth

public String describeDayOfMonth(Map<CronFieldName,CronField> fields)

Provide description for day of month.

Parameters:

fields - - fields to describe;

Returns:

description - String

describeMonth

public String describeMonth(Map<CronFieldName,CronField> fields)

Provide description for month.

Parameters:

fields - - fields to describe;

Returns:

description - String

describeDayOfWeek

public String describeDayOfWeek(Map<CronFieldName,CronField> fields,
                                Map<CronFieldName,FieldDefinition> definitions)

Provide description for day of week.

Parameters:

fields - - fields to describe;

Returns:

description - String

describeYear

public String describeYear(Map<CronFieldName,CronField> fields)

Provide description for a year.

Parameters:

fields - - fields to describe;

Returns:

description - String

instance

public static CronDescriptor instance()

Creates an instance with UK locale.

Returns:

CronDescriptor - never null.

instance

public static CronDescriptor instance(Locale locale)

Creates and instance with given locale.

Parameters:

locale - - Locale in which descriptions will be given

Returns:

CronDescriptor - never null.

getResourceBundle

public ResourceBundle getResourceBundle()

Gets the current resource bundle that is in use to allow custom reuse of text phrases.

Returns:

ResourceBundle - never null.