org.jfree.data.time

Class Month

public class Month extends RegularTimePeriod implements Serializable

Represents a single month. This class is immutable, which is a requirement for all RegularTimePeriod subclasses.
Constructor Summary
Month()
Constructs a new Month, based on the current system time.
Month(int month, int year)
Constructs a new month instance.
Month(int month, Year year)
Constructs a new month instance.
Month(Date time)
Constructs a new Month instance, based on a date/time and the default time zone.
Month(Date time, TimeZone zone)
Constructs a new Month instance, based on a date/time and a time zone.
Method Summary
intcompareTo(Object o1)
Returns an integer indicating the order of this Month object relative to the specified object: negative == before, zero == same, positive == after.
booleanequals(Object obj)
Tests the equality of this Month object to an arbitrary object.
longgetFirstMillisecond()
Returns the first millisecond of the month.
longgetFirstMillisecond(Calendar calendar)
Returns the first millisecond of the month, evaluated using the supplied calendar (which determines the time zone).
longgetLastMillisecond()
Returns the last millisecond of the month.
longgetLastMillisecond(Calendar calendar)
Returns the last millisecond of the month, evaluated using the supplied calendar (which determines the time zone).
intgetMonth()
Returns the month.
longgetSerialIndex()
Returns a serial index number for the month.
YeargetYear()
Returns the year in which the month falls.
intgetYearValue()
Returns the year in which the month falls.
inthashCode()
Returns a hash code for this object instance.
RegularTimePeriodnext()
Returns the month following this one.
static MonthparseMonth(String s)
Parses the string argument as a month.
voidpeg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).
RegularTimePeriodprevious()
Returns the month preceding this one.
StringtoString()
Returns a string representing the month (e.g.

Constructor Detail

Month

public Month()
Constructs a new Month, based on the current system time.

Month

public Month(int month, int year)
Constructs a new month instance.

Parameters: month the month (in the range 1 to 12). year the year.

Month

public Month(int month, Year year)
Constructs a new month instance.

Parameters: month the month (in the range 1 to 12). year the year.

Month

public Month(Date time)
Constructs a new Month instance, based on a date/time and the default time zone.

Parameters: time the date/time.

Month

public Month(Date time, TimeZone zone)
Constructs a new Month instance, based on a date/time and a time zone.

Parameters: time the date/time. zone the time zone (null not permitted).

Method Detail

compareTo

public int compareTo(Object o1)
Returns an integer indicating the order of this Month object relative to the specified object: negative == before, zero == same, positive == after.

Parameters: o1 the object to compare.

Returns: negative == before, zero == same, positive == after.

equals

public boolean equals(Object obj)
Tests the equality of this Month object to an arbitrary object. Returns true if the target is a Month instance representing the same month as this object. In all other cases, returns false.

Parameters: obj the object (null permitted).

Returns: true if month and year of this and object are the same.

getFirstMillisecond

public long getFirstMillisecond()
Returns the first millisecond of the month. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg method.

Returns: The first millisecond of the month.

See Also: getLastMillisecond

getFirstMillisecond

public long getFirstMillisecond(Calendar calendar)
Returns the first millisecond of the month, evaluated using the supplied calendar (which determines the time zone).

Parameters: calendar the calendar (null not permitted).

Returns: The first millisecond of the month.

Throws: NullPointerException if calendar is null.

getLastMillisecond

public long getLastMillisecond()
Returns the last millisecond of the month. This will be determined relative to the time zone specified in the constructor, or in the calendar instance passed in the most recent call to the peg method.

Returns: The last millisecond of the month.

See Also: getFirstMillisecond

getLastMillisecond

public long getLastMillisecond(Calendar calendar)
Returns the last millisecond of the month, evaluated using the supplied calendar (which determines the time zone).

Parameters: calendar the calendar (null not permitted).

Returns: The last millisecond of the month.

Throws: NullPointerException if calendar is null.

getMonth

public int getMonth()
Returns the month. Note that 1=JAN, 2=FEB, ...

Returns: The month.

getSerialIndex

public long getSerialIndex()
Returns a serial index number for the month.

Returns: The serial index number.

getYear

public Year getYear()
Returns the year in which the month falls.

Returns: The year in which the month falls (as a Year object).

getYearValue

public int getYearValue()
Returns the year in which the month falls.

Returns: The year in which the month falls (as an int).

hashCode

public int hashCode()
Returns a hash code for this object instance. The approach described by Joshua Bloch in "Effective Java" has been used here:

http://developer.java.sun.com/developer/Books/effectivejava /Chapter3.pdf

Returns: A hash code.

next

public RegularTimePeriod next()
Returns the month following this one.

Returns: The month following this one.

parseMonth

public static Month parseMonth(String s)
Parses the string argument as a month.

This method is required to accept the format "YYYY-MM". It will also accept "MM-YYYY". Anything else, at the moment, is a bonus.

Parameters: s the string to parse.

Returns: null if the string is not parseable, the month otherwise.

peg

public void peg(Calendar calendar)
Recalculates the start date/time and end date/time for this time period relative to the supplied calendar (which incorporates a time zone).

Parameters: calendar the calendar (null not permitted).

Since: 1.0.3

previous

public RegularTimePeriod previous()
Returns the month preceding this one.

Returns: The month preceding this one.

toString

public String toString()
Returns a string representing the month (e.g. "January 2002").

To do: look at internationalisation.

Returns: A string representing the month.