org.hawkular.alerts.api.model.action

Class TimeConstraint

java.lang.Object

org.hawkular.alerts.api.model.action.TimeConstraint

All Implemented Interfaces:

Serializable

public class TimeConstraint
extends Object
implements Serializable

Define a time interval (startTime, endTime) used as a constraint for action execution. Time interval can be defined in a absolute or relative expression. An absolute time interval uses the pattern yyyy.MM.dd[,HH:mm] for startTime and endTime properties. For example,these representations are valid absolute expressions for time interval: {startTime: "2016.02.01", endTime: "2016.03.01", relative: false} {startTime: "2016.02.01,09:00", endTime: "2016.03.01,18:00", relative: false} Absolute time interval are marked with flag relative set to false. Hour and minutes can be optional in absolute format, by default it takes 00:00 value. The absolute interval time is based on the default time zone and locale. A relative interval is used for repetitive expressions. It can be defined an interval between months (i.e. December to March), between days of the week (i.e. Sunday to Friday), between hours and minutes (i.e. 23:00 to 04:30), or a combination of month, day of the week and/or hours and minutes. Relative interval uses the pattern [MMM],[WWW],[HH:mm] where months and days of the week can be used in long or short format. Same pattern should be applied to both startTime and endTime properties. For example, these representations are valid relative expressions for time interval: {startTime: "Jul", endTime: "Dec", relative: true} {startTime: "July", endTime: "December", relative: true} All dates within July and December months will be valid. {startTime: "Jul,Mon", endTime: "Dec,Fri", relative: true} {startTime: "July,Monday", endTime: "December,Friday", relative: true} All dates within July and December months and within Monday and Friday days are valid. So, a Sunday day of August will not be valid according previous example. {startTime: "Jul,Mon,09:00", endTime: "Dec,Fri,18:00", relative: true} {startTime: "July,Monday", endTime: "December,Friday", relative: true} All dates within July and December months and within Monday and Friday days and time between 09:00 and 18:00 are valid. So, a Monday day of August at 18:01 will not be valid according previous example. {startTime:"Monday,09:00", endTime:"Friday,18:00", relative: true} {startTime:"Mon,09:00", endTime:"Fri,18:00", relative: true} All dates within Monday and Friday day and time between 09:00 and 18:00 will be valid. So, a Monday at 18:01 will not be valid according previous example. {startTime:"July,09:00", endTime:"August,18:00", relative: true} {startTime:"Jul,09:00", endTime:"Aug,18:00", relative: true} All dates within July and December months and time between 09:00 and 18:00 are valid. A day of August at 18:01 will not be valid according previous example. {startTime:"09:00", endTime:"18:00", relative: true} All times within 09:00 and 18:00 are valid. TimeConstraint object can define if a given date will be satisfied within the interval or outside interval using the property inRange. A value inRange == true means that a time interval will be satisfied when a given date is within the interval (taking the limits as inclusive), in case of inRange == false a given date will be satisfied if it is outside of the interval. By default, inRange == true. For example, {startTime:"09:00", endTime:"18:00", relative: true, inRange: true} All times within 09:00 and 18:00 are satisfied by the interval. {startTime:"09:00", endTime:"18:00", relative: true, inRange: false} All times from 18:01 to 08:59 are satisfied in the interval.

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeConstraint.DAY
static class	TimeConstraint.MONTH

Constructor Summary

Constructors

Constructor and Description
TimeConstraint()
TimeConstraint(String startTime, String endTime)
TimeConstraint(String startTime, String endTime, boolean relative)
TimeConstraint(String startTime, String endTime, boolean relative, boolean inRange)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getEndTime()
String	getStartTime()
int	hashCode()
boolean	isInRange()
boolean	isRelative()
boolean	isSatisfiedBy(long timestamp) Validate whether a timestamp satisfies the time interval defined in the constraint.
void	setEndTime(String endTime)
void	setInRange(boolean inRange)
void	setRelative(boolean relative)
void	setStartTime(String startTime)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeConstraint

public TimeConstraint()

TimeConstraint

public TimeConstraint(String startTime,
                      String endTime)

TimeConstraint

public TimeConstraint(String startTime,
                      String endTime,
                      boolean relative)

TimeConstraint

public TimeConstraint(String startTime,
                      String endTime,
                      boolean relative,
                      boolean inRange)

Method Detail

getStartTime

public String getStartTime()

setStartTime

public void setStartTime(String startTime)

getEndTime

public String getEndTime()

setEndTime

public void setEndTime(String endTime)

isRelative

public boolean isRelative()

setRelative

public void setRelative(boolean relative)

isInRange

public boolean isInRange()

setInRange

public void setInRange(boolean inRange)

isSatisfiedBy

public boolean isSatisfiedBy(long timestamp)
                      throws IllegalArgumentException

Validate whether a timestamp satisfies the time interval defined in the constraint.

Parameters:

timestamp - A specific timestamp to validate

Returns:

true if timestamp satisfies the time constraint false if timestamp does not satisfy the time constraint

Throws:

IllegalFormatException - if startTime or endTime have an illegal format

IllegalArgumentException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object