IncrementValue (WildFly: EJB Subsystem 30.0.0.Final API)

java.lang.Object
- org.jboss.as.ejb3.timerservice.schedule.value.IncrementValue

All Implemented Interfaces:

ScheduleValue
```
public class IncrementValue
extends Object
implements ScheduleValue
```
Represents a value for a ScheduleExpression which is expressed as an increment type. An IncrementValue comprises of a start value and an interval, separated by a "/"

An IncrementValue is specified in the form of x/y to mean "Every N { seconds | minutes | hours } within the { minute | hour | day }" (respectively). For expression x/y, the attribute is constrained to every yth value within the set of allowable values beginning at time x. The x value is inclusive. The wildcard character (*) can be used in the x position, and is equivalent to 0.

Version:

$Revision: $

Author:

Jaikiran Pai

See Also:

ScheduleExpressionType.INCREMENT

Field Summary

Fields
Modifier and Type Field Description

static String INCREMENT_SEPARATOR
The separator which is used for parsing a String which represents a IncrementValue

Constructor Summary

Constructors
Constructor Description

IncrementValue(String value)
Creates a IncrementValue by parsing the passed value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getInterval()`	Returns the interval of this `IncrementValue`
`int`	`getStart()`	Returns the start of this `IncrementValue`

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

- Field Detail
  - INCREMENT_SEPARATOR
```
public static final String INCREMENT_SEPARATOR
```
    The separator which is used for parsing a String which represents a IncrementValue
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IncrementValue
```
public IncrementValue(String value)
```
    Creates a IncrementValue by parsing the passed value.
    Upon successfully parsing the passed value, this constructor sets the start value and the interval value of this IncrementValue
    
    Parameters:
    
    value - The value to be parsed
    
    Throws:
    
    IllegalArgumentException - If the passed value cannot be represented as an IncrementValue
- Method Detail
  - getStart
```
public int getStart()
```
    Returns the start of this IncrementValue
    
    Returns:
    
    int start value
  - getInterval
```
public int getInterval()
```
    Returns the interval of this IncrementValue
    
    Returns:
    
    int interval value