Package org.lukashian

Class Formatter

java.lang.Object

org.lukashian.Formatter

public final class Formatter
extends Object

Provides methods for formatting instances of the Lukashian Calendar classes. This implementation is not as sophisticated as the Java formatting classes, but should provide sufficient functionality for most use cases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Formatter.DayFormat	Represents the different ways to format a Day.

Constructor Summary

Constructors

Constructor	Description
Formatter()

Method Summary

Modifier and Type	Method	Description
static String	format(org.apache.commons.numbers.fraction.BigFraction proportionOfDay)	Formats the given time by transforming it into an integer number between 0 (inclusive) and 9999 (inclusive), see Basis Points.
static String	format(org.apache.commons.numbers.fraction.BigFraction proportionOfDay, Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)	Formats the given time, using the given Function.
static String	format(Day day)	Formats the given Day with Formatter.DayFormat.YEAR_FIRST and '-' as a separator.
static String	format(Day day, Formatter.DayFormat format)	Formats the given Day, according to the given Formatter.DayFormat, with '-' as a separator.
static String	format(Day day, Formatter.DayFormat format, String separator)	Formats the given Day according to the given Formatter.DayFormat, using the given separator between the day and the year.
static String	format(Instant instant)	Formats the given Instant using format(Day) and format(BigFraction), using a space to separate the two.
static String	format(Instant instant, Formatter.DayFormat dayFormat, String daySeparator, Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)	Formats the given Instant using format(Day, DayFormat, String) and format(BigFraction, Function), using a space to separate the two.
static String	format(Instant instant, Formatter.DayFormat dayFormat, Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)	Formats the given Instant using format(Day, DayFormat) and format(BigFraction, Function), using a space to separate the two.
static String	format(Year year)	Formats the given year by simply returning the year as a String.

Methods inherited from class java.lang.Object

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

Constructor Details

Formatter

public Formatter()

Method Details

format

public static String format(Year year)

Formats the given year by simply returning the year as a String.

format

public static String format(Day day,
 Formatter.DayFormat format,
 String separator)

Formats the given Day according to the given Formatter.DayFormat, using the given separator between the day and the year. If Formatter.DayFormat.EPOCH or Formatter.DayFormat.DAY_ONLY is chosen, then the separator is not used.

format

public static String format(Day day,
 Formatter.DayFormat format)

Formats the given Day, according to the given Formatter.DayFormat, with '-' as a separator. If Formatter.DayFormat.EPOCH or Formatter.DayFormat.DAY_ONLY is chosen, then the separator is not used.

format

public static String format(Day day)

Formats the given Day with Formatter.DayFormat.YEAR_FIRST and '-' as a separator.

format

public static String format(org.apache.commons.numbers.fraction.BigFraction proportionOfDay,
 Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)

Formats the given time, using the given Function.

format

public static String format(org.apache.commons.numbers.fraction.BigFraction proportionOfDay)

Formats the given time by transforming it into an integer number between 0 (inclusive) and 9999 (inclusive), see Basis Points.

For a detailed explanation on how the proportion is interpreted, see Instant.getBeeps().

format

public static String format(Instant instant,
 Formatter.DayFormat dayFormat,
 String daySeparator,
 Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)

Formats the given Instant using format(Day, DayFormat, String) and format(BigFraction, Function), using a space to separate the two.

format

public static String format(Instant instant,
 Formatter.DayFormat dayFormat,
 Function<org.apache.commons.numbers.fraction.BigFraction,String> formatter)

Formats the given Instant using format(Day, DayFormat) and format(BigFraction, Function), using a space to separate the two.

format

public static String format(Instant instant)

Formats the given Instant using format(Day) and format(BigFraction), using a space to separate the two.