dk.heick.properties.types

Class QuartzCronExpressionPropertyType

java.lang.Object

dk.heick.properties.PropertyType<String>

dk.heick.properties.types.QuartzCronExpressionPropertyType

All Implemented Interfaces:

Serializable

public class QuartzCronExpressionPropertyType
extends dk.heick.properties.PropertyType<String>

PropertyType that validates to a String value.
This type convert and validates a string to a CronExpression for a Quartz trigger.
The point is that we now know it is a valid CronExpression.

Constructor Example			Comments
Property<String> A_PROPERTY = new Property<String>("name", new QuartzCronExpressionPropertyType());			Default value is null.
Property<String> A_PROPERTY = new Property<String>("name", new QuartzCronExpressionPropertyType("0 0/2 8-17 * * ?");			Default value is "0 0/2 8-17 * * ?".
Type of value(s)	Examples	Result	Comments
Valid	0 0/2 8-17 * * ?	A string validated as a CronExpression 0 0/2 8-17 * * ?.	Validate successfully.
Valid	0 15 10 * * ? 2005	A string validated as a CronExpression 0 15 10 * * ? 2005.	Validate successfully.
Invalid	cow	null	Validate will throw an exception. Return default value if set, otherwise null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.6

Author:

Frederik Heick

See Also:

http://quartz-scheduler.org/api/2.0.0/org/quartz/CronExpression.html, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of QuartzCronTriggerPropertyType.

Constructor Summary

Constructors

Constructor and Description
QuartzCronExpressionPropertyType() Default constructor, no default value.
QuartzCronExpressionPropertyType(String defaultValue) Constructor with default value.

Method Summary

Modifier and Type	Method and Description
org.quartz.Trigger	buildTrigger(String triggerName, String triggerGroup, String value) Builds a trigger
List<String>	getRestrictions()
String	validateValue(String propertyName, String value)

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateConstraints, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of QuartzCronTriggerPropertyType.

See Also:

Constant Field Values

Constructor Detail

QuartzCronExpressionPropertyType

public QuartzCronExpressionPropertyType()

Default constructor, no default value.

QuartzCronExpressionPropertyType

public QuartzCronExpressionPropertyType(String defaultValue)

Constructor with default value.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

getRestrictions

public List<String> getRestrictions()

Specified by:

getRestrictions in class dk.heick.properties.PropertyType<String>

validateValue

public String validateValue(String propertyName,
                            String value)
                     throws dk.heick.properties.PropertyException

Specified by:

validateValue in class dk.heick.properties.PropertyType<String>

Throws:

dk.heick.properties.PropertyException

buildTrigger

public org.quartz.Trigger buildTrigger(String triggerName,
                                       String triggerGroup,
                                       String value)

Builds a trigger

Parameters:

triggerName - the trigger name

triggerGroup - the trigger group

value - the cron expression, supplied bu the value.

Returns:

a valid trigger.