sun.util.calendar

Class CalendarDate

java.lang.Object

sun.util.calendar.CalendarDate

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BaseCalendar.Date

public abstract class CalendarDate
extends java.lang.Object
implements java.lang.Cloneable

The CalendarDate class represents a specific instant in time by calendar date and time fields that are multiple cycles in different time unites. The semantics of each calendar field is given by a concrete calendar system rather than this CalendarDate class that holds calendar field values without interpreting them. Therefore, this class can be used to represent an amount of time, such as 2 years and 3 months.

A CalendarDate instance can be created by calling the newCalendarDate or getCalendarDate methods in CalendarSystem. A CalendarSystem instance is obtained by calling one of the factory methods in CalendarSystem. Manipulations of calendar dates must be handled by the calendar system by which CalendarDate instances have been created.

Some calendar fields can be modified through method calls. Any modification of a calendar field brings the state of a CalendarDate to not normalized. The normalization must be performed to make all the calendar fields consistent with a calendar system.

The protected methods are intended to be used for implementing a concrete calendar system, not for general use as an API.

Since:

1.5

Author:

Masayoshi Okutsu

See Also:

CalendarSystem

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_UNDEFINED
static long	TIME_UNDEFINED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CalendarDate()
protected	CalendarDate(java.util.TimeZone zone)

Method Summary

Methods

Modifier and Type	Method and Description
CalendarDate	addDate(int year, int month, int dayOfMonth)
CalendarDate	addDayOfMonth(int n)
CalendarDate	addHours(int n)
CalendarDate	addMillis(int n)
CalendarDate	addMinutes(int n)
CalendarDate	addMonth(int n)
CalendarDate	addSeconds(int n)
CalendarDate	addTimeOfDay(int hours, int minutes, int seconds, int millis)
CalendarDate	addYear(int n)
java.lang.Object	clone() Returns a copy of this CalendarDate.
boolean	equals(java.lang.Object obj)
int	getDaylightSaving()
int	getDayOfMonth()
int	getDayOfWeek() Returns the day of week value.
Era	getEra()
int	getHours()
int	getMillis()
int	getMinutes()
int	getMonth()
int	getSeconds()
long	getTimeOfDay()
int	getYear()
java.util.TimeZone	getZone()
int	getZoneOffset()
int	hashCode()
boolean	isDaylightTime()
boolean	isLeapYear() Returns whether the year represented by this CalendarDate is a leap year.
boolean	isNormalized()
boolean	isSameDate(CalendarDate date) Returns whether the specified date is the same date of this CalendarDate.
boolean	isStandardTime()
CalendarDate	setDate(int year, int month, int dayOfMonth)
protected void	setDaylightSaving(int daylightSaving)
CalendarDate	setDayOfMonth(int date)
protected void	setDayOfWeek(int dayOfWeek)
CalendarDate	setEra(Era era) Sets the era of the date to the specified era.
CalendarDate	setHours(int hours)
protected void	setLocale(java.util.Locale loc)
CalendarDate	setMillis(int millis)
CalendarDate	setMinutes(int minutes)
CalendarDate	setMonth(int month)
protected void	setNormalized(boolean normalized)
CalendarDate	setSeconds(int seconds)
void	setStandardTime(boolean standardTime)
CalendarDate	setTimeOfDay(int hours, int minutes, int seconds, int millis)
protected void	setTimeOfDay(long fraction)
CalendarDate	setYear(int year)
CalendarDate	setZone(java.util.TimeZone zoneinfo)
protected void	setZoneOffset(int offset)
java.lang.String	toString() Converts calendar date values to a String in the following format.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_UNDEFINED

public static final int FIELD_UNDEFINED

See Also:

Constant Field Values

TIME_UNDEFINED

public static final long TIME_UNDEFINED

See Also:

Constant Field Values

Constructor Detail

CalendarDate

protected CalendarDate()

CalendarDate

protected CalendarDate(java.util.TimeZone zone)

Method Detail

getEra

public Era getEra()

setEra

public CalendarDate setEra(Era era)

Sets the era of the date to the specified era. The default implementation of this method accepts any Era value, including null.

Throws:

java.lang.NullPointerException - if the calendar system for this CalendarDate requires eras and the specified era is null.

java.lang.IllegalArgumentException - if the specified era is unknown to the calendar system for this CalendarDate.

getYear

public int getYear()

setYear

public CalendarDate setYear(int year)

addYear

public CalendarDate addYear(int n)

isLeapYear

public boolean isLeapYear()

Returns whether the year represented by this CalendarDate is a leap year. If leap years are not applicable to the calendar system, this method always returns false.

If this CalendarDate hasn't been normalized, false is returned. The normalization must be performed to retrieve the correct leap year information.

Returns:

true if this CalendarDate is normalized and the year of this CalendarDate is a leap year, or false otherwise.

See Also:

BaseCalendar#isGregorianLeapYear

getMonth

public int getMonth()

setMonth

public CalendarDate setMonth(int month)

addMonth

public CalendarDate addMonth(int n)

getDayOfMonth

public int getDayOfMonth()

setDayOfMonth

public CalendarDate setDayOfMonth(int date)

addDayOfMonth

public CalendarDate addDayOfMonth(int n)

getDayOfWeek

public int getDayOfWeek()

Returns the day of week value. If this CalendarDate is not normalized, FIELD_UNDEFINED is returned.

Returns:

day of week or FIELD_UNDEFINED

getHours

public int getHours()

setHours

public CalendarDate setHours(int hours)

addHours

public CalendarDate addHours(int n)

getMinutes

public int getMinutes()

setMinutes

public CalendarDate setMinutes(int minutes)

addMinutes

public CalendarDate addMinutes(int n)

getSeconds

public int getSeconds()

setSeconds

public CalendarDate setSeconds(int seconds)

addSeconds

public CalendarDate addSeconds(int n)

getMillis

public int getMillis()

setMillis

public CalendarDate setMillis(int millis)

addMillis

public CalendarDate addMillis(int n)

getTimeOfDay

public long getTimeOfDay()

setDate

public CalendarDate setDate(int year,
                   int month,
                   int dayOfMonth)

addDate

public CalendarDate addDate(int year,
                   int month,
                   int dayOfMonth)

setTimeOfDay

public CalendarDate setTimeOfDay(int hours,
                        int minutes,
                        int seconds,
                        int millis)

addTimeOfDay

public CalendarDate addTimeOfDay(int hours,
                        int minutes,
                        int seconds,
                        int millis)

setTimeOfDay

protected void setTimeOfDay(long fraction)

isNormalized

public boolean isNormalized()

isStandardTime

public boolean isStandardTime()

setStandardTime

public void setStandardTime(boolean standardTime)

isDaylightTime

public boolean isDaylightTime()

setLocale

protected void setLocale(java.util.Locale loc)

getZone

public java.util.TimeZone getZone()

setZone

public CalendarDate setZone(java.util.TimeZone zoneinfo)

isSameDate

public boolean isSameDate(CalendarDate date)

Returns whether the specified date is the same date of this CalendarDate. The time of the day fields are ignored for the comparison.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Returns a copy of this CalendarDate. The TimeZone object, if any, is not cloned.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this CalendarDate

toString

public java.lang.String toString()

Converts calendar date values to a String in the following format.

     yyyy-MM-dd'T'HH:mm:ss.SSSz
 

Overrides:

toString in class java.lang.Object

See Also:

SimpleDateFormat

setDayOfWeek

protected void setDayOfWeek(int dayOfWeek)

setNormalized

protected void setNormalized(boolean normalized)

getZoneOffset

public int getZoneOffset()

setZoneOffset

protected void setZoneOffset(int offset)

getDaylightSaving

public int getDaylightSaving()

setDaylightSaving

protected void setDaylightSaving(int daylightSaving)