public class HourlyFrequency extends Frequency
Constructor and Description |
---|
HourlyFrequency(int numUnits)
Create a new HourlyFrequency that happens every numUnits hours, at an unspecified minute.
|
HourlyFrequency(int numUnits,
int minute)
Create a new HourlyFrequency that happens every numUnits hours, on the minute.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Autogenerated equals.
|
Date |
getFirstEvent(Date startTime)
Given a starting time, tell us when the first event should happen.
|
int |
getMinute()
If not anytime, the minute at which events should start.
|
Date |
getNextEvent(Date lastEvent)
Given when the last event happened, tell us when the next event should happen (even if the new event is in the
past).
|
Integer |
getOnDayOfMonth()
Return the exact day of month event should happen on, or null if this is an anyTime event or doesn't define what
day of month it should happen on.
|
Integer |
getOnDayOfWeek()
Return the exact day of week event should happen on, or null if this is an anyTime event or doesn't define what
day of week it should happen on.
|
Integer |
getOnHour()
Return the exact hour event should happen on, or null if this is an anyTime event or doesn't define what hour it
should happen on.
|
Integer |
getOnMinute()
Return the exact minute event should happen on, or null if this is an anyTime event or doesn't define what minute
it should happen on.
|
int |
hashCode()
Autogenerated hashcode method.
|
int |
ordinal()
Return an integer that can be used to identify the kind of frequency.
|
String |
toString()
Human readable representation of this object.
|
getNewInstance, getNumUnits, isAnytime
public HourlyFrequency(int numUnits)
numUnits
- Number of hours from one event to the nextArgumentNotValid
- if numUnits if 0 or negativepublic HourlyFrequency(int numUnits, int minute)
numUnits
- Number of hours from one event to the nextminute
- What minute of the hour the event should happen on.ArgumentNotValid
- if numUnits if 0 or negative or minutes is <0 or >59public Date getNextEvent(Date lastEvent)
The time of the next event is guaranteed to be later that lastEvent. For certain frequencies (e.g. once a day, any time of day), the time of the next event is derived from lastEvent, for others (e.g. once a day at 13:00) the time of the next event is the first matching time after lastEvent.
getNextEvent
in class Frequency
lastEvent
- A time from which the next event should be calculated.ArgumentNotValid
- if lastEvent is nullpublic Date getFirstEvent(Date startTime)
getFirstEvent
in class Frequency
startTime
- The earliest time the event can happen.ArgumentNotValid
- if startTime is nullpublic int getMinute()
public int hashCode()
public Integer getOnMinute()
getOnMinute
in class Frequency
public Integer getOnHour()
public Integer getOnDayOfWeek()
getOnDayOfWeek
in class Frequency
public Integer getOnDayOfMonth()
getOnDayOfMonth
in class Frequency
public int ordinal()
Copyright © 2005–2016 The Royal Danish Library, the Danish State and University Library, the National Library of France and the Austrian National Library.. All rights reserved.