xref: /aosp_15_r20/external/gturri-jISO8601/README.md (revision 03a4fcd472b80069eaa5dc5a5ad326530da12b91)
1Overview
2========
3jISO8601 is yet another library made to parse dates in Java. It may still be useful since:
4
5* It's trivial to use
6* It's lightweight
7* It's compatible with Android
8* It can parse any date compatible with the norm
9
10
11Getting started
12===============
13
14There are only two public methods:
15
16    import fr.turri.jiso8601.*;
17    ...
18    Calendar cal = Iso8601Deserializer.toCalendar("1985-03-04");
19    Date date = Iso8601Deserializer.toDate("1985-03-04T12:34:56Z");
20
21
22Each type of ISO8601 dates are supported (calendar, ordinal and week dates, basic and extended format)
23as weel as each format of hour and timezone.
24
25Installation
26============
27Using it with maven
28-------------------
29This package will soon be available on maven central. For now it needs to be build from source.
30For instance, on Ubuntu:
31
32    git clone https://github.com/gturri/jiso8601
33    cd jiso8601
34    sudo apt-get install maven
35    mvn install
36
37Then, in your pom.xml, add
38
39```xml
40<dependency>
41    <groupId>fr.turri</groupId>
42    <artifactId>jISO8601</artifactId>
43    <version>0.1</version>
44</dependency>
45```
46
47Out of scope (for now)
48=====================
49Recurring time interval and Periods aren't supported. Feel free to open feature requests.
50