TimeUtils
open class TimeUtils
| kotlin.Any | |
| ↳ | android.util.TimeUtils |
A class containing utility methods related to time zones.
Summary
| Public methods | |
|---|---|
| open static TimeZone! |
getTimeZone(offset: Int, dst: Boolean, when: Long, country: String!)Tries to return a time zone that would have had the specified offset and DST value at the specified moment in the specified country. |
| open static String! |
Returns a String indicating the version of the time zone database currently in use. |
| open static MutableList<String!>? |
getTimeZoneIdsForCountryCode(countryCode: String)Returns time zone IDs for time zones known to be associated with a country. |
| open static Boolean |
isTimeBetween(reference: LocalTime, start: LocalTime, end: LocalTime)This method is used to find if a clock time is inclusively between two other clock times |
Public methods
getTimeZone
open static fun getTimeZone(
offset: Int,
dst: Boolean,
when: Long,
country: String!
): TimeZone!
Tries to return a time zone that would have had the specified offset and DST value at the specified moment in the specified country. Returns null if no suitable zone could be found.
getTimeZoneDatabaseVersion
open static fun getTimeZoneDatabaseVersion(): String!
Returns a String indicating the version of the time zone database currently in use. The format of the string is dependent on the underlying time zone database implementation, but will typically contain the year in which the database was updated plus a letter from a to z indicating changes made within that year.
Time zone database updates should be expected to occur periodically due to political and legal changes that cannot be anticipated in advance. Therefore, when computing the time for a future event, applications should be aware that the results may differ following a time zone database update. This method allows applications to detect that a database change has occurred, and to recalculate any cached times accordingly.
The time zone database may be assumed to change only when the device runtime is restarted. Therefore, it is not necessary to re-query the database version during the lifetime of an activity.
getTimeZoneIdsForCountryCode
open static fun getTimeZoneIdsForCountryCode(countryCode: String): MutableList<String!>?
Returns time zone IDs for time zones known to be associated with a country.
The list returned may be different from other on-device sources like android.icu.util.TimeZone#getRegion(String) as it can be curated to avoid contentious or obsolete mappings.
| Parameters | |
|---|---|
countryCode |
String: the ISO 3166-1 alpha-2 code for the country as can be obtained using java.util.Locale#getCountry() This value cannot be null. |
| Return | |
|---|---|
MutableList<String!>? |
IDs that can be passed to java.util.TimeZone#getTimeZone(String) or similar methods, or null if the countryCode is unrecognized |
isTimeBetween
open static fun isTimeBetween(
reference: LocalTime,
start: LocalTime,
end: LocalTime
): Boolean
This method is used to find if a clock time is inclusively between two other clock times
| Parameters | |
|---|---|
reference |
LocalTime: The time of the day we want check if it is between start and end This value cannot be null. |
start |
LocalTime: The start time reference This value cannot be null. |
end |
LocalTime: The end time This value cannot be null. |
| Return | |
|---|---|
Boolean |
true if the reference time is between the two clock times, and false otherwise. |