java.lang.Object | |
↳ | android.text.format.DateFormat |
Utility class for producing strings with formatted date/time.
Most callers should avoid supplying their own format strings to this
class' format
methods and rely on the correctly localized ones
supplied by the system. This class' factory methods return
appropriately-localized DateFormat
instances, suitable
for both formatting and parsing dates. For the canonical documentation
of format strings, see SimpleDateFormat
.
In cases where the system does not provide a suitable pattern,
this class offers the getBestDateTimePattern(Locale, String)
method.
The format
methods in this class implement a subset of Unicode
UTS #35 patterns.
The subset currently supported by this class includes the following format characters:
acdEHhLKkLMmsyz
. Up to API level 17, only adEhkMmszy
were supported.
Note that this class incorrectly implements k
as if it were H
for backwards
compatibility.
See SimpleDateFormat
for more documentation
about patterns, or if you need a more complete or correct implementation.
Note that the non-format
methods in this class are implemented by
SimpleDateFormat
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
char | AM_PM |
This constant was deprecated
in API level 18.
Use a literal 'a' instead. |
|||||||||
char | CAPITAL_AM_PM |
This constant was deprecated
in API level 18.
Use a literal 'a' instead; 'A' was always equivalent to 'a'. |
|||||||||
char | DATE |
This constant was deprecated
in API level 18.
Use a literal 'd' instead. |
|||||||||
char | DAY |
This constant was deprecated
in API level 18.
Use a literal 'E' instead. |
|||||||||
char | HOUR |
This constant was deprecated
in API level 18.
Use a literal 'h' instead. |
|||||||||
char | HOUR_OF_DAY |
This constant was deprecated
in API level 18.
Use a literal 'H' (for compatibility with SimpleDateFormat
and Unicode) or 'k' (for compatibility with Android releases up to and including
Jelly Bean MR-1) instead. Note that the two are incompatible.
|
|||||||||
char | MINUTE |
This constant was deprecated
in API level 18.
Use a literal 'm' instead. |
|||||||||
char | MONTH |
This constant was deprecated
in API level 18.
Use a literal 'M' instead. |
|||||||||
char | QUOTE |
This constant was deprecated
in API level 18.
Use a literal ' instead. |
|||||||||
char | SECONDS |
This constant was deprecated
in API level 18.
Use a literal 's' instead. |
|||||||||
char | STANDALONE_MONTH |
This constant was deprecated
in API level 18.
Use a literal 'L' instead. |
|||||||||
char | TIME_ZONE |
This constant was deprecated
in API level 18.
Use a literal 'z' instead. |
|||||||||
char | YEAR |
This constant was deprecated
in API level 18.
Use a literal 'y' instead. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Given a format string and a
Calendar object, returns a CharSequence
containing the requested date. | |||||||||||
Given a format string and a
Date object, returns a CharSequence containing
the requested date. | |||||||||||
Given a format string and a time in milliseconds since Jan 1, 1970 GMT, returns a
CharSequence containing the requested date.
| |||||||||||
Returns the best possible localized form of the given skeleton for the given
locale.
| |||||||||||
Returns a
DateFormat object that can format the date
in short form (such as 12/31/1999) according
to the current locale and the user's date-order preference. | |||||||||||
Gets the current date format stored as a char array.
| |||||||||||
Returns a
DateFormat object that can format the date
in long form (such as Monday, January 3, 2000 ) for the current locale. | |||||||||||
Returns a
DateFormat object that can format the date
in medium form (such as Jan 3, 2000 ) for the current locale. | |||||||||||
Returns a
DateFormat object that can format the time according
to the current locale and the user's 12-/24-hour clock preference. | |||||||||||
Returns true if user preference is set to 24-hour format.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
This constant was deprecated
in API level 18.
Use a literal 'a'
instead.
This constant was deprecated
in API level 18.
Use a literal 'a'
instead; 'A' was always equivalent to 'a'.
This constant was deprecated
in API level 18.
Use a literal 'd'
instead.
This constant was deprecated
in API level 18.
Use a literal 'E'
instead.
This constant was deprecated
in API level 18.
Use a literal 'h'
instead.
This constant was deprecated
in API level 18.
Use a literal 'H'
(for compatibility with SimpleDateFormat
and Unicode) or 'k'
(for compatibility with Android releases up to and including
Jelly Bean MR-1) instead. Note that the two are incompatible.
This constant was deprecated
in API level 18.
Use a literal 'm'
instead.
This constant was deprecated
in API level 18.
Use a literal 'M'
instead.
This constant was deprecated
in API level 18.
Use a literal '
instead.
This constant was deprecated
in API level 18.
Use a literal 's'
instead.
This constant was deprecated
in API level 18.
Use a literal 'L'
instead.
This constant was deprecated
in API level 18.
Use a literal 'z'
instead.
This constant was deprecated
in API level 18.
Use a literal 'y'
instead.
Given a format string and a Calendar
object, returns a CharSequence
containing the requested date.
inFormat | the format string, as described in DateFormat |
---|---|
inDate | the date to format |
CharSequence
containing the requested text
Given a format string and a Date
object, returns a CharSequence containing
the requested date.
inFormat | the format string, as described in DateFormat |
---|---|
inDate | the date to format |
CharSequence
containing the requested text
Given a format string and a time in milliseconds since Jan 1, 1970 GMT, returns a CharSequence containing the requested date.
inFormat | the format string, as described in DateFormat |
---|---|
inTimeInMillis | in milliseconds since Jan 1, 1970 GMT |
CharSequence
containing the requested text
Returns the best possible localized form of the given skeleton for the given locale. A skeleton is similar to, and uses the same format characters as, a Unicode UTS #35 pattern.
One difference is that order is irrelevant. For example, "MMMMd" will return
"MMMM d" in the en_US
locale, but "d. MMMM" in the de_CH
locale.
Note also in that second example that the necessary punctuation for German was
added. For the same input in es_ES
, we'd have even more extra text:
"d 'de' MMMM".
This method will automatically correct for grammatical necessity. Given the
same "MMMMd" input, this method will return "d LLLL" in the fa_IR
locale,
where stand-alone months are necessary. Lengths are preserved where meaningful,
so "Md" would give a different result to "MMMd", say, except in a locale such as
ja_JP
where there is only one length of month.
This method will only return patterns that are in CLDR, and is useful whenever you know what elements you want in your format string but don't want to make your code specific to any one locale.
locale | the locale into which the skeleton should be localized |
---|---|
skeleton | a skeleton as described above |
SimpleDateFormat
.
Returns a DateFormat
object that can format the date
in short form (such as 12/31/1999) according
to the current locale and the user's date-order preference.
context | the application context |
---|
DateFormat
object that properly formats the date.
Gets the current date format stored as a char array. The array will contain
3 elements (DATE
, MONTH
, and YEAR
) in the order
specified by the user's format preference. Note that this order is
only appropriate for all-numeric dates; spelled-out (MEDIUM and LONG)
dates will generally contain other punctuation, spaces, or words,
not just the day, month, and year, and not necessarily in the same
order returned here.
Returns a DateFormat
object that can format the date
in long form (such as Monday, January 3, 2000
) for the current locale.
context | the application context |
---|
DateFormat
object that formats the date in long form.
Returns a DateFormat
object that can format the date
in medium form (such as Jan 3, 2000
) for the current locale.
context | the application context |
---|
DateFormat
object that formats the date in long form.
Returns a DateFormat
object that can format the time according
to the current locale and the user's 12-/24-hour clock preference.
context | the application context |
---|
DateFormat
object that properly formats the time.
Returns true if user preference is set to 24-hour format.
context | the context to use for the content resolver |
---|