Package org.cyclos.entities.utils

Class DatePeriod

java.lang.Object

org.cyclos.entities.utils.DatePeriod

@Embeddable
public class DatePeriod
extends Object

A persistent date period

Constructor Summary

Constructors

Constructor	Description
DatePeriod()
DatePeriod(Date begin, Date end)
DatePeriod(Pair<Date,Date> pair)

Method Summary

Modifier and Type	Method	Description
static DatePeriod	begginingAt(Date begin)	Returns a period beginning on the given date, with no end date
static DatePeriod	between(Date begin, Date end)	Returns a period between the given begin and end dates
static DatePeriod	endingAt(Date end)	Returns a period ending on the given date, with no begin date
boolean	equals(Object obj)
Date	getBegin()
Date	getEnd()
int	hashCode()
boolean	includes(Date date)	Returns whether the given date is included in this period.
boolean	isEmpty()
static DatePeriod	periodEndingAt(ITimeInterval interval, Date date)
static DatePeriod	periodIncluding(ITimeInterval interval, Date date)
static DatePeriod	periodStartingAt(ITimeInterval interval, Date date)
static DatePeriod	previousPeriod(ITimeInterval interval, Date date)
void	setBegin(Date begin)
void	setEnd(Date end)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatePeriod

public DatePeriod()

DatePeriod

public DatePeriod(Date begin,
                  Date end)

DatePeriod

public DatePeriod(Pair<Date,Date> pair)

Method Detail

begginingAt

public static DatePeriod begginingAt(Date begin)

Returns a period beginning on the given date, with no end date

between

public static DatePeriod between(Date begin,
                                 Date end)

Returns a period between the given begin and end dates

endingAt

public static DatePeriod endingAt(Date end)

Returns a period ending on the given date, with no begin date

periodEndingAt

public static DatePeriod periodEndingAt(ITimeInterval interval,
                                        Date date)

See Also:

DateHelper.periodEndingAt(ITimeInterval, Date)

periodIncluding

public static DatePeriod periodIncluding(ITimeInterval interval,
                                         Date date)

See Also:

DateHelper.periodIncluding(ITimeInterval, Date)

periodStartingAt

public static DatePeriod periodStartingAt(ITimeInterval interval,
                                          Date date)

See Also:

DateHelper.periodStartingAt(ITimeInterval, Date)

previousPeriod

public static DatePeriod previousPeriod(ITimeInterval interval,
                                        Date date)

See Also:

DateHelper.previousPeriod(ITimeInterval, Date)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBegin

public Date getBegin()

getEnd

public Date getEnd()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

includes

public boolean includes(Date date)

Returns whether the given date is included in this period. Null begin / end means unbounded. Both ends are inclusive.

isEmpty

public boolean isEmpty()

setBegin

public void setBegin(Date begin)

setEnd

public void setEnd(Date end)

toString

public String toString()

Overrides:

toString in class Object