Package org.jboss.as.ejb3.timerservice.schedule.attribute

Class Hour

java.lang.Object

org.jboss.as.ejb3.timerservice.schedule.attribute.IntegerBasedExpression

org.jboss.as.ejb3.timerservice.schedule.attribute.Hour

public class Hour
extends IntegerBasedExpression

Represents the value of a hour constructed out of a ScheduleExpression.getHour()

A Hour can hold only Integer as its value. The only exception to this being the wildcard (*) value. The various ways in which a Hour value can be represented are:

• Wildcard. For example, hour = "*"
• Range. For example, hour = "0-23"
• List. For example, hour = "1, 12, 20"
• Single value. For example, hour = "5"
• Increment. For example, hour = "0 / 3"

Version:

$Revision: $

Author:

Jaikiran Pai

Field Summary

Fields

Modifier and Type	Field	Description
static Integer	MAX_HOUR	Maximum allowed value for a Hour
static Integer	MIN_HOUR	Minimum allowed value for a Hour

Fields inherited from class org.jboss.as.ejb3.timerservice.schedule.attribute.IntegerBasedExpression

absoluteValues, origValue, relativeValues, scheduleExpressionType

Constructor Summary

Constructors

Constructor	Description
Hour(String value)	Creates a Hour by parsing the passed String value

Method Summary

Modifier and Type	Method	Description
protected boolean	accepts(ScheduleExpressionType scheduleExprType)
int	getFirst()
protected Integer	getMaxValue()	Returns the maximum allowed value for a Hour
protected Integer	getMinValue()	Returns the minimum allowed value for a Hour
Integer	getNextMatch(int currentHour)
boolean	isRelativeValue(String value)	Checks if relative value is supported.

Methods inherited from class org.jboss.as.ejb3.timerservice.schedule.attribute.IntegerBasedExpression

assertValid, getType, parseInt, processIncrement, processListItem, processListValue, processRangeValue, processSingleValue

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HOUR

public static final Integer MAX_HOUR

Maximum allowed value for a Hour

MIN_HOUR

public static final Integer MIN_HOUR

Minimum allowed value for a Hour

Constructor Detail

Hour

public Hour(String value)

Creates a Hour by parsing the passed String value

Valid values are of type ScheduleExpressionType.WILDCARD, ScheduleExpressionType.RANGE, ScheduleExpressionType.LIST ScheduleExpressionType.INCREMENT or ScheduleExpressionType.SINGLE_VALUE

Parameters:

value - The value to be parsed

Throws:

IllegalArgumentException - If the passed value is neither a ScheduleExpressionType.WILDCARD, ScheduleExpressionType.RANGE, ScheduleExpressionType.LIST, ScheduleExpressionType.INCREMENT nor ScheduleExpressionType.SINGLE_VALUE.

Method Detail

getFirst

public int getFirst()

getMaxValue

protected Integer getMaxValue()

Returns the maximum allowed value for a Hour

Specified by:

getMaxValue in class IntegerBasedExpression

See Also:

MAX_HOUR

getMinValue

protected Integer getMinValue()

Returns the minimum allowed value for a Hour

Specified by:

getMinValue in class IntegerBasedExpression

See Also:

MIN_HOUR

isRelativeValue

public boolean isRelativeValue(String value)

Description copied from class: IntegerBasedExpression

Checks if relative value is supported.

Specified by:

isRelativeValue in class IntegerBasedExpression

Parameters:

value - non-null value

Returns:

true if relative value is supported

accepts

protected boolean accepts(ScheduleExpressionType scheduleExprType)

Specified by:

accepts in class IntegerBasedExpression

getNextMatch

public Integer getNextMatch(int currentHour)