com.cloudhopper.commons.util.time

Class DateTimeMonth

java.lang.Object

com.cloudhopper.commons.util.time.DateTimePeriod

com.cloudhopper.commons.util.time.DateTimeMonth

public class DateTimeMonth
extends DateTimePeriod

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DateTimeMonth(org.joda.time.DateTime start, org.joda.time.DateTime end)

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeDuration	getDefaultSubDuration() Gets the default "Group By" enumeration based on the duration for this period.
DateTimePeriod	getNext() Gets the next period based on the duration.
DateTimePeriod	getPrevious() Gets the previous period based on the duration.

Methods inherited from class com.cloudhopper.commons.util.time.DateTimePeriod

create, createDay, createDay, createFiveMinutes, createFiveMinutes, createHour, createHour, createLastYearMonths, createMonth, createMonth, createYear, createYear, equals, getDuration, getEnd, getIndexName, getKey, getLongName, getShortName, getStart, hashCode, toDays, toFiveMinutes, toHours, toMonths, toPeriods, toYears

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeMonth

protected DateTimeMonth(org.joda.time.DateTime start,
             org.joda.time.DateTime end)

Method Detail

getNext

public DateTimePeriod getNext()

Description copied from class: DateTimePeriod

Gets the next period based on the duration. For example, if this period represents a Month, this will return a period for the next Month.

Specified by:

getNext in class DateTimePeriod

Returns:

The next period

getPrevious

public DateTimePeriod getPrevious()

Description copied from class: DateTimePeriod

Gets the previous period based on the duration. For example, if this period represents a Month, this will return a period for the previous Month.

Specified by:

getPrevious in class DateTimePeriod

Returns:

The previous period

getDefaultSubDuration

public DateTimeDuration getDefaultSubDuration()

Description copied from class: DateTimePeriod

Gets the default "Group By" enumeration based on the duration for this period. The default "Group By" is usually the period "slice" one level below this one. For example, if this period is a month, this would return a grouping by year-month-day. If this period is a year, this would return a grouping by year-quarter.

Specified by:

getDefaultSubDuration in class DateTimePeriod

Returns:

A default group by determined by this period's duration