it.burning.cron

Class CronExpressionDescriptor

java.lang.Object

it.burning.cron.CronExpressionDescriptor

public class CronExpressionDescriptor
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CronExpressionDescriptor.DescriptionType

Constructor Summary

Constructors

Constructor and Description
CronExpressionDescriptor() Empty constructor
CronExpressionDescriptor(java.lang.String expression) Constructor (default system locale)
CronExpressionDescriptor(java.lang.String expression, CronExpressionParser.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	formatTime(java.lang.String hourExpression, java.lang.String minuteExpression) Given time parts, will contruct a formatted time description
protected java.lang.String	formatTime(java.lang.String hourExpression, java.lang.String minuteExpression, java.lang.String secondExpression) Given time parts, will contruct a formatted time description
protected java.lang.String	GenerateBetweenSegmentDescription(java.lang.String betweenExpression, it.burning.cron.CronExpressionDescriptor.GetDescription getBetweenDescriptionFormat, it.burning.cron.CronExpressionDescriptor.GetDescription getSingleItemDescription) Generates the between segment description
protected java.lang.String	GetDayOfMonthDescription() Generates a description for only the DAYOFMONTH portion of the expression
protected java.lang.String	GetDayOfWeekDescription() Generates a description for only the DAYOFWEEK portion of the expression
java.lang.String	getDescription() Get the full description for the currently configured expression and options
java.lang.String	getDescription(CronExpressionDescriptor.DescriptionType type) Generates a human readable String for the Cron Expression
static java.lang.String	getDescription(java.lang.String expression) Generates a human readable String for the Cron Expression
static java.lang.String	getDescription(java.lang.String expression, CronExpressionParser.Options options) Generates a human readable String for the Cron Expression
protected java.lang.String	getFullDescription() Generates the FULL description
protected java.lang.String	GetHoursDescription() Generates a description for only the HOUR portion of the expression
java.util.Locale	getLocale()
java.util.ResourceBundle	getLocalization()
protected java.lang.String	GetMinutesDescription() Generates a description for only the MINUTE portion of the expression
protected java.lang.String	GetMonthDescription() Generates a description for only the MONTH portion of the expression
CronExpressionParser.Options	getOptions()
protected java.lang.String	GetSecondsDescription() Generates a description for only the SECONDS portion of the expression
protected java.lang.String	getSegmentDescription(java.lang.String expression, java.lang.String allDescription, it.burning.cron.CronExpressionDescriptor.GetDescription getSingleItemDescription, it.burning.cron.CronExpressionDescriptor.GetDescription getIntervalDescriptionFormat, it.burning.cron.CronExpressionDescriptor.GetDescription getBetweenDescriptionFormat, it.burning.cron.CronExpressionDescriptor.GetDescription getDescriptionFormat, it.burning.cron.CronExpressionDescriptor.GetDescription getRangeFormat) Generates the segment description
protected java.lang.String	getString(java.lang.String resourceName) Gets a localized String resource
protected java.lang.String	getString(java.lang.String resourceName, boolean emptyIfNotFound) Gets a localized String resource, optionally returns an empty string or the requested resource name if the resource is not found within the localzation packages
protected java.lang.String	GetTimeOfDayDescription() Generates a description for only the TIMEOFDAY portion of the expression
boolean	isUse24HourTimeFormat()
static void	setDefaultLocale() Set the default locale of the JVM instance we're running in
static void	setDefaultLocale(java.util.Locale locale) Set the default locale to be used
static void	setDefaultLocale(java.lang.String language) Set the default locale to be used
void	setExpression(java.lang.String expression) Set the expression that this instance will process next time the getDescription(DescriptionType) is called.
void	setExpression(java.lang.String expression, CronExpressionParser.Options options) Set the expression and options that this instance will process next time the getDescription(DescriptionType) is called.
void	setOptions(CronExpressionParser.Options options)
protected java.lang.String	transformVerbosity(java.lang.String description, boolean useVerboseFormat) Transforms the verbosity of the expression description by stripping verbosity from original description

Methods inherited from class java.lang.Object

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

Constructor Detail

CronExpressionDescriptor

public CronExpressionDescriptor()

Empty constructor

CronExpressionDescriptor

public CronExpressionDescriptor(java.lang.String expression)

Constructor (default system locale)

Parameters:

expression - The complete cron expression

CronExpressionDescriptor

public CronExpressionDescriptor(java.lang.String expression,
                                CronExpressionParser.Options options)

Constructor

Parameters:

expression - The cron expression to describe

options - The options to use when parsing the expression

Method Detail

setOptions

public void setOptions(CronExpressionParser.Options options)

getOptions

public CronExpressionParser.Options getOptions()

getLocale

public java.util.Locale getLocale()

getLocalization

public java.util.ResourceBundle getLocalization()

isUse24HourTimeFormat

public boolean isUse24HourTimeFormat()

setExpression

public void setExpression(java.lang.String expression)

Set the expression that this instance will process next time the getDescription(DescriptionType) is called. Default options will be used.

Parameters:

expression - The expression to be parsed

setExpression

public void setExpression(java.lang.String expression,
                          CronExpressionParser.Options options)

Set the expression and options that this instance will process next time the getDescription(DescriptionType) is called.

Parameters:

expression - The new expression to describe

options - The options to use

getDescription

public java.lang.String getDescription()

Get the full description for the currently configured expression and options

Returns:

The cron expression description

getDescription

public java.lang.String getDescription(CronExpressionDescriptor.DescriptionType type)

Generates a human readable String for the Cron Expression

Parameters:

type - Which part(s) of the expression to describe

Returns:

The cron expression description

getFullDescription

protected java.lang.String getFullDescription()

Generates the FULL description

Returns:

FULL description

GetTimeOfDayDescription

protected java.lang.String GetTimeOfDayDescription()

Generates a description for only the TIMEOFDAY portion of the expression

Returns:

The TIMEOFDAY description

GetSecondsDescription

protected java.lang.String GetSecondsDescription()

Generates a description for only the SECONDS portion of the expression

Returns:

The SECONDS description

GetMinutesDescription

protected java.lang.String GetMinutesDescription()

Generates a description for only the MINUTE portion of the expression

Returns:

The MINUTE description

GetHoursDescription

protected java.lang.String GetHoursDescription()

Generates a description for only the HOUR portion of the expression

Returns:

The HOUR description

GetDayOfWeekDescription

protected java.lang.String GetDayOfWeekDescription()

Generates a description for only the DAYOFWEEK portion of the expression

Returns:

The DAYOFWEEK description

GetMonthDescription

protected java.lang.String GetMonthDescription()

Generates a description for only the MONTH portion of the expression

Returns:

The MONTH description

GetDayOfMonthDescription

protected java.lang.String GetDayOfMonthDescription()

Generates a description for only the DAYOFMONTH portion of the expression

Returns:

The DAYOFMONTH description

getSegmentDescription

protected java.lang.String getSegmentDescription(java.lang.String expression,
                                                 java.lang.String allDescription,
                                                 it.burning.cron.CronExpressionDescriptor.GetDescription getSingleItemDescription,
                                                 it.burning.cron.CronExpressionDescriptor.GetDescription getIntervalDescriptionFormat,
                                                 it.burning.cron.CronExpressionDescriptor.GetDescription getBetweenDescriptionFormat,
                                                 it.burning.cron.CronExpressionDescriptor.GetDescription getDescriptionFormat,
                                                 it.burning.cron.CronExpressionDescriptor.GetDescription getRangeFormat)

Generates the segment description

Range expressions used the 'ComaX0ThroughX1' resource However Romanian language has different idioms for 1. 'from number to number' (minutes, seconds, hours, days) -- ComaMinX0ThroughMinX1 optional resource 2. 'from month to month' -- ComaMonthX0ThroughMonthX1 optional resource 3. 'from year to year' -- ComaYearX0ThroughYearX1 optional resource therefore the getRangeFormat parameter was introduced

Parameters:

expression - The expression

allDescription - The complete description

getSingleItemDescription - Functional implementation

getIntervalDescriptionFormat - Functional implementation

getBetweenDescriptionFormat - Functional implementation

getDescriptionFormat - Functional implementation

getRangeFormat - Functional implementation that formats range expressions depending on cron parts

Returns:

The generated description segment

GenerateBetweenSegmentDescription

protected java.lang.String GenerateBetweenSegmentDescription(java.lang.String betweenExpression,
                                                             it.burning.cron.CronExpressionDescriptor.GetDescription getBetweenDescriptionFormat,
                                                             it.burning.cron.CronExpressionDescriptor.GetDescription getSingleItemDescription)

Generates the between segment description

Parameters:

betweenExpression - Between range expression

getBetweenDescriptionFormat - Functional implementation

getSingleItemDescription - Functional implementation

Returns:

The between segment description

formatTime

protected java.lang.String formatTime(java.lang.String hourExpression,
                                      java.lang.String minuteExpression)

Given time parts, will contruct a formatted time description

Parameters:

hourExpression - Hours part

minuteExpression - Minutes part

Returns:

Formatted time description

formatTime

protected java.lang.String formatTime(java.lang.String hourExpression,
                                      java.lang.String minuteExpression,
                                      java.lang.String secondExpression)

Given time parts, will contruct a formatted time description

Parameters:

hourExpression - Hours part

minuteExpression - Minutes part

secondExpression - Seconds part

Returns:

Formatted time description

transformVerbosity

protected java.lang.String transformVerbosity(java.lang.String description,
                                              boolean useVerboseFormat)

Transforms the verbosity of the expression description by stripping verbosity from original description

Parameters:

description - The description to transform

useVerboseFormat - If true, will leave description as it, if false, will strip verbose parts. The transformed description with proper verbosity

Returns:

Formatted description

getString

protected java.lang.String getString(java.lang.String resourceName)

Gets a localized String resource

Parameters:

resourceName - The name of the resource String to retrieve

Returns:

The localized string

getString

protected java.lang.String getString(java.lang.String resourceName,
                                     boolean emptyIfNotFound)

Gets a localized String resource, optionally returns an empty string or the requested resource name if the resource is not found within the localzation packages

Parameters:

resourceName - The name of the resource String to retrieve

emptyIfNotFound - True to return an empty string if the resource wasn't found

Returns:

The resource value

getDescription

public static java.lang.String getDescription(java.lang.String expression)

Generates a human readable String for the Cron Expression

Parameters:

expression - The cron expression String

Returns:

The cron expression description

getDescription

public static java.lang.String getDescription(java.lang.String expression,
                                              CronExpressionParser.Options options)

Generates a human readable String for the Cron Expression

Parameters:

expression - The cron expression String

options - Options to control the output description

Returns:

The requested expression's description

setDefaultLocale

public static void setDefaultLocale(java.lang.String language)

Set the default locale to be used

Parameters:

language - The language identifier string for the desired locale: "en", "it", etc..

setDefaultLocale

public static void setDefaultLocale(java.util.Locale locale)

Set the default locale to be used

Parameters:

locale - The constant representing a default locale string

setDefaultLocale

public static void setDefaultLocale()

Set the default locale of the JVM instance we're running in