https://github.com/mfathi91/persian-date-time

Persian Date Time
https://github.com/mfathi91/persian-date-time

calendar gregorian immutable iranian-calendar jalali-calendar java persian-calendar persian-datetime persiandate

Last synced: about 2 months ago
JSON representation

Persian Date Time

• Host: GitHub
• URL: https://github.com/mfathi91/persian-date-time
• Owner: mfathi91
• License: mit
• Created: 2017-09-28T18:42:01.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-12T22:39:41.000Z (over 2 years ago)
• Last Synced: 2024-02-15T21:35:22.203Z (5 months ago)
• Topics: calendar, gregorian, immutable, iranian-calendar, jalali-calendar, java, persian-calendar, persian-datetime, persiandate
• Language: Java
• Homepage:
• Size: 141 KB
• Stars: 75
• Watchers: 2
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-persian - persian-date-time - کتابخانه گاه‌شماره پارسی

README

        
![Persian Date Time](https://user-images.githubusercontent.com/29010410/41397561-dc9a470a-6fc9-11e8-923a-112393900b0c.JPG)

----------------------------------------------------

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.mfathi91/persian-date-time/badge.svg)](http://search.maven.org/#search|ga|1|com.github.mfathi91)

[![codecov](https://codecov.io/gh/mfathi91/persian-date-time/branch/master/graph/badge.svg)](https://codecov.io/gh/mfathi91/persian-date-time)

[![Javadocs](http://javadoc.io/badge/com.github.mfathi91/persian-date-time.svg?color=brightgreen)](http://javadoc.io/doc/com.github.mfathi91/persian-date-time)

This library is an implementation of [Solar Hijri calendar](https://en.wikipedia.org/wiki/Solar_Hijri_calendar) (also known as Jalali calendar or Persian calendar). It is an immutable and thread-safe implementation of Persian calendar system, and can be used in multi-threaded programs.

As Java does not support Persian calendar, this library can be used in the applications that need Persian calendar system. Purpose of this library is to provide an immutable and easy API (that is similar to JDK 8 date and time API) for Persian calendar system. This class has been implemented the same as internal JDK calendars such as JapaneseDate.

## Instructions

### Maven

Include the following to your dependency list:

```xml

  com.github.mfathi91

  persian-date-time

  4.2.1

```

### Usage

`PersianDate`: The base class for Persian date handling. Here are some trivial examples on how to use different 

functionalities of `PersianDate`

```java

// Instantiate 

PersianDate today = PersianDate.now();

PersianDate persianDate1 = PersianDate.of(1396, 7, 15);

PersianDate persianDate2 = PersianDate.of(1396, PersianMonth.MEHR, 15);

// Convert

PersianDate persianDate5 = PersianDate.of(1397, 5, 11);

LocalDate gregDate = persianDate.toGregorian();    // => '2018-08-02'

PersianDate persianDate6 = PersianDate.fromGregorian(gregDate);  //  => '1397/05/11'

// Parse

PersianDate persianDate3 = PersianDate.parse("1400-06-15");    // From the standard format

PersianDate persianDate4 = PersianDate.parse("1400/06/15", DateTimeFormatter.ofPattern("yyyy/MM/dd"));    // From a desired format

// Format

DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy/MM/dd");

dtf.format(PersianDate.now());    // => e.g. '1396/05/10'

```

`PersianDateTime`: A wrapper class around `PersianDate` and `LocalTime` to make the date-time handling more 

convenient. Here are some trivial examples of `PersianDateTime`

```java

// Instantiate

PersianDateTime now = PersianDateTime.now();    // => 'now' will contain the instantiated date and time

PersianDateTime persianDateTime2 = PersianDateTime.of(PersianDate.of(1400, PersianMonth.DEY, 15), LocalTime.of(17, 55, 19));

PersianDateTime persianDateTime3 = PersianDateTime.of(1400, PersianMonth.DEY, 15, 17, 55, 19);

// Parse

PersianDateTime persianDateTime4 = PersianDateTime.parse("1401-06-10T08:35:11");    // From the standard format

PersianDateTime persianDateTime5 = PersianDateTime.parse("1400-06-15_11-38-43", DateTimeFormatter.ofPattern("yyyy-MM-dd_HH-mm-ss"));    // From a desired format

// Format

DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss");

dtf.format(PersianDateTime.now());    // => e.g. '1396/05/10 14:05:11'

```

The conversion algorithm from Solar Hijri calendar to Gregorian calendar and vice versa, is adopted from [here](https://github.com/soroush/libcalendars).

### Requirements

This version of Persian Date Time requires:

 * Java SE 8

## License

This library is released under MIT license.