org.hackystat.utilities.time.interval
Class MonthInterval

java.lang.Object
  extended by org.hackystat.utilities.time.interval.Interval
      extended by org.hackystat.utilities.time.interval.MonthInterval
All Implemented Interfaces:
java.lang.Iterable<Month>

public class MonthInterval
extends Interval
implements java.lang.Iterable<Month>

Provides month interval type.

Author:
Hongbing Kou, Philip Johnson

Constructor Summary
MonthInterval(java.lang.String startYear, java.lang.String startMonth, java.lang.String endYear, java.lang.String endMonth)
          Creates a MonthInterval object with start month and end month.
MonthInterval(javax.xml.datatype.XMLGregorianCalendar startMonth, javax.xml.datatype.XMLGregorianCalendar endMonth)
          Creates a MonthInterval object with start month and end month.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 Month getEndMonth()
          Gets the end month.
 Month getStartMonth()
          Gets start month.
 int hashCode()
          Gets the hash code.
 java.util.Iterator<Month> iterator()
          Gets the iterator over the month interval.
 java.lang.String toString()
          String representation of the MonthInterval object.
 
Methods inherited from class org.hackystat.utilities.time.interval.Interval
getIntervalType, isDailyInterval, isMonthlyInterval, isWeeklyInterval
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MonthInterval

public MonthInterval(java.lang.String startYear,
                     java.lang.String startMonth,
                     java.lang.String endYear,
                     java.lang.String endMonth)
              throws IllegalIntervalException
Creates a MonthInterval object with start month and end month.

Parameters:
startYear - Start year.
startMonth - Start month.
endYear - End year.
endMonth - End month.
Throws:
IllegalIntervalException - If try to create an interval with invalid period.

MonthInterval

public MonthInterval(javax.xml.datatype.XMLGregorianCalendar startMonth,
                     javax.xml.datatype.XMLGregorianCalendar endMonth)
              throws IllegalIntervalException
Creates a MonthInterval object with start month and end month.

Parameters:
startMonth - Start month.
endMonth - End month.
Throws:
IllegalIntervalException - If try to create an interval with invalid period.
Method Detail

getStartMonth

public Month getStartMonth()
Gets start month.

Returns:
Start month.

getEndMonth

public Month getEndMonth()
Gets the end month.

Returns:
End month.

toString

public java.lang.String toString()
String representation of the MonthInterval object.

Overrides:
toString in class java.lang.Object
Returns:
Month interval string

iterator

public java.util.Iterator<Month> iterator()
Gets the iterator over the month interval.

Specified by:
iterator in interface java.lang.Iterable<Month>
Specified by:
iterator in class Interval
Returns:
Iterator over month.

hashCode

public int hashCode()
Gets the hash code.

Overrides:
hashCode in class java.lang.Object
Returns:
The hash code.

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class java.lang.Object
Parameters:
obj - Another instance of DayInterval.
Returns:
True if they are equal, false otherwise.