com.basecmp.core.util
Class Month

java.lang.Object
  com.basecmp.core.util.Month

All Implemented Interfaces:

java.lang.Comparable

public class Month

extends java.lang.Object

implements java.lang.Comparable

Hilfsklasse, die aufbauend auf java.util.Date eine Monats-Abstraktion mit einigen Bequemlichkeitsmethoden (Monats-Erster/Letzter/Iteratoren) zur Verfügung stellt.

Author:

Wolfgang Schröder

Constructor Summary

Month()
Defaultkonstruktor, ruft Hauptkonstruktor Month(Date, Locale) mit aktuellen Datum und Default-Locale auf.

Month(java.util.Date date)
Nebenkonstruktor, ruft Hauptkonstruktor Month(Date, Locale) mit dem angebenen Datum und der Default-Locale auf.

Month(java.util.Date date, java.util.Locale locale)
Hauptkonstruktor zum initialisieren der internen Date-Objekte first und last.

Method Summary

int	compareTo(java.lang.Object obj) Liefert gemäß Interface java.lang.Comparable -1 für Month Objekte, wenn dieses Objekt kleiner ist, als dasübergebene, 0 für gleiche Month Objekte und +1 für größere Month Objekte.
java.util.Date	getFirst() Liefert das Date-Object des ersten Tages dieses Month-Objects.
static java.util.Iterator	getIterator() Liefert einen Iterator vom Typ MonthIterator mit der Default-Locale.
static java.util.Iterator	getIterator(java.util.Date from, java.util.Date to, java.util.Locale locale) Liefert einen Iterator vom Typ MonthIterator.
static java.util.Iterator	getIterator(java.util.Date from, int range, java.util.Locale locale) Liefert einen Iterator vom Typ MonthIterator.
static java.util.Iterator	getIterator(java.util.Date from, java.util.Locale locale) Liefert einen Iterator vom Typ MonthIterator.
static java.util.Iterator	getIterator(int range, java.util.Locale locale) Liefert einen Iterator vom Typ MonthIterator.
java.util.Date	getLast() Liefert das Date-Object des letzten Tages dieses Month-Objects.
java.lang.String	getMonthName() Liefert den Klartextnamen für den Monat dieses Month-Objects.
int	getMonthNameAsInt() Liefert den Integer-Wert für den Monat dieses Month-Objects.
int	hashCode() Liefert den Hashcode nach der Formel hashcode = (Jahr * 100) + Monat.
protected void	next()
protected void	next(int amountMonth)
protected void	previous()
protected void	previous(int amountMonth)

Methods inherited from class java.lang.Object

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

Constructor Detail

Month

public Month()

Defaultkonstruktor, ruft Hauptkonstruktor Month(Date, Locale) mit aktuellen Datum und Default-Locale auf.

Month

public Month(java.util.Date date)

Nebenkonstruktor, ruft Hauptkonstruktor Month(Date, Locale) mit dem angebenen Datum und der Default-Locale auf.

Month

public Month(java.util.Date date,
             java.util.Locale locale)

Hauptkonstruktor zum initialisieren der internen Date-Objekte first und last.

Parameters:

date - Datum, aus dem der Monats-Erste und der Monats-Letzte errechnet wird.

locale - Locale mit der getMonthName() internationalisiert zurückgegeben wird.

Method Detail

compareTo

public int compareTo(java.lang.Object obj)

Liefert gemäß Interface java.lang.Comparable -1 für Month Objekte, wenn dieses Objekt kleiner ist, als dasübergebene, 0 für gleiche Month Objekte und +1 für größere Month Objekte.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.IllegalArgumentException - wenn das übergebene Objekt nicht vom Typ Month ist.

getFirst

public java.util.Date getFirst()

Liefert das Date-Object des ersten Tages dieses Month-Objects.

getIterator

public static java.util.Iterator getIterator()

Liefert einen Iterator vom Typ MonthIterator mit der Default-Locale.

getIterator

public static java.util.Iterator getIterator(java.util.Date from,
                                             java.util.Date to,
                                             java.util.Locale locale)

Liefert einen Iterator vom Typ MonthIterator.

Parameters:

from - Anfangsdatum, an dem der Iterator starten soll.

to - Enddatum, an dem der Iterator enden soll.

locale - Locale mit der getMonthName() internationalisiert zurückgegeben wird.

getIterator

public static java.util.Iterator getIterator(java.util.Date from,
                                             int range,
                                             java.util.Locale locale)

Liefert einen Iterator vom Typ MonthIterator.

Parameters:

from -

range - Anzahl der Monate bzw Iteratioen, über die der Iterator in die Zukunft laufen soll, bzw nach denen der Iterator enden soll.

locale - Locale mit der getMonthName() internationalisiert zurückgegeben wird.

getIterator

public static java.util.Iterator getIterator(java.util.Date from,
                                             java.util.Locale locale)

Liefert einen Iterator vom Typ MonthIterator.

Parameters:

from - Anfangsdatum, an dem der Iterator starten soll.

locale - Locale mit der getMonthName() internationalisiert zurückgegeben wird.

getIterator

public static java.util.Iterator getIterator(int range,
                                             java.util.Locale locale)

Liefert einen Iterator vom Typ MonthIterator.

Parameters:

range - Anzahl der Monate bzw Iteratioen, über die der Iterator in die Zukunft laufen soll, bzw nach denen der Iterator enden soll.

locale - Locale mit der getMonthName() internationalisiert zurückgegeben wird.

getLast

public java.util.Date getLast()

Liefert das Date-Object des letzten Tages dieses Month-Objects.

getMonthName

public java.lang.String getMonthName()

Liefert den Klartextnamen für den Monat dieses Month-Objects. Die Locale wird vom Konstruktor bestimmt.

getMonthNameAsInt

public int getMonthNameAsInt()

Liefert den Integer-Wert für den Monat dieses Month-Objects.

hashCode

public int hashCode()

Liefert den Hashcode nach der Formel hashcode = (Jahr * 100) + Monat.

next

protected void next()

next

protected void next(int amountMonth)

previous

protected void previous()

previous

protected void previous(int amountMonth)