Time

open class Time

EPOCH_JULIAN_DAY

static val 
        EPOCH_JULIAN_DAY
: Int

Deprecated:

This class was deprecated in API level 21.

The Julian day of the epoch, that is, January 1, 1970 on the Gregorian calendar.
Requires API level 3 (Android 1.5, Cupcake)

Value: 2440588

FRIDAY

static val 
        FRIDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 5

HOUR

static val 
        HOUR
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 3

MINUTE

static val 
        MINUTE
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 2

MONDAY

static val 
        MONDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 1

MONDAY_BEFORE_JULIAN_EPOCH

static val 
        MONDAY_BEFORE_JULIAN_EPOCH
: Int

Deprecated:

This class was deprecated in API level 21.

The Julian day of the Monday in the week of the epoch, December 29, 1969 on the Gregorian calendar.
Requires API level 11 (Android 3.0, Honeycomb)

Value: 2440585

MONTH

static val 
        MONTH
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 5

MONTH_DAY

static val 
        MONTH_DAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 4

SATURDAY

static val 
        SATURDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 6

SECOND

static val 
        SECOND
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 1

SUNDAY

static val 
        SUNDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 0

THURSDAY

static val 
        THURSDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 4

TIMEZONE_UTC

static val 
        TIMEZONE_UTC
: String

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: "UTC"

TUESDAY

static val 
        TUESDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 2

WEDNESDAY

static val 
        WEDNESDAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 3

WEEK_DAY

static val 
        WEEK_DAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 7

WEEK_NUM

static val 
        WEEK_NUM
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 9

YEAR

static val 
        YEAR
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 6

YEAR_DAY

static val 
        YEAR_DAY
: Int

Deprecated:

This class was deprecated in API level 21.

Requires API level 3 (Android 1.5, Cupcake)

Value: 8

Time(timezoneId: String!)

Time()

Time(other: Time!)

normalize

open fun 
        normalize
(ignoreDst: Boolean): Long

Deprecated:

This class was deprecated in API level 21.

Ensures the values in each field are in range. For example if the current value of this calendar is March 32, normalize() will convert it to April 1. It also fills in weekDay, yearDay, isDst and gmtoff.

If "ignoreDst" is true, then this method sets the "isDst" field to -1 (the "unknown" value) before normalizing. It then computes the time in milliseconds and sets the correct value for "isDst" if the fields resolve to a valid date / time.

See #toMillis(boolean) for more information about when to use true or false for "ignoreDst" and when -1 might be returned.
Requires API level 3 (Android 1.5, Cupcake)

Return
Long: the UTC milliseconds since the epoch, or -1

clear

open fun 
        clear
(timezoneId: String!): Unit

Deprecated:

This class was deprecated in API level 21.

Clears all values, setting the timezone to the given timezone. Sets isDst to a negative value to mean "unknown".
Requires API level 3 (Android 1.5, Cupcake)

Parameters
timezoneId	String!: the timezone to use.

parse3339

open fun 
        parse3339
(s: String!): Boolean

Deprecated:

This class was deprecated in API level 21.

Parse a time in RFC 3339 format. This method also parses simple dates (that is, strings that contain no time or time offset). For example, all of the following strings are valid:

• "2008-10-13T16:00:00.000Z"
• "2008-10-13T16:00:00.000+07:00"
• "2008-10-13T16:00:00.000-07:00"
• "2008-10-13"

If the string contains a time and time offset, then the time offset will be used to convert the time value to UTC.

If the given string contains just a date (with no time field), then the #allDay field is set to true and the #hour, #minute, and #second fields are set to zero.

Returns true if the resulting time value is in UTC time.

Requires API level 3 (Android 1.5, Cupcake)

Parameters
s	String!: the string to parse

Return
Boolean: true if the resulting time value is in UTC time

Exceptions
android.util.TimeFormatException	if s cannot be parsed.

format3339

open fun 
        format3339
(allDay: Boolean): String!

Deprecated:

This class was deprecated in API level 21.

Return a string in the RFC 3339 format.

If allDay is true, expresses the time as Y-M-D

Otherwise, if the timezone is UTC, expresses the time as Y-M-D-T-H-M-S UTC

Otherwise the time is expressed the time as Y-M-D-T-H-M-S +- GMT

Requires API level 3 (Android 1.5, Cupcake)

Return
String!: string in the RFC 3339 format.

parse

open fun 
        parse
(s: String!): Boolean

Deprecated:

This class was deprecated in API level 21.

Parses a date-time string in either the RFC 2445 format or an abbreviated format that does not include the "time" field. For example, all of the following strings are valid:

• "20081013T160000Z"
• "20081013T160000"
• "20081013"

Returns whether or not the time is in UTC (ends with Z). If the string ends with "Z" then the timezone is set to UTC. If the date-time string included only a date and no time field, then the allDay field of this Time class is set to true and the hour, minute, and second fields are set to zero; otherwise (a time field was included in the date-time string) allDay is set to false. The fields weekDay, yearDay, and gmtoff are always set to zero, and the field isDst is set to -1 (unknown). To set those fields, call #normalize(boolean) after parsing. To parse a date-time string and convert it to UTC milliseconds, do something like this:

 Time time = new Time(); String date = "20081013T160000Z"; time.parse(date); long millis = time.normalize(false); 

Requires API level 3 (Android 1.5, Cupcake)

Parameters
s	String!: the string to parse

Return
Boolean: true if the resulting time value is in UTC time

Exceptions
android.util.TimeFormatException	if s cannot be parsed.

toString

open fun 
        toString
(): String

Deprecated:

This class was deprecated in API level 21.

Return the current time in YYYYMMDDTHHMMSS<tz> format
Requires API level 3 (Android 1.5, Cupcake)

Return
String: a string representation of the object.

toMillis

open fun 
        toMillis
(ignoreDst: Boolean): Long

Deprecated:

This class was deprecated in API level 21.

Converts this time to milliseconds. Suitable for interacting with the standard java libraries. The time is in UTC milliseconds since the epoch. This does an implicit normalization to compute the milliseconds but does not change any of the fields in this Time object. If you want to normalize the fields in this Time object and also get the milliseconds then use #normalize(boolean).

If "ignoreDst" is false, then this method uses the current setting of the "isDst" field and will adjust the returned time if the "isDst" field is wrong for the given time. See the sample code below for an example of this.

If "ignoreDst" is true, then this method ignores the current setting of the "isDst" field in this Time object and will instead figure out the correct value of "isDst" (as best it can) from the fields in this Time object. The only case where this method cannot figure out the correct value of the "isDst" field is when the time is inherently ambiguous because it falls in the hour that is repeated when switching from Daylight-Saving Time to Standard Time.

Here is an example where toMillis(true) adjusts the time, assuming that DST changes at 2am on Sunday, Nov 4, 2007.

 Time time = new Time(); time.set(4, 10, 2007); // set the date to Nov 4, 2007, 12am time.normalize(false); // this sets isDst = 1 time.monthDay += 1; // changes the date to Nov 5, 2007, 12am millis = time.toMillis(false); // millis is Nov 4, 2007, 11pm millis = time.toMillis(true); // millis is Nov 5, 2007, 12am 

To avoid this problem, use toMillis(true) after adding or subtracting days or explicitly setting the "monthDay" field. On the other hand, if you are adding or subtracting hours or minutes, then you should use toMillis(false).

You should also use toMillis(false) if you want to read back the same milliseconds that you set with #set(long) or #set(Time) or after parsing a date string.

This method can return -1 when the date / time fields have been set to a local time that conflicts with available timezone information. For example, when daylight savings transitions cause an hour to be skipped: times within that hour will return -1 if isDst = -1.
Requires API level 3 (Android 1.5, Cupcake)

set

open fun 
        set
(millis: Long): Unit

Deprecated:

This class was deprecated in API level 21.

Sets the fields in this Time object given the UTC milliseconds. After this method returns, all the fields are normalized. This also sets the "isDst" field to the correct value.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
millis	Long: the time in UTC milliseconds since the epoch.

set

open fun 
        set
(that: Time!): Unit

Deprecated:

This class was deprecated in API level 21.

Copy the value of that to this Time object. No normalization happens.
Requires API level 3 (Android 1.5, Cupcake)

set

open fun 
        set
(second: Int, minute: Int, hour: Int, monthDay: Int, month: Int, year: Int): Unit

Deprecated:

This class was deprecated in API level 21.

Sets the fields. Sets weekDay, yearDay and gmtoff to 0, and isDst to -1. Call #normalize(boolean) if you need those.
Requires API level 3 (Android 1.5, Cupcake)

set

open fun 
        set
(monthDay: Int, month: Int, year: Int): Unit

Deprecated:

This class was deprecated in API level 21.

Sets the date from the given fields. Also sets allDay to true. Sets weekDay, yearDay and gmtoff to 0, and isDst to -1. Call #normalize(boolean) if you need those.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
monthDay	Int: the day of the month (in the range [1,31])
month	Int: the zero-based month number (in the range [0,11])
year	Int: the year

before

open fun 
        before
(that: Time!): Boolean

Deprecated:

This class was deprecated in API level 21.

Returns true if the time represented by this Time object occurs before the given time.

Equivalent to Time.compare(this, that) < 0. See #compare(Time, Time) for details.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
that	Time!: a given Time object to compare against

Return
Boolean: true if this time is less than the given time

setJulianDay

open fun 
        setJulianDay
(julianDay: Int): Long

Deprecated:

This class was deprecated in API level 21.

Sets the time from the given Julian day number, which must be based on the same timezone that is set in this Time object. The "gmtoff" field need not be initialized because the given Julian day may have a different GMT offset than whatever is currently stored in this Time object anyway. After this method returns all the fields will be normalized and the time will be set to 12am at the beginning of the given Julian day.

The only exception to this is if 12am does not exist for that day because of daylight saving time. For example, Cairo, Eqypt moves time ahead one hour at 12am on April 25, 2008 and there are a few other places that also change daylight saving time at 12am. In those cases, the time will be set to 1am.

Requires API level 3 (Android 1.5, Cupcake)

Parameters
julianDay	Int: the Julian day in the timezone for this Time object

Return
Long: the UTC milliseconds for the beginning of the Julian day

format

open fun 
        format
(format: String!): String!

Deprecated:

This class was deprecated in API level 21.

Print the current value given the format string provided. See man strftime for what means what. The final string must be less than 256 characters.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
format	String!: a string containing the desired format.

Return
String!: a String containing the current time expressed in the current locale.

setToNow

open fun 
        setToNow
(): Unit

Deprecated:

This class was deprecated in API level 21.

Sets the time of the given Time object to the current time.
Requires API level 3 (Android 1.5, Cupcake)

getWeekNumber

open fun 
        getWeekNumber
(): Int

Deprecated:

This class was deprecated in API level 21.

Computes the week number according to ISO 8601. The current Time object must already be normalized because this method uses the yearDay and weekDay fields.

In IS0 8601, weeks start on Monday. The first week of the year (week 1) is defined by ISO 8601 as the first week with four or more of its days in the starting year. Or equivalently, the week containing January 4. Or equivalently, the week with the year's first Thursday in it.

The week number can be calculated by counting Thursdays. Week N contains the Nth Thursday of the year.

Requires API level 3 (Android 1.5, Cupcake)

Return
Int: the ISO week number.

switchTimezone

open fun 
        switchTimezone
(timezone: String!): Unit

Deprecated:

This class was deprecated in API level 21.

Convert this time object so the time represented remains the same, but is instead located in a different timezone. This method automatically calls normalize() in some cases.

This method can return incorrect results if the date / time cannot be normalized.
Requires API level 3 (Android 1.5, Cupcake)

after

open fun 
        after
(that: Time!): Boolean

Deprecated:

This class was deprecated in API level 21.

Returns true if the time represented by this Time object occurs after the given time.

Equivalent to Time.compare(this, that) > 0. See #compare(Time, Time) for details.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
that	Time!: a given Time object to compare against

Return
Boolean: true if this time is greater than the given time

format2445

open fun 
        format2445
(): String!

Deprecated:

This class was deprecated in API level 21.

Format according to RFC 2445 DATE-TIME type.

The same as format("%Y%m%dT%H%M%S"), or format("%Y%m%dT%H%M%SZ") for a Time with a timezone set to "UTC".
Requires API level 3 (Android 1.5, Cupcake)

getActualMaximum

open fun 
        getActualMaximum
(field: Int): Int

Deprecated:

This class was deprecated in API level 21.

Return the maximum possible value for the given field given the value of the other fields. Requires that it be normalized for MONTH_DAY and YEAR_DAY.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
field	Int: one of the constants for HOUR, MINUTE, SECOND, etc.

Return
Int: the maximum value for the field.

compare

open static fun 
        compare
(a: Time!, b: Time!): Int

Deprecated:

This class was deprecated in API level 21.

Compare two Time objects and return a negative number if a is less than b, a positive number if a is greater than b, or 0 if they are equal.

This method can return an incorrect answer when the date / time fields of either Time have been set to a local time that contradicts the available timezone information.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
a	Time!: first Time instance to compare
b	Time!: second Time instance to compare

Return
Int: a negative result if a is earlier, a positive result if b is earlier, or 0 if they are equal.

Exceptions
NullPointerException	if either argument is null
IllegalArgumentException	if #allDay is true but hour, minute, and second are not 0.

getCurrentTimezone

open static fun 
        getCurrentTimezone
(): String!

Deprecated:

This class was deprecated in API level 21.

Returns the timezone string that is currently set for the device.
Requires API level 3 (Android 1.5, Cupcake)

isEpoch

open static fun 
        isEpoch
(time: Time!): Boolean

Deprecated:

This class was deprecated in API level 21.

Returns true if the day of the given time is the epoch on the Julian Calendar (January 1, 1970 on the Gregorian calendar).

This method can return an incorrect answer when the date / time fields have been set to a local time that contradicts the available timezone information.
Requires API level 3 (Android 1.5, Cupcake)

Parameters
time	Time!: the time to test

Return
Boolean: true if epoch.

getJulianDay

open static fun 
        getJulianDay
(millis: Long, gmtoff: Long): Int

Deprecated:

This class was deprecated in API level 21.

Computes the Julian day number for a point in time in a particular timezone. The Julian day for a given date is the same for every timezone. For example, the Julian day for July 1, 2008 is 2454649.

Callers must pass the time in UTC millisecond (as can be returned by #toMillis(boolean) or #normalize(boolean)) and the offset from UTC of the timezone in seconds (as might be in #gmtoff).

The Julian day is useful for testing if two events occur on the same calendar date and for determining the relative time of an event from the present ("yesterday", "3 days ago", etc.).
Requires API level 3 (Android 1.5, Cupcake)

Parameters
millis	Long: the time in UTC milliseconds
gmtoff	Long: the offset from UTC in seconds

Return
Int: the Julian day

getWeeksSinceEpochFromJulianDay

open static fun 
        getWeeksSinceEpochFromJulianDay
(julianDay: Int, firstDayOfWeek: Int): Int

Deprecated:

This class was deprecated in API level 21.

Returns the week since #EPOCH_JULIAN_DAY (Jan 1, 1970) adjusted for first day of week. This takes a julian day and the week start day and calculates which week since #EPOCH_JULIAN_DAY that day occurs in, starting at 0. *Do not* use this to compute the ISO week number for the year.
Requires API level 11 (Android 3.0, Honeycomb)

Parameters
julianDay	Int: The julian day to calculate the week number for
firstDayOfWeek	Int: Which week day is the first day of the week, see #SUNDAY

Return
Int: Weeks since the epoch

getJulianMondayFromWeeksSinceEpoch

open static fun 
        getJulianMondayFromWeeksSinceEpoch
(week: Int): Int

Deprecated:

This class was deprecated in API level 21.

Takes a number of weeks since the epoch and calculates the Julian day of the Monday for that week. This assumes that the week containing the #EPOCH_JULIAN_DAY is considered week 0. It returns the Julian day for the Monday week weeks after the Monday of the week containing the epoch.
Requires API level 11 (Android 3.0, Honeycomb)

Parameters
week	Int: Number of weeks since the epoch

Return
Int: The julian day for the Monday of the given week since the epoch

allDay

var 
        allDay
: Boolean

Deprecated:

This class was deprecated in API level 21.

True if this is an allDay event. The hour, minute, second fields are all zero, and the date is displayed the same in all time zones.
Requires API level 3 (Android 1.5, Cupcake)

gmtoff

var 
        gmtoff
: Long

Deprecated:

This class was deprecated in API level 21.

Offset in seconds from UTC including any DST offset.
Requires API level 3 (Android 1.5, Cupcake)

hour

var 
        hour
: Int

Deprecated:

This class was deprecated in API level 21.

Hour of day [0-23]
Requires API level 3 (Android 1.5, Cupcake)

isDst

var 
        isDst
: Int

Deprecated:

This class was deprecated in API level 21.

This time is in daylight savings time. One of:

• positive - in dst
• 0 - not in dst
• negative - unknown

Requires API level 3 (Android 1.5, Cupcake)

minute

var 
        minute
: Int

Deprecated:

This class was deprecated in API level 21.

Minute [0-59]
Requires API level 3 (Android 1.5, Cupcake)

month

var 
        month
: Int

Deprecated:

This class was deprecated in API level 21.

Month [0-11]
Requires API level 3 (Android 1.5, Cupcake)

monthDay

var 
        monthDay
: Int

Deprecated:

This class was deprecated in API level 21.

Day of month [1-31]
Requires API level 3 (Android 1.5, Cupcake)

second

var 
        second
: Int

Deprecated:

This class was deprecated in API level 21.

Seconds [0-61] (2 leap seconds allowed)
Requires API level 3 (Android 1.5, Cupcake)

timezone

var 
        timezone
: String!

Deprecated:

This class was deprecated in API level 21.

The timezone for this Time. Should not be null.
Requires API level 3 (Android 1.5, Cupcake)

weekDay

var 
        weekDay
: Int

Deprecated:

This class was deprecated in API level 21.

Day of week [0-6]
Requires API level 3 (Android 1.5, Cupcake)

year

var 
        year
: Int

Deprecated:

This class was deprecated in API level 21.

Year. For example, 1970.
Requires API level 3 (Android 1.5, Cupcake)

yearDay

var 
        yearDay
: Int

Deprecated:

This class was deprecated in API level 21.

Day of year [0-365]
Requires API level 3 (Android 1.5, Cupcake)