net.time4j.calendar.frenchrev

Enum FrenchRepublicanCalendar.Unit

java.lang.Object

java.lang.Enum<FrenchRepublicanCalendar.Unit>

net.time4j.calendar.frenchrev.FrenchRepublicanCalendar.Unit

All Implemented Interfaces:

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

Enclosing class:

FrenchRepublicanCalendar

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

Defines come calendar units for the French revolutionary calendar.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS The universal day unit.
DECADES Decades consist of ten days where complementary days will be ignored or skipped.
MONTHS The month arithmetic handles the sansculottides as extension of last month Fructidor.
WEEKS Weeks consist of seven days.
YEARS Years are defined as equinox years and not as tropical years.

Method Summary

Modifier and Type	Method and Description
long	between(FrenchRepublicanCalendar start, FrenchRepublicanCalendar end) Calculates the difference between given Indian 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 FrenchRepublicanCalendar.Unit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FrenchRepublicanCalendar.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 FrenchRepublicanCalendar.Unit YEARS

Years are defined as equinox years and not as tropical years.

MONTHS

public static final FrenchRepublicanCalendar.Unit MONTHS

The month arithmetic handles the sansculottides as extension of last month Fructidor.

The resulting date is always within a republican month. Example:

     FrenchRepublicanCalendar cal = FrenchRepublicanCalendar.of(1, Sansculottides.COMPLEMENTARY_DAY_3);
     FrenchRepublicanCalendar next = cal.plus(1, FrenchRepublicanCalendar.Unit.MONTHS);
     System.out.println(next); // French-Republic-II-01-30 (30th of Vendémiaire II)
 

DECADES

public static final FrenchRepublicanCalendar.Unit DECADES

Decades consist of ten days where complementary days will be ignored or skipped.

WEEKS

public static final FrenchRepublicanCalendar.Unit WEEKS

Weeks consist of seven days.

DAYS

public static final FrenchRepublicanCalendar.Unit DAYS

The universal day unit.

Method Detail

values

public static FrenchRepublicanCalendar.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 (FrenchRepublicanCalendar.Unit c : FrenchRepublicanCalendar.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 FrenchRepublicanCalendar.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 long between(FrenchRepublicanCalendar start,
                    FrenchRepublicanCalendar end)

Calculates the difference between given Indian dates in this unit.

Parameters:

start - start date (inclusive)

end - end date (exclusive)

Returns:

difference counted in this unit