RangeFieldRule (Atlassian Scheduler - Caesium Implementation 3.0.2 API)

java.lang.Object
- com.atlassian.scheduler.caesium.cron.rule.field.RangeFieldRule

All Implemented Interfaces:

CronRule, FieldRule, Serializable
```
public class RangeFieldRule
extends Object
```
A cron field implementation that is based on a range of accepted values.

Since:

v0.0.1

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected DateTimeTemplate.Field field

Fields
Modifier and Type	Field and Description
`protected DateTimeTemplate.Field`	`field`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendTo(StringBuilder sb)` Reports the information about how this field is configured.
`boolean`	`first(DateTimeTemplate dateTime)` Resets `dateTime` to the minimum matching value for this rule, if possible.
`int`	`get(DateTimeTemplate dateTime)` Returns the currently set value for this field.
`boolean`	`matches(DateTimeTemplate dateTime)` Returns `true` if `dateTime` matches the rule; `false` if it does not.
`boolean`	`next(DateTimeTemplate dateTime)` Advance `dateTime` to when the rule would next match, if possible.
`static FieldRule`	`of(DateTimeTemplate.Field field, int min, int max)` Selects the most efficient implementation for the range provided.
`void`	`set(DateTimeTemplate dateTime, int value)` Modifies the value for this field to produce a new moment for consideration.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - field
```
protected final DateTimeTemplate.Field field
```
- Method Detail
  - of
```
public static FieldRule of(DateTimeTemplate.Field field,
                           int min,
                           int max)
```
    Selects the most efficient implementation for the range provided.
    If min and max are the same value, then the faster SingleValueFieldRule implementation is substituted.
    
    Parameters:
    
    field - the field type for manipulating DateTimeTemplate values
    
    min - the minimum value to include in the range; must be non-negative
    
    max - the maximum value to include in the range; must be >= min
    
    Returns:
    
    a field rule that implements the specified behaviour
  - matches
```
public boolean matches(DateTimeTemplate dateTime)
```
    Description copied from interface: CronRule
    
    Returns true if dateTime matches the rule; false if it does not.
    
    Parameters:
    
    dateTime - the moment to consider as a match for the rule
    
    Returns:
    
    true if dateTime matches the rule; false if it does not.
  - first
```
public boolean first(DateTimeTemplate dateTime)
```
    Description copied from interface: CronRule
    
    Resets dateTime to the minimum matching value for this rule, if possible.
    
    Parameters:
    
    dateTime - the time to modify by resetting the value that this rule evaluates to its minimum matching value
    
    Returns:
    
    true if dateTime has successfully been updated to when the rule would first match; false if there are no matching values for this rule (at least without some other rule changing dateTime in some other way first).
  - next
```
public boolean next(DateTimeTemplate dateTime)
```
    Description copied from interface: CronRule
    
    Advance dateTime to when the rule would next match, if possible.
    
    Parameters:
    
    dateTime - the time to modify by changing the value that this rule evaluates to its next matching value
    
    Returns:
    
    true if dateTime has successfully been updated to when the rule would next match; false if all legal values have been exhausted for this rule (at least without some other rule changing dateTime in some other way first).
  - appendTo
```
protected void appendTo(StringBuilder sb)
```
    Reports the information about how this field is configured. For troubleshooting reasons, it may be necessary to display the rules that were actually parsed for a cron expression. Each field rule is responsible for implementing this method in a way that unambiguously identifies what the rule means.
    
    Parameters:
    
    sb - a buffer to append with the field's information
  - get
```
public int get(DateTimeTemplate dateTime)
```
    Description copied from interface: FieldRule
    
    Returns the currently set value for this field.
    
    Specified by:
    
    get in interface FieldRule
    
    Parameters:
    
    dateTime - the moment from which to extract this field's value
    
    Returns:
    
    the value for this field as currently set in dateTime
  - set
```
public void set(DateTimeTemplate dateTime,
                int value)
```
    Description copied from interface: FieldRule
    
    Modifies the value for this field to produce a new moment for consideration.
    
    Specified by:
    
    set in interface FieldRule
    
    Parameters:
    
    dateTime - the moment to modify
    
    value - the value to set for this field
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class RangeFieldRule

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

field

Method Detail

of

matches

first

next

appendTo

get

set

toString