Date - Android SDK

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

Date

extends Object
implements Serializable Cloneable Comparable<Date>

java.lang.Object
↳	java.util.Date

Known Direct Subclasses

Date, Time, Timestamp

Class Overview

A specific moment in time, with millisecond precision. Values typically come from currentTimeMillis(), and are always UTC, regardless of the system's time zone. This is often called "Unix time" or "epoch time".

Instances of this class are suitable for comparison, but little else. Use DateFormat to format a Date for display to a human. Use Calendar to break down a Date if you need to extract fields such as the current month or day of week, or to construct a Date from a broken-down time. That is: this class' deprecated display-related functionality is now provided by DateFormat, and this class' deprecated computational functionality is now provided by Calendar. Both of these other classes (and their subclasses) allow you to interpret a Date in a given time zone.

Note that, surprisingly, instances of this class are mutable.

Summary

Public Constructors
	Date() Initializes this `Date` instance to the current time.
	Date(int year, int month, int day) This constructor was deprecated in API level 1. Use `GregorianCalendar(int, int, int)` instead.
	Date(int year, int month, int day, int hour, int minute) This constructor was deprecated in API level 1. Use `GregorianCalendar(int, int, int, int, int)` instead.
	Date(int year, int month, int day, int hour, int minute, int second) This constructor was deprecated in API level 1. Use `GregorianCalendar(int, int, int, int, int, int)` instead.
	Date(long milliseconds) Initializes this `Date` instance using the specified millisecond value.
	Date(String string) This constructor was deprecated in API level 1. Use `DateFormat` instead.

Public Methods
static long	UTC(int year, int month, int day, int hour, int minute, int second) This method was deprecated in API level 1. Use code like this instead:`Calendar cal = new GregorianCalendar(TimeZone.getTimeZone("GMT")); cal.set(year + 1900, month, day, hour, minute, second); cal.getTime().getTime();`
boolean	after(Date date) Returns if this `Date` is after the specified Date.
boolean	before(Date date) Returns if this `Date` is before the specified Date.
Object	clone() Returns a new `Date` with the same millisecond value as this `Date`.
int	compareTo(Date date) Compare the receiver to the specified `Date` to determine the relative ordering.
boolean	equals(Object object) Compares the specified object to this `Date` and returns if they are equal.
int	getDate() This method was deprecated in API level 1. Use `Calendar.get(Calendar.DATE)` instead.
int	getDay() This method was deprecated in API level 1. Use `Calendar.get(Calendar.DAY_OF_WEEK)` instead.
int	getHours() This method was deprecated in API level 1. Use `Calendar.get(Calendar.HOUR_OF_DAY)` instead.
int	getMinutes() This method was deprecated in API level 1. Use `Calendar.get(Calendar.MINUTE)` instead.
int	getMonth() This method was deprecated in API level 1. Use `Calendar.get(Calendar.MONTH)` instead.
int	getSeconds() This method was deprecated in API level 1. Use `Calendar.get(Calendar.SECOND)` instead.
long	getTime() Returns this `Date` as a millisecond value.
int	getTimezoneOffset() This method was deprecated in API level 1. Use `(Calendar.get(Calendar.ZONE_OFFSET) + Calendar.get(Calendar.DST_OFFSET)) / 60000` instead.
int	getYear() This method was deprecated in API level 1. Use `Calendar.get(Calendar.YEAR) - 1900` instead.
int	hashCode() Returns an integer hash code for the receiver.
static long	parse(String string) This method was deprecated in API level 1. Use `DateFormat` instead.
void	setDate(int day) This method was deprecated in API level 1. Use `Calendar.set(Calendar.DATE, day)` instead.
void	setHours(int hour) This method was deprecated in API level 1. Use `Calendar.set(Calendar.HOUR_OF_DAY, hour)` instead.
void	setMinutes(int minute) This method was deprecated in API level 1. Use `Calendar.set(Calendar.MINUTE, minute)` instead.
void	setMonth(int month) This method was deprecated in API level 1. Use `Calendar.set(Calendar.MONTH, month)` instead.
void	setSeconds(int second) This method was deprecated in API level 1. Use `Calendar.set(Calendar.SECOND, second)` instead.
void	setTime(long milliseconds) Sets this `Date` to the specified millisecond value.
void	setYear(int year) This method was deprecated in API level 1. Use `Calendar.set(Calendar.YEAR, year + 1900)` instead.
String	toGMTString() This method was deprecated in API level 1. Use `DateFormat` instead.
String	toLocaleString() This method was deprecated in API level 1. Use `DateFormat` instead.
String	toString() Returns a string representation of this `Date`.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.lang.Comparable

Public Constructors

public Date ()

Added in API level 1

Initializes this Date instance to the current time.

public Date (int year, int month, int day)

Added in API level 1

This constructor was deprecated in API level 1.
Use GregorianCalendar(int, int, int) instead.

Constructs a new Date initialized to midnight in the default TimeZone on the specified date.

Parameters

year	the year, 0 is 1900.
month	the month, 0 - 11.
day	the day of the month, 1 - 31.

public Date (int year, int month, int day, int hour, int minute)

Added in API level 1

This constructor was deprecated in API level 1.
Use GregorianCalendar(int, int, int, int, int) instead.

Constructs a new Date initialized to the specified date and time in the default TimeZone.

Parameters

year	the year, 0 is 1900.
month	the month, 0 - 11.
day	the day of the month, 1 - 31.
hour	the hour of day, 0 - 23.
minute	the minute of the hour, 0 - 59.

public Date (int year, int month, int day, int hour, int minute, int second)

Added in API level 1

This constructor was deprecated in API level 1.
Use GregorianCalendar(int, int, int, int, int, int) instead.

Constructs a new Date initialized to the specified date and time in the default TimeZone.

Parameters

year	the year, 0 is 1900.
month	the month, 0 - 11.
day	the day of the month, 1 - 31.
hour	the hour of day, 0 - 23.
minute	the minute of the hour, 0 - 59.
second	the second of the minute, 0 - 59.

public Date (long milliseconds)

Added in API level 1

Initializes this Date instance using the specified millisecond value. The value is the number of milliseconds since Jan. 1, 1970 GMT.

Parameters

milliseconds	the number of milliseconds since Jan. 1, 1970 GMT.

public Date (String string)

Added in API level 1

This constructor was deprecated in API level 1.
Use DateFormat instead.

Constructs a new Date initialized to the date and time parsed from the specified String.

Parameters

string	the String to parse.

Public Methods

public static long UTC (int year, int month, int day, int hour, int minute, int second)

Added in API level 1

This method was deprecated in API level 1.
Use code like this instead:Calendar cal = new GregorianCalendar(TimeZone.getTimeZone("GMT")); cal.set(year + 1900, month, day, hour, minute, second); cal.getTime().getTime();

Returns the millisecond value of the specified date and time in GMT.

Parameters

year	the year, 0 is 1900.
month	the month, 0 - 11.
day	the day of the month, 1 - 31.
hour	the hour of day, 0 - 23.
minute	the minute of the hour, 0 - 59.
second	the second of the minute, 0 - 59.

Returns

the date and time in GMT in milliseconds.

public boolean after (Date date)

Added in API level 1

Returns if this Date is after the specified Date.

Parameters

date	a Date instance to compare.

Returns

true if this Date is after the specified Date, false otherwise.

public boolean before (Date date)

Added in API level 1

Returns if this Date is before the specified Date.

Parameters

date	a `Date` instance to compare.

Returns

true if this Date is before the specified Date, false otherwise.

public Object clone ()

Added in API level 1

Returns a new Date with the same millisecond value as this Date.

Returns

a shallow copy of this Date.

public int compareTo (Date date)

Added in API level 1

Compare the receiver to the specified Date to determine the relative ordering.

Parameters

date	a `Date` to compare against.

Returns

an int < 0 if this Date is less than the specified Date, 0 if they are equal, and an int > 0 if this Date is greater.

public boolean equals (Object object)

Added in API level 1

Compares the specified object to this Date and returns if they are equal. To be equal, the object must be an instance of Date and have the same millisecond value.

Parameters

object	the object to compare with this object.

Returns

true if the specified object is equal to this Date, false otherwise.

public int getDate ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.DATE) instead.

Returns the gregorian calendar day of the month for this Date object.

Returns

the day of the month.

public int getDay ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.DAY_OF_WEEK) instead.

Returns the gregorian calendar day of the week for this Date object.

Returns

the day of the week.

public int getHours ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.HOUR_OF_DAY) instead.

Returns the gregorian calendar hour of the day for this Date object.

Returns

the hour of the day.

public int getMinutes ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.MINUTE) instead.

Returns the gregorian calendar minute of the hour for this Date object.

Returns

the minutes.

public int getMonth ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.MONTH) instead.

Returns the gregorian calendar month for this Date object.

Returns

the month.

public int getSeconds ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.SECOND) instead.

Returns the gregorian calendar second of the minute for this Date object.

Returns

the seconds.

public long getTime ()

Added in API level 1

Returns this Date as a millisecond value. The value is the number of milliseconds since Jan. 1, 1970, midnight GMT.

Returns

the number of milliseconds since Jan. 1, 1970, midnight GMT.

public int getTimezoneOffset ()

Added in API level 1

This method was deprecated in API level 1.
Use (Calendar.get(Calendar.ZONE_OFFSET) + Calendar.get(Calendar.DST_OFFSET)) / 60000 instead.

Returns the timezone offset in minutes of the default TimeZone.

Returns

the timezone offset in minutes of the default TimeZone.

public int getYear ()

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.get(Calendar.YEAR) - 1900 instead.

Returns the gregorian calendar year since 1900 for this Date object.

Returns

the year - 1900.

public int hashCode ()

Added in API level 1

Returns an integer hash code for the receiver. Objects which are equal return the same value for this method.

Returns

this Date's hash.

public static long parse (String string)

Added in API level 1

This method was deprecated in API level 1.
Use DateFormat instead.

Returns the millisecond value of the date and time parsed from the specified String. Many date/time formats are recognized, including IETF standard syntax, i.e. Tue, 22 Jun 1999 12:16:00 GMT-0500

Parameters

string	the String to parse.

Returns

the millisecond value parsed from the String.

public void setDate (int day)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.DATE, day) instead.

Sets the gregorian calendar day of the month for this Date object.

Parameters

day	the day of the month.

public void setHours (int hour)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.HOUR_OF_DAY, hour) instead.

Sets the gregorian calendar hour of the day for this Date object.

Parameters

hour	the hour of the day.

public void setMinutes (int minute)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.MINUTE, minute) instead.

Sets the gregorian calendar minute of the hour for this Date object.

Parameters

minute	the minutes.

public void setMonth (int month)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.MONTH, month) instead.

Sets the gregorian calendar month for this Date object.

Parameters

month	the month.

public void setSeconds (int second)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.SECOND, second) instead.

Sets the gregorian calendar second of the minute for this Date object.

Parameters

second	the seconds.

public void setTime (long milliseconds)

Added in API level 1

Sets this Date to the specified millisecond value. The value is the number of milliseconds since Jan. 1, 1970 GMT.

Parameters

milliseconds	the number of milliseconds since Jan. 1, 1970 GMT.

public void setYear (int year)

Added in API level 1

This method was deprecated in API level 1.
Use Calendar.set(Calendar.YEAR, year + 1900) instead.

Sets the gregorian calendar year since 1900 for this Date object.

Parameters

year	the year since 1900.

public String toGMTString ()

Added in API level 1

This method was deprecated in API level 1.
Use DateFormat instead.

Returns the string representation of this Date in GMT in the format "22 Jun 1999 13:02:00 GMT".

public String toLocaleString ()

Added in API level 1

This method was deprecated in API level 1.
Use DateFormat instead.

Returns the string representation of this Date for the default Locale.

public String toString ()

Added in API level 1

Returns a string representation of this Date. The formatting is equivalent to using a SimpleDateFormat with the format string "EEE MMM dd HH:mm:ss zzz yyyy", which looks something like "Tue Jun 22 13:07:00 PDT 1999". While the current default time zone is used, all formatting and timezone names follow Locale.US. If you need control over the time zone or locale, use SimpleDateFormat instead.

Returns

a printable representation of this object.

Results

Interfaces

Classes

Enums

Exceptions

Errors

Date

Class Overview

Summary

Public Constructors

public Date ()

public Date (int year, int month, int day)

Parameters

public Date (int year, int month, int day, int hour, int minute)

Parameters

public Date (int year, int month, int day, int hour, int minute, int second)

Parameters

public Date (long milliseconds)

Parameters

public Date (String string)

Parameters

Public Methods

public static long UTC (int year, int month, int day, int hour, int minute, int second)

Parameters

Returns

public boolean after (Date date)

Parameters

Returns

public boolean before (Date date)

Parameters

Returns

public Object clone ()

Returns

See Also

public int compareTo (Date date)

Parameters

Returns

public boolean equals (Object object)

Parameters

Returns

See Also

public int getDate ()

Returns

public int getDay ()

Returns

public int getHours ()

Returns

public int getMinutes ()

Returns

public int getMonth ()

Returns

public int getSeconds ()

Returns

public long getTime ()

Returns

public int getTimezoneOffset ()

Returns

public int getYear ()

Returns

public int hashCode ()

Returns

See Also

public static long parse (String string)

Parameters

Returns

public void setDate (int day)

Parameters

public void setHours (int hour)

Parameters

public void setMinutes (int minute)

Parameters

public void setMonth (int month)

Parameters

public void setSeconds (int second)

Parameters

public void setTime (long milliseconds)

Parameters

public void setYear (int year)

Parameters

public String toGMTString ()