Package adams.core.base

Class CronSchedule

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.core.base.CronSchedule

All Implemented Interfaces:

CloneHandler<BaseObject>, HelpProvider, Serializable, Comparable

public class CronSchedule
extends AbstractBaseString
implements HelpProvider

Encapsulates a cron schedule.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

CronExpression, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT	the default schedule.
protected static Properties	m_Properties	the properties with the templates.

Fields inherited from class adams.core.base.BaseObject

m_Internal, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
CronSchedule()	Initializes with the default schedule.
CronSchedule(String s)	Initializes the object with the specified schedule.

Method Summary

Modifier and Type	Method	Description
String	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
String	getHelpIcon()	Returns the name of a help icon, e.g., used for buttons.
String	getHelpTitle()	Returns a short title for the help, e.g., used for buttons.
String	getHelpURL()	Returns a URL with additional information.
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).
protected void	initialize()	Initializes the internal object.
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.

Methods inherited from class adams.core.base.AbstractBaseString

convert, getValue, isEmpty, length, setValue, stringValue

Methods inherited from class adams.core.base.BaseObject

compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final String DEFAULT

the default schedule.

See Also:

Constant Field Values

m_Properties

protected static Properties m_Properties

the properties with the templates.

Constructor Detail

CronSchedule

public CronSchedule()

Initializes with the default schedule.

See Also:

DEFAULT

CronSchedule

public CronSchedule(String s)

Initializes the object with the specified schedule.

Parameters:

s - the schedule

Method Detail

initialize

protected void initialize()

Initializes the internal object.

Overrides:

initialize in class AbstractBaseString

isValid

public boolean isValid(String value)

Checks whether the string value is a valid presentation for this class.

Overrides:

isValid in class AbstractBaseString

Parameters:

value - the string value to check

Returns:

always true

getTipText

public String getTipText()

Returns a tool tip for the GUI editor (ignored if null is returned).

Specified by:

getTipText in class AbstractBaseString

Returns:

the tool tip

getHelpURL

public String getHelpURL()

Returns a URL with additional information.

Specified by:

getHelpURL in interface HelpProvider

Returns:

the URL, null if not available

getHelpDescription

public String getHelpDescription()

Returns a long help description, e.g., used in tiptexts.

Specified by:

getHelpDescription in interface HelpProvider

Returns:

the help text, null if not available

getHelpTitle

public String getHelpTitle()

Returns a short title for the help, e.g., used for buttons.

Specified by:

getHelpTitle in interface HelpProvider

Returns:

the short title, null if not available

getHelpIcon

public String getHelpIcon()

Returns the name of a help icon, e.g., used for buttons.

Specified by:

getHelpIcon in interface HelpProvider

Returns:

the icon name, null if not available