Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dustin-johnson/timezonemap
Java/Kotlin library to map locations or regions to time zones
https://github.com/dustin-johnson/timezonemap
android android-library gis java java-library kotlin kotlin-android openstreetmap timezone
Last synced: 3 months ago
JSON representation
Java/Kotlin library to map locations or regions to time zones
- Host: GitHub
- URL: https://github.com/dustin-johnson/timezonemap
- Owner: dustin-johnson
- License: mit
- Created: 2018-12-16T14:08:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T17:16:50.000Z (over 3 years ago)
- Last Synced: 2024-09-30T10:04:07.313Z (3 months ago)
- Topics: android, android-library, gis, java, java-library, kotlin, kotlin-android, openstreetmap, timezone
- Language: Java
- Homepage:
- Size: 327 KB
- Stars: 48
- Watchers: 7
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Time Zone Map
[](https://maven-badges.herokuapp.com/maven-central/us.dustinj.timezonemap/timezonemap)
[](https://travis-ci.com/dustin-johnson/timezonemap)
[](https://codecov.io/gh/dustin-johnson/timezonemap/branch/master)
[](https://libraries.io/github/dustin-johnson/timezonemap)
The time zone map library provides a convenient way of determining the relevant time zone for any location on earth.
The map hails from [timezone-boundary-builder](https://github.com/evansiroky/timezone-boundary-builder),
which is derived from [OpenStreetMap](https://www.openstreetmap.org/) data. The idea, and the overall design pattern,
comes from [Timeshape](https://github.com/RomanIakovlev/timeshape).
This library seeks to:
* Present a clean and simple API.
* Be as fast and small as possible, with minimal dependencies, lending itself well to mobile applications.
* Expose the region covered by each time zone to enable custom logic.
* Handle overlapping time zones deterministically.
* Conserve memory by not loading regions that are unnecessary.
* Avoid dependencies on Java 8's time library, for mobile as well as legacy applications.
## Examples
```java
import us.dustinj.timezonemap.TimeZoneMap;
// Initialize of a region that spans from Germany to Bulgaria.
// Takes some time (~1-5 seconds) to initialize, so try and initialize only once and keep it.
TimeZoneMap map = TimeZoneMap.forRegion(43.5, 8.0, 53.00, 26.0);
String berlin = map.getOverlappingTimeZone(52.518424, 13.404776).get().getZoneId(); // Returns "Europe/Berlin"
String prague = map.getOverlappingTimeZone(50.074154, 14.437403).get().getZoneId(); // Returns "Europe/Prague"
String budapest = map.getOverlappingTimeZone(47.49642, 19.04970).get().getZoneId(); // Returns "Europe/Budapest"
String milan = map.getOverlappingTimeZone(45.466677, 9.188258).get().getZoneId(); // Returns "Europe/Rome"
String adriaticSea = map.getOverlappingTimeZone(44.337, 13.8282).get().getZoneId(); // Returns "Etc/GMT-1"
```
If you're on Java 8 or above, you can convert the returned time zone into a proper `java.util.TimeZone`:
```java
java.util.TimeZone timeZone = java.util.TimeZone.getTimeZone(berlin);
timeZone.observesDaylightTime(); // Returns true
```
## Getting the library
#### Maven
```xml
us.dustinj.timezonemap
timezonemap
4.5
```
#### Android
This library has been tested down to Android SDK 19 (KitKat 4.4), which was released in 2013.
```gradle
implementation('us.dustinj.timezonemap:timezonemap:4.5`) {
// Exclude standard compression library
exclude group: 'com.github.luben', module: 'zstd-jni'
}
// Import aar for native component compilation
implementation 'com.github.luben:zstd-jni:1.4.9-5@aar'
```
## Licenses
The code of the library is licensed under the [MIT License](https://opensource.org/licenses/MIT).
The time zone data contained in library is licensed under the [Open Data Commons Open Database License (ODbL)](http://opendatacommons.org/licenses/odbl/).