com.github.mfathi91.time

Class PersianDateTime

java.lang.Object

com.github.mfathi91.time.PersianDateTime

All Implemented Interfaces:

java.lang.Comparable<java.time.chrono.ChronoLocalDateTime<?>>, java.time.chrono.ChronoLocalDateTime<PersianDate>, java.time.temporal.Temporal, java.time.temporal.TemporalAccessor, java.time.temporal.TemporalAdjuster

@Immutable
public final class PersianDateTime
extends java.lang.Object
implements java.time.chrono.ChronoLocalDateTime<PersianDate>

A wrapper class for PersianDate and LocalTime to encapsulate these classes in one class for the sake of simplicity and convenience.

This class is immutable and can be used in multi-threaded environments.

Author:

Mahmoud Fathi

Method Summary

Modifier and Type	Method and Description
java.time.chrono.ChronoZonedDateTime<PersianDate>	atZone(java.time.ZoneId zoneId)
int	compareTo(java.time.chrono.ChronoLocalDateTime<?> other)
boolean	equals(java.lang.Object obj)
static PersianDateTime	from(java.time.temporal.TemporalAccessor temporal) Obtains an instance of this class from the given temporal object.
static PersianDateTime	fromGregorian(java.time.LocalDateTime localDateTime) Returns a new instance of Persian date-time, where the date part of the given date-time gets converted to Persian date, and the time part of the returned date-time will remain unchanged.
long	getLong(java.time.temporal.TemporalField field) Returns the long value of this date-time for the given temporal field.
int	hashCode()
boolean	isSupported(java.time.temporal.TemporalField field)
static PersianDateTime	now() Returns an instance of this class with the actual current date and time.
static PersianDateTime	of(int year, int month, int dayOfMonth, int hour, int minute) Obtains an instance of PersianDateTime with the given parameters, having second and nanosecond set to zero.
static PersianDateTime	of(int year, int month, int dayOfMonth, int hour, int minute, int second) Obtains an instance of PersianDateTime with the given parameters, having nanosecond set to zero.
static PersianDateTime	of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond) Obtains an instance of PersianDateTime with the given parameters.
static PersianDateTime	of(int year, PersianMonth month, int dayOfMonth, int hour, int minute) Obtains an instance of PersianDateTime with the given parameters, having second and nanosecond set to zero.
static PersianDateTime	of(int year, PersianMonth month, int dayOfMonth, int hour, int minute, int second) Obtains an instance of PersianDateTime with the given parameters, having nanosecond set to zero.
static PersianDateTime	of(int year, PersianMonth month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond) Obtains an instance of PersianDateTime with the given parameters.
static PersianDateTime	of(PersianDate date, java.time.LocalTime time) Obtains a new instance of this class with the given date and time.
static PersianDateTime	parse(java.lang.CharSequence text) Parses the given string into its corresponding Persian date-time.
static PersianDateTime	parse(java.lang.CharSequence text, java.time.format.DateTimeFormatter formatter) Parses the given string with the given formatter into its corresponding Persian date-time.
java.time.chrono.ChronoLocalDateTime<PersianDate>	plus(long amountToAdd, java.time.temporal.TemporalUnit temporalUnit)
java.time.LocalDateTime	toGregorian() Returns the corresponding Gregorian date-time of this Persian date-time.
PersianDate	toLocalDate() Returns the date part of this date-time.
java.time.LocalTime	toLocalTime() Returns the time part of this date-time.
java.lang.String	toString() Returns the string representation of this date-time.
long	until(java.time.temporal.Temporal temporal, java.time.temporal.TemporalUnit temporalUnit)
java.time.chrono.ChronoLocalDateTime<PersianDate>	with(java.time.temporal.TemporalField field, long newValue)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.time.chrono.ChronoLocalDateTime

adjustInto, format, getChronology, isAfter, isBefore, isEqual, isSupported, minus, minus, plus, query, timeLineOrder, toEpochSecond, toInstant, with

Methods inherited from interface java.time.temporal.TemporalAccessor

get, range

Method Detail

now

public static PersianDateTime now()

Returns an instance of this class with the actual current date and time.

Returns:

an instance of this class with the actual current date and time

of

public static PersianDateTime of(PersianDate date,
                                 java.time.LocalTime time)

Obtains a new instance of this class with the given date and time.

Parameters:

date - the date, not null

time - the time, not null

Returns:

a new instance of this clas with the given date and time

of

public static PersianDateTime of(int year,
                                 PersianMonth month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute)

Obtains an instance of PersianDateTime with the given parameters, having second and nanosecond set to zero.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the Persian month, not null

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time

of

public static PersianDateTime of(int year,
                                 PersianMonth month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute,
                                 int second)

Obtains an instance of PersianDateTime with the given parameters, having nanosecond set to zero.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the Persian month, not null

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

second - the second of minute, from 0 to 59

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time

of

public static PersianDateTime of(int year,
                                 PersianMonth month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute,
                                 int second,
                                 int nanoOfSecond)

Obtains an instance of PersianDateTime with the given parameters.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the Persian month, not null

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

second - the second of minute, from 0 to 59

nanoOfSecond - the nanosecond of second, from 0 to 999,999,999

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time.

of

public static PersianDateTime of(int year,
                                 int month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute)

Obtains an instance of PersianDateTime with the given parameters, having second and nanosecond set to zero.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the value of month, from 1 to 12

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time.

of

public static PersianDateTime of(int year,
                                 int month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute,
                                 int second)

Obtains an instance of PersianDateTime with the given parameters, having nanosecond set to zero.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the value of month, from 1 to 12

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

second - the second of the minute, from 0 to 59

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time.

of

public static PersianDateTime of(int year,
                                 int month,
                                 int dayOfMonth,
                                 int hour,
                                 int minute,
                                 int second,
                                 int nanoOfSecond)

Obtains an instance of PersianDateTime with the given parameters.

Parameters:

year - the year to represent, from 1 to MAX_YEAR

month - the value of month, from 1 to 12

dayOfMonth - the dayOfMonth to represent, from 1 to 31

hour - the hour of the day, from 0 to 23

minute - the minute of the hour, from 0 to 59

second - the second of the minute, from 0 to 59

nanoOfSecond - the nanosecond of the second, from 0 to 999,999,999

Returns:

an instance of PersianDateTime

Throws:

java.time.DateTimeException - if the passed parameters do not form a valid date or time.

fromGregorian

public static PersianDateTime fromGregorian(java.time.LocalDateTime localDateTime)

Returns a new instance of Persian date-time, where the date part of the given date-time gets converted to Persian date, and the time part of the returned date-time will remain unchanged.

Parameters:

localDateTime - the Gregorian local date time, not null

Returns:

the corresponding Persian date-time of the given Gregorian date-time

parse

public static PersianDateTime parse(java.lang.CharSequence text)

Parses the given string into its corresponding Persian date-time. The given string is expected to have DateTimeFormatter.ISO_LOCAL_DATE_TIME. For example this is an accepted input string: 1401-06-10T08:35:11.

Parameters:

text - the input string with DateTimeFormatter.ISO_LOCAL_DATE_TIME, not null

Returns:

the corresponding Persian date-time of the given string

Throws:

java.time.DateTimeException - if the format of the given string is not DateTimeFormatter.ISO_LOCAL_DATE_TIME

See Also:

DateTimeFormatter.ISO_LOCAL_DATE_TIME

parse

public static PersianDateTime parse(java.lang.CharSequence text,
                                    java.time.format.DateTimeFormatter formatter)

Parses the given string with the given formatter into its corresponding Persian date-time.

Parameters:

text - the input string with the given formatter pattern, not null

formatter - the formatter to parse the string from, not null

Returns:

the corresponding Persian date-time of the given string

Throws:

java.time.DateTimeException - if the format of the given string is unexpected

See Also:

DateTimeFormatter

from

public static PersianDateTime from(java.time.temporal.TemporalAccessor temporal)

Obtains an instance of this class from the given temporal object.

Specified by:

from in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Parameters:

temporal - the temporal object to convert, not null

Returns:

the local date, not null

Throws:

java.time.DateTimeException - if unable to convert to a PersianDate

toLocalDate

public PersianDate toLocalDate()

Returns the date part of this date-time.

Specified by:

toLocalDate in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Returns:

the date part of this date-time.

toLocalTime

public java.time.LocalTime toLocalTime()

Returns the time part of this date-time.

Specified by:

toLocalTime in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Returns:

the time part of this date-time.

toGregorian

public java.time.LocalDateTime toGregorian()

Returns the corresponding Gregorian date-time of this Persian date-time. The transformation happens by converting the date part of the current Persian date-time to Gregorian date, and time part will remain unchanged.

Returns:

the corresponding Gregorian date-time of this Persian date-time

isSupported

public boolean isSupported(java.time.temporal.TemporalField field)

Specified by:

isSupported in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Specified by:

isSupported in interface java.time.temporal.TemporalAccessor

getLong

public long getLong(java.time.temporal.TemporalField field)

Returns the long value of this date-time for the given temporal field.

Specified by:

getLong in interface java.time.temporal.TemporalAccessor

Parameters:

field - the temporal field, not null

Returns:

the long value of this date-time for the given temporal field

See Also:

PersianDate.getLong(TemporalField), LocalTime.getLong(TemporalField)

with

public java.time.chrono.ChronoLocalDateTime<PersianDate> with(java.time.temporal.TemporalField field,
                                                              long newValue)

Specified by:

with in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Specified by:

with in interface java.time.temporal.Temporal

plus

public java.time.chrono.ChronoLocalDateTime<PersianDate> plus(long amountToAdd,
                                                              java.time.temporal.TemporalUnit temporalUnit)

Specified by:

plus in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Specified by:

plus in interface java.time.temporal.Temporal

until

public long until(java.time.temporal.Temporal temporal,
                  java.time.temporal.TemporalUnit temporalUnit)

Specified by:

until in interface java.time.temporal.Temporal

atZone

public java.time.chrono.ChronoZonedDateTime<PersianDate> atZone(java.time.ZoneId zoneId)

Specified by:

atZone in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

compareTo

public int compareTo(java.time.chrono.ChronoLocalDateTime<?> other)

Specified by:

compareTo in interface java.lang.Comparable<java.time.chrono.ChronoLocalDateTime<?>>

Specified by:

compareTo in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns the string representation of this date-time. Character 'T' will be placed between date and time, to indicate their separation. For example:

     PersianDateTime dt = PersianDateTime.of(1400, PersianMonth.AZAR, 28, 14, 20, 56);
     System.out.println(dt.toString());    // 1400-09-28T14:20:56
 

Based on the available fields for the time, the format of output string will differ.

Specified by:

toString in interface java.time.chrono.ChronoLocalDateTime<PersianDate>

Overrides:

toString in class java.lang.Object

Returns:

a suitable representation of this Persian date-time

See Also:

PersianDate.toString(), LocalTime.toString()