OpenJDK 27 · sun.util.calendar.CalendarDate · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private int	daylightSaving
private int	dayOfMonth
private int	dayOfWeek
private Era	era
public static final int	FIELD_UNDEFINED
private long	fraction
private int	hours
private boolean	leapYear
private int	millis
private int	minutes
private int	month
private boolean	normalized
private int	seconds
public static final long	TIME_UNDEFINED
private int	year
private TimeZone	zoneinfo
private int	zoneOffset

Access	Constructor and Description
protected	CalendarDate()
protected	CalendarDate(TimeZone zone)

Method Summary

Modifier and Type	Method and Description
public CalendarDate	addHours(int n)
public CalendarDate	addMonth(int n)
public CalendarDate	addYear(int n)
public Object	Returns: a copy of this `CalendarDate` clone() Overrides java.lang.Object.clone. Returns a copy of this `CalendarDate`.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	getDaylightSaving()
public int	getDayOfMonth()
public int	Returns: day of week or `FIELD_UNDEFINED` getDayOfWeek() Returns the day of week value.
public Era	getEra()
public int	getHours()
public int	getMillis()
public int	getMinutes()
public int	getMonth()
public int	getSeconds()
public long	getTimeOfDay()
public int	getYear()
public TimeZone	getZone()
public int	getZoneOffset()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isDaylightTime()
public boolean	Returns: `true` if this `CalendarDate` is normalized and the year of this `CalendarDate` is a leap year, or `false` otherwise. isLeapYear() Returns whether the year represented by this `CalendarDate` is a leap year.
public boolean	isNormalized()
public boolean	isSameDate(CalendarDate date) Returns whether the specified date is the same date of this `CalendarDate`.
public CalendarDate	setDate(int year, int month, int dayOfMonth)
protected void	setDaylightSaving(int daylightSaving)
public CalendarDate	setDayOfMonth(int date)
protected void	setDayOfWeek(int dayOfWeek)
public CalendarDate	setEra(Era era) Sets the era of the date to the specified era.
public CalendarDate	setHours(int hours)
pack-priv void	setLeapYear(boolean leapYear)
public CalendarDate	setMillis(int millis)
public CalendarDate	setMinutes(int minutes)
public CalendarDate	setMonth(int month)
protected void	setNormalized(boolean normalized)
public CalendarDate	setSeconds(int seconds)
public CalendarDate	setTimeOfDay(int hours, int minutes, int seconds, int millis)
protected void	setTimeOfDay(long fraction)
public CalendarDate	setYear(int year)
public CalendarDate	setZone(TimeZone zoneinfo)
protected void	setZoneOffset(int offset)
public String	toString() Overrides java.lang.Object.toString. Converts calendar date values to a `String` in the following format.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

daylightSaving	back to summary
private int daylightSaving

dayOfMonth	back to summary
private int dayOfMonth

dayOfWeek	back to summary
private int dayOfWeek

era	back to summary
private Era era

FIELD_UNDEFINED	back to summary
public static final int FIELD_UNDEFINED

fraction	back to summary
private long fraction

hours	back to summary
private int hours

leapYear	back to summary
private boolean leapYear

millis	back to summary
private int millis

minutes	back to summary
private int minutes

month	back to summary
private int month

normalized	back to summary
private boolean normalized

seconds	back to summary
private int seconds

TIME_UNDEFINED	back to summary
public static final long TIME_UNDEFINED

year	back to summary
private int year

zoneinfo	back to summary
private TimeZone zoneinfo

zoneOffset	back to summary
private int zoneOffset

CalendarDate	back to summary
protected CalendarDate()

CalendarDate	back to summary
protected CalendarDate(TimeZone zone)

Method Detail

addHours	back to summary
public CalendarDate addHours(int n)

addMonth	back to summary
public CalendarDate addMonth(int n)

addYear	back to summary
public CalendarDate addYear(int n)

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Returns a copy of this `CalendarDate`. The `TimeZone` object, if any, is not cloned. Returns:Object a copy of this `CalendarDate` Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

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

Returns:Object

a copy of this CalendarDate

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getDaylightSaving	back to summary
public int getDaylightSaving()

getDayOfMonth	back to summary
public int getDayOfMonth()

getDayOfWeek back to summary

getDayOfWeek	back to summary
public int getDayOfWeek() Returns the day of week value. If this CalendarDate is not normalized, `FIELD_UNDEFINED` is returned. Returns:int day of week or `FIELD_UNDEFINED`

public int getDayOfWeek()

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

Returns:int: day of week or FIELD_UNDEFINED

getEra	back to summary
public Era getEra()

getHours	back to summary
public int getHours()

getMillis	back to summary
public int getMillis()

getMinutes	back to summary
public int getMinutes()

getMonth	back to summary
public int getMonth()

getSeconds	back to summary
public int getSeconds()

getTimeOfDay	back to summary
public long getTimeOfDay()

getYear	back to summary
public int getYear()

getZone	back to summary
public TimeZone getZone()

getZoneOffset	back to summary
public int getZoneOffset()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

isDaylightTime	back to summary
public boolean isDaylightTime()

isLeapYear back to summary

isLeapYear	back to summary
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:boolean `true` if this `CalendarDate` is normalized and the year of this `CalendarDate` is a leap year, or `false` otherwise. See Also `CalendarUtils#isGregorianLeapYear`

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:boolean: true if this CalendarDate is normalized and the year of this CalendarDate is a leap year, or false otherwise.
See Also: CalendarUtils#isGregorianLeapYear

isNormalized	back to summary
public boolean isNormalized()

isSameDate	back to summary
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.

setDate	back to summary
public CalendarDate setDate(int year, int month, int dayOfMonth)

setDaylightSaving	back to summary
protected void setDaylightSaving(int daylightSaving)

setDayOfMonth	back to summary
public CalendarDate setDayOfMonth(int date)

setDayOfWeek	back to summary
protected void setDayOfWeek(int dayOfWeek)

setEra back to summary

setEra	back to summary
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`. Exceptions NullPointerException: if the calendar system for this `CalendarDate` requires eras and the specified era is null. IllegalArgumentException: if the specified `era` is unknown to the calendar system for this `CalendarDate`.

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.

Exceptions

NullPointerException:: if the calendar system for this CalendarDate requires eras and the specified era is null.
IllegalArgumentException:: if the specified era is unknown to the calendar system for this CalendarDate.

setHours	back to summary
public CalendarDate setHours(int hours)

setLeapYear	back to summary
pack-priv void setLeapYear(boolean leapYear)

setMillis	back to summary
public CalendarDate setMillis(int millis)

setMinutes	back to summary
public CalendarDate setMinutes(int minutes)

setMonth	back to summary
public CalendarDate setMonth(int month)

setNormalized	back to summary
protected void setNormalized(boolean normalized)

setSeconds	back to summary
public CalendarDate setSeconds(int seconds)

setTimeOfDay	back to summary
public CalendarDate setTimeOfDay(int hours, int minutes, int seconds, int millis)

setTimeOfDay	back to summary
protected void setTimeOfDay(long fraction)

setYear	back to summary
public CalendarDate setYear(int year)

setZone	back to summary
public CalendarDate setZone(TimeZone zoneinfo)

setZoneOffset	back to summary
protected void setZoneOffset(int offset)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

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

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

Annotations

@Override

See Also

java.text.SimpleDateFormat

public abstract sealed Class CalendarDate

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail