org.threeten.extra

Class Temporals

java.lang.Object

org.threeten.extra.Temporals

public final class Temporals
extends Object

Additional utilities for working with temporal classes.

This currently contains adjusters that ignore Saturday/Sunday weekends.

Implementation Requirements:

This is a thread-safe utility class. All returned classes are immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
static java.time.temporal.ChronoUnit	chronoUnit(TimeUnit unit) Converts a TimeUnit to a ChronoUnit.
static long[]	convertAmount(long amount, java.time.temporal.TemporalUnit fromUnit, java.time.temporal.TemporalUnit toUnit) Converts an amount from one unit to another.
static java.time.temporal.TemporalAdjuster	nextWorkingDay() Returns an adjuster that returns the next working day, ignoring Saturday and Sunday.
static java.time.temporal.TemporalAdjuster	previousWorkingDay() Returns an adjuster that returns the previous working day, ignoring Saturday and Sunday.
static TimeUnit	timeUnit(java.time.temporal.ChronoUnit unit) Converts a ChronoUnit to a TimeUnit.

Methods inherited from class java.lang.Object

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

Method Detail

nextWorkingDay

public static java.time.temporal.TemporalAdjuster nextWorkingDay()

Returns an adjuster that returns the next working day, ignoring Saturday and Sunday.

Some territories have weekends that do not consist of Saturday and Sunday. No implementation is supplied to support this, however an adjuster can be easily written to do so.

Returns:

the next working day adjuster, not null

previousWorkingDay

public static java.time.temporal.TemporalAdjuster previousWorkingDay()

Returns an adjuster that returns the previous working day, ignoring Saturday and Sunday.

Some territories have weekends that do not consist of Saturday and Sunday. No implementation is supplied to support this, however an adjuster can be easily written to do so.

Returns:

the previous working day adjuster, not null

chronoUnit

public static java.time.temporal.ChronoUnit chronoUnit(TimeUnit unit)

Converts a TimeUnit to a ChronoUnit.

This handles the seven units declared in TimeUnit.

Parameters:

unit - the unit to convert, not null

Returns:

the converted unit, not null

timeUnit

public static TimeUnit timeUnit(java.time.temporal.ChronoUnit unit)

Converts a ChronoUnit to a TimeUnit.

This handles the seven units declared in TimeUnit.

Parameters:

unit - the unit to convert, not null

Returns:

the converted unit, not null

Throws:

IllegalArgumentException - if the unit cannot be converted

convertAmount

public static long[] convertAmount(long amount,
                                   java.time.temporal.TemporalUnit fromUnit,
                                   java.time.temporal.TemporalUnit toUnit)

Converts an amount from one unit to another.

This works on the units in ChronoUnit and IsoFields. The DAYS and WEEKS units are handled as exact multiple of 24 hours. The ERAS and FOREVER units are not supported.

Parameters:

amount - the input amount in terms of the fromUnit

fromUnit - the unit to convert from, not null

toUnit - the unit to convert to, not null

Returns:

the conversion array, element 0 is the signed whole number, element 1 is the signed remainder in terms of the input unit, not null

Throws:

java.time.DateTimeException - if the units cannot be converted

java.time.temporal.UnsupportedTemporalTypeException - if the units are not supported

ArithmeticException - if numeric overflow occurs