agi.foundation.time

(agi.foundation.core-2024r3.jar)

Class TimeStandardConverter

java.lang.Object

agi.foundation.time.TimeStandardConverter

public final class TimeStandardConverter
extends Object

Converts a JulianDate between different time standards.

Method Summary

Modifier and Type	Method and Description
static JulianDate	convert(JulianDate value, TimeStandard to) Converts the specified JulianDate to the specified TimeStandard.
static int	getConversionDistance(TimeStandard from, TimeStandard to) Gets the number of intermediate conversions that must be done to convert from from to to.
static boolean	isConversionDefined(TimeStandard from, TimeStandard to) Determines if a conversion between two TimeStandards has been defined.
static void	registerConversion(TimeStandard from, TimeStandard to, FormatConversionCallback<JulianDate,TimeStandard> conversion) Registers a new conversion between time standards.
static boolean	tryConvert(JulianDate value, TimeStandard to, JulianDate[] result) Tries to convert the specified JulianDate to the specified TimeStandard, returning success or failure.

Methods inherited from class java.lang.Object

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

Method Detail

tryConvert

public static boolean tryConvert(@Nonnull
                                 JulianDate value,
                                 @Nonnull
                                 TimeStandard to,
                                 @Nonnull
                                 JulianDate[] result)

Tries to convert the specified JulianDate to the specified TimeStandard, returning success or failure.

Parameters:

value - The JulianDate to convert.

to - The TimeStandard to convert value to.

result - On input, an array with one element. On return, the array is populated with the resulting JulianDate equivalent to value in the new TimeStandard.

Returns:

true if value could be converted to the requested TimeStandard to; otherwise false.

convert

@Nonnull
public static JulianDate convert(@Nonnull
                                           JulianDate value,
                                           @Nonnull
                                           TimeStandard to)

Converts the specified JulianDate to the specified TimeStandard.

Parameters:

value - The JulianDate to convert.

to - The TimeStandard to convert value to.

Returns:

A JulianDate equivalent to value in the new TimeStandard.

getConversionDistance

public static int getConversionDistance(@Nonnull
                                        TimeStandard from,
                                        @Nonnull
                                        TimeStandard to)

Gets the number of intermediate conversions that must be done to convert from from to to. For example, if a conversion function is defined to directly convert between the time standards, 1 will be returned. If the two standards are identical, 0 will be returned. If no conversion exists at all, Integer.MAX_VALUE will be returned.

Parameters:

from - The source time standard.

to - The destination time standard.

Returns:

The number of conversion functions that must be invoked to convert between the formats.

registerConversion

public static void registerConversion(@Nonnull
                                      TimeStandard from,
                                      @Nonnull
                                      TimeStandard to,
                                      @Nonnull
                                      FormatConversionCallback<JulianDate,TimeStandard> conversion)

Registers a new conversion between time standards.

Parameters:

from - The time standard that the conversion method converts from.

to - The time standard that the conversion method converts to.

conversion - The conversion method.

isConversionDefined

public static boolean isConversionDefined(@Nonnull
                                          TimeStandard from,
                                          @Nonnull
                                          TimeStandard to)

Determines if a conversion between two TimeStandards has been defined.

Parameters:

from - The source time standard.

to - The destination time standard.

Returns:

true if a conversion is defined; otherwise false.