com.github.eloyzone.jalalicalendar

Class JalaliDateFormatter

java.lang.Object

com.github.eloyzone.jalalicalendar.JalaliDateFormatter

public class JalaliDateFormatter
extends Object

Created By Eloy on 5/6/18. This class can be used for formatting an existing JalaliDate

Note: for formatting gregorian date based on LocalDate you have to use DateTimeFormatter.

Author:

Eloy (Elyas Hadizadeh Tasbiti)

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORMAT_IN_ENGLISH a flag for configuring the language of formatting.
static int	FORMAT_IN_PERSIAN a flag for configuring the language of formatting.

Constructor Summary

Constructors

Constructor and Description
JalaliDateFormatter(String pattern) constructor that sets english as a default formatting language.
JalaliDateFormatter(String pattern, int formatLanguage) constructor that sets desired language for formatting

Method Summary

Modifier and Type	Method and Description
String	format(JalaliDate jalaliDate) Returns a string that shows given jalali date in a proper formatting, it first parses the given pattern and creates some place holders for future values then it applies format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_IN_PERSIAN

public static int FORMAT_IN_PERSIAN

a flag for configuring the language of formatting.

you can call it from outside of the class for setting formatting language. usually can be used in constructor

FORMAT_IN_ENGLISH

public static int FORMAT_IN_ENGLISH

a flag for configuring the language of formatting.

you can call it from outside of the class for setting formatting language. usually can be used in constructor

Constructor Detail

JalaliDateFormatter

public JalaliDateFormatter(String pattern)

constructor that sets english as a default formatting language.

Parameters:

pattern - desired pattern.

JalaliDateFormatter

public JalaliDateFormatter(String pattern,
                           int formatLanguage)

constructor that sets desired language for formatting

Parameters:

pattern - desired pattern.

formatLanguage - shows the selected language which 1 is persian and 2 is english.

Method Detail

format

public String format(JalaliDate jalaliDate)

Returns a string that shows given jalali date in a proper formatting, it first parses the given pattern and creates some place holders for future values then it applies format.

Parameters:

jalaliDate - date that will be formatted in a proper way.

Returns:

a formatted date in a string that can be persian or english