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