java.lang.Object | |
↳ | com.atlassian.jira.web.component.cron.parser.CronExpressionParser |
Represents a cron string with accessor methods to get at the individual fields. This is only used to back our
Cron editor. This will tell you via the isValidForEditor()
method whether the cron string this is constructed
with will be parseable via the editor. To populate the editor use the getCronEditorBean()
method.
There are four modes that the editor supports:
If a cron string is not valid for the editor then the only available mode will be the advanced mode and the editor
state methods (e.g. getDayOfMonth()
, getHoursEntry()
) will return details of the default state
represented by DEFAULT_CRONSTRING
as they are not able to represent the advanced cron string.
The validation that this object performs is in the context of valid cron strings that will fit into the editor. This object does not validate that the over all string is a valid cron string.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | DEFAULT_CRONSTRING | Cron string that puts the editor into the default state. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a parser in default state using
DEFAULT_CRONSTRING . | |||||||||||
Parses the given cronString to establish the state of this CronExpressionParser.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Will provide the
CronEditorBean which represents the state of the
form for the configured cron string. | |||||||||||
Returns the cron string that the object was constructed with.
| |||||||||||
Gets the day of month field specified in the cron string.
| |||||||||||
Gets the
CronDayOfWeekEntry that represents the day of week cron field. | |||||||||||
Gets the
CronHoursEntry that represents the hours cron field. | |||||||||||
Used to determine the total increment in minutes that are implied by the crons hour and minutes field.
| |||||||||||
Gets the
CronMinutesEntry that represents the minutes cron field. | |||||||||||
Will return true if the passed in cron string is not valid for the editor.
| |||||||||||
Will return true if the editors daily mode can handle the provided cron string.
| |||||||||||
Returns true if
isDaysPerMonthMode() is true and the string in the days of week field can be handled
by the editor. | |||||||||||
Will return true if the editors day per week mode can handle the provided cron string.
| |||||||||||
Will return true if the editors days per month mode can handle the provided cron string.
| |||||||||||
Returns true only if the cron string can be handled by the cron editor UI.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Cron string that puts the editor into the default state.
Parses the given cronString to establish the state of this CronExpressionParser.
cronString | the cron string to parse. |
---|
Will provide the CronEditorBean
which represents the state of the
form for the configured cron string.
Returns the cron string that the object was constructed with. This method does not guarantee that the returned cron string is valid.
Gets the day of month field specified in the cron string.
Gets the CronDayOfWeekEntry
that represents the day of week cron field.
Gets the CronHoursEntry
that represents the hours cron field.
Used to determine the total increment in minutes that are implied by the crons hour and minutes field. If the hours and minutes field have an increment then the increment will come into play. An increment of 0 implies that the increment is once per day.
Gets the CronMinutesEntry
that represents the minutes cron field.
Will return true if the passed in cron string is not valid for the editor.
Will return true if the editors daily mode can handle the provided cron string.
Returns true if isDaysPerMonthMode()
is true and the string in the days of week field can be handled
by the editor.
Will return true if the editors day per week mode can handle the provided cron string.
Will return true if the editors days per month mode can handle the provided cron string.
Returns true only if the cron string can be handled by the cron editor UI.
If this method returns false then all method but getCronString()
will throw an IllegalStateException
work properly.