net.time4j.calendar

Enum PersianCalendar.Unit

java.lang.Object

java.lang.Enum<PersianCalendar.Unit>

net.time4j.calendar.PersianCalendar.Unit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PersianCalendar.Unit>, ChronoUnit

Enclosing class:

PersianCalendar

public static enum PersianCalendar.Unit
extends java.lang.Enum<PersianCalendar.Unit>
implements ChronoUnit

Defines some calendar units for the Persian calendar.

Since:

3.9/4.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS
MONTHS
WEEKS
YEARS

Method Summary

Modifier and Type	Method and Description
int	between(PersianCalendar start, PersianCalendar end) Calculates the difference between given Persian dates in this unit.
double	getLength() Defines the typical length of this time unit in seconds without taking into account anomalies like timezone effects or leap seconds.
boolean	isCalendrical() Queries if this time unit is calendrical respective is at least as long as a calendar day.
static PersianCalendar.Unit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersianCalendar.Unit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YEARS

public static final PersianCalendar.Unit YEARS

MONTHS

public static final PersianCalendar.Unit MONTHS

WEEKS

public static final PersianCalendar.Unit WEEKS

DAYS

public static final PersianCalendar.Unit DAYS

Method Detail

values

public static PersianCalendar.Unit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PersianCalendar.Unit c : PersianCalendar.Unit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PersianCalendar.Unit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLength

public double getLength()

Description copied from interface: ChronoUnit

Defines the typical length of this time unit in seconds without taking into account anomalies like timezone effects or leap seconds.

Important note: This method can only yield an estimated value and is not intended to assist in calculations of durations, but only in sorting of units.

Specified by:

getLength in interface ChronoUnit

Returns:

estimated decimal value in seconds

isCalendrical

public boolean isCalendrical()

Description copied from interface: ChronoUnit

Queries if this time unit is calendrical respective is at least as long as a calendar day.

Implementation note: The method must be consistent with the typical length of the unit. The expression Double.compare(unit.getLength(), 86400.0) >= 0 is equivalent to unit.isCalendrical().

Specified by:

isCalendrical in interface ChronoUnit

Returns:

true if at least as long as a day else false

between

public int between(PersianCalendar start,
                   PersianCalendar end)

Calculates the difference between given Persian dates in this unit.

Parameters:

start - start date (inclusive)

end - end date (exclusive)

Returns:

difference counted in this unit

Since:

3.9/4.6