com.devexperts.util

Class DayRange

java.lang.Object

com.devexperts.util.DayRange

All Implemented Interfaces:

Serializable

public class DayRange
extends Object
implements Serializable

DayRange represents a certain number of days from starting day (inclusive) to ending day (exclusive). The bounds are defined as calendar dates omitting time of day or timezone details.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	containsDayId(int dayId)
boolean	equals(Object o)
int	getEndDayId()
int	getEndYmd()
static DayRange	getMonthRangeByDayId(int dayId, int numberOfMonths) Returns day range aligned to a period of specified number of months which contains specified day identifier.
int	getStartDayId()
int	getStartYmd()
static DayRange	getWeekRangeByDayId(int dayId, int numberOfWeeks) Returns day range aligned to a period of specified number of weeks which contains specified day identifier.
static DayRange	getYearRangeByDayId(int dayId, int numberOfYears) Returns day range aligned to a period of specified number of years which contains specified day identifier.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

containsDayId

public boolean containsDayId(int dayId)

getStartDayId

public int getStartDayId()

getStartYmd

public int getStartYmd()

getEndDayId

public int getEndDayId()

getEndYmd

public int getEndYmd()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getWeekRangeByDayId

public static DayRange getWeekRangeByDayId(int dayId,
                                           int numberOfWeeks)

Returns day range aligned to a period of specified number of weeks which contains specified day identifier. The weekly periods are aligned on Mondays and are counted from Monday, January 5, 1970. The day identifier is defined as the number of days since Unix epoch of January 1, 1970. The day identifier must belong to common era (Anno Domini) - see GregorianCalendar.AD. The number of weeks must be between 1 and 1000.

Parameters:

dayId - day identifier to search for

numberOfWeeks - number of weeks in a day range duration

Returns:

properly aligned day range for specified day identifier and duration

Throws:

IllegalArgumentException - if dayId or numberOfWeeks are out of allowed range

getMonthRangeByDayId

public static DayRange getMonthRangeByDayId(int dayId,
                                            int numberOfMonths)

Returns day range aligned to a period of specified number of months which contains specified day identifier. The monthly periods are aligned on calendar months and are counted from January 1, 1970. The day identifier is defined as the number of days since Unix epoch of January 1, 1970. The day identifier must belong to common era (Anno Domini) - see GregorianCalendar.AD. The number of months must be between 1 and 1000.

Parameters:

dayId - day identifier to search for

numberOfMonths - number of months in a day range duration

Returns:

properly aligned day range for specified day identifier and duration

Throws:

IllegalArgumentException - if dayId or numberOfWeeks are out of allowed range

getYearRangeByDayId

public static DayRange getYearRangeByDayId(int dayId,
                                           int numberOfYears)

Returns day range aligned to a period of specified number of years which contains specified day identifier. The yearly periods are aligned on calendar years and are counted from January 1, 1970. The day identifier is defined as the number of days since Unix epoch of January 1, 1970. The day identifier must belong to common era (Anno Domini) - see GregorianCalendar.AD. The number of years must be between 1 and 1000.

Parameters:

dayId - day identifier to search for

numberOfYears - number of years in a day range duration

Returns:

properly aligned day range for specified day identifier and duration

Throws:

IllegalArgumentException - if dayId or numberOfWeeks are out of allowed range