Class UTCTime

java.lang.Object

net.okapia.osid.primordium.calendaring.time.spi.AbstractTime

net.okapia.osid.primordium.calendaring.time.spi.AbstractConfigurableTime

net.okapia.osid.primordium.calendaring.time.spi.Abstract246060Time

net.okapia.osid.primordium.calendaring.time.UTCTime

All Implemented Interfaces:

Serializable, Comparable<Time>, OsidPrimitive, Time, Time, OsidPrimitive

public final class UTCTime
extends Abstract246060Time
implements Time

An implementation of a Time based on UTC using a UTCTimeDefinition. Currently, leap seconds are not supported in this class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UTCTime.UTCTimeFactory	A TimeFactory that builds UTCTime instances.
static class	UTCTime.UTCTimeSpecifier	The TimeSpecifier is used to construct UTCTimes.

Field Summary

Fields inherited from class AbstractTime

PLANCKS_IN_MICROQUECTOSECOND

Modifier and Type	Field	Description
protected static final int	PLANCKS_IN_MICROQUECTOSECOND	the plancks in microquectosecond

Constructor Summary

Constructors

Constructor	Description
UTCTime(long hour, long minute, long second)	Constructs a new UTCTime with second resolution.
UTCTime(UTCTime.UTCTimeSpecifier specifier)	Constructs a new UTCTime.

Method Summary

Modifier and Type	Method	Description
static Time	time(long hour)	Creates a time at hour resolution.
static Time	time(long hour, long minute)	Creates a time at minute resolution.
static Time	time(long hour, long minute, long second)	Creates a time at second resolution.
static Time	time(long hour, long minute, long second, BigDecimal fractionalSecond)	Creates a time with a fractional second.
static Time	time(String s)	Returns a Time parsed from a time string.
static Time	time(LocalTime localTime)	Creates a time from a Java LocalTime.
static Time	unknown()	Gets an unknown date.
static Time	valueOf(long hour)	Creates a time at hour resolution.
static Time	valueOf(long hour, long minute)	Creates a time at minute resolution.
static Time	valueOf(long hour, long minute, long second)	Creates a time at second resolution.
static Time	valueOf(long hour, long minute, long second, BigDecimal fractionalSecond)	Creates a time with a fractional second.
static Time	valueOf(String s)	Returns a Time for a time format.
static Time	valueOf(LocalTime time)	Creates a time from a Java LocalTime.

Methods inherited from class Abstract246060Time

parseTime, toString

Modifier and Type	Method	Description
protected static Time	parseTime(TimeFactory factory, String str)	Creates a Time based on a formatted string.
String	toString()	Returns a string representation of this DateTime.

Methods inherited from class AbstractConfigurableTime

compare, compareTo, denormalizeTime, equals, getTimeDefinition, getTimeFactory, hashCode, isExclusive, isGreater, isInclusive, isLess, minus, minus, parseDecimal, plus, plus, shift

Modifier and Type	Method	Description
protected int	compare(Time time1, Time time2, TimeDefinition definition)	Compares two normalized finite times.
int	compareTo(Time time)	Compares this Time with the specified Time for ordering.
final Time[]	denormalizeTime()	Returns an interval based on this Time derived by its granularity.
final boolean	equals(Object obj)	Determines if the given Time is equal to this one.
protected TimeDefinition	getTimeDefinition()	Gets the time definition.
protected TimeFactory	getTimeFactory()	Gets the time factory.
final int	hashCode()	Returns a hash code value for this Time based on the type, granularity and values.
final boolean	isExclusive(Time time)	Tests if the range of this Time, as specified by its granularity does not overlap the given Time.
boolean	isGreater(Time time)	Tests if this Time is greater than the given Time.
final boolean	isInclusive(Time time)	Tests if the range of this Time, as specified by its granularity, includes the given Time ranged by its granularity.
final boolean	isLess(Time time)	Tests if this Time is less than the given Time.
Time	minus(long amount, DateTimeResolution unit)	Subtracts a number of a clock resolution's units from this time of day, wrapping around the day.
Time	minus(Duration duration)	Subtracts a duration's clock part from this time of day, wrapping around the day.
protected static Time	parseDecimal(TimeFactory factory, String str)	Parses the decimal portion of the seconds.
Time	plus(long amount, DateTimeResolution unit)	Adds a number of a clock resolution's units to this time of day, wrapping around the day -- 23:00 plus two hours is 01:00.
Time	plus(Duration duration)	Adds a duration's clock part (hours, minutes, seconds) to this time of day, wrapping around the day.
Shift	shift(DateTimeResolution unit, long amount)	Shifts this time of day by amount units of unit, reporting any whole days that overflow so a date can absorb them.

Methods inherited from class AbstractTime

formatDecimal, formatSignificantDigits, getAttoseconds, getDecimalPlaces, getFemtoseconds, getGranularity, getGranularityMultiplier, getHour, getMicroquectoseconds, getMicroseconds, getMilliquectoseconds, getMilliseconds, getMinute, getNanoseconds, getPicoseconds, getPlanckseconds, getQuectoseconds, getRontoseconds, getSecond, getTimeType, getYoctoseconds, getZeptoseconds

Modifier and Type	Method	Description
protected static String	formatDecimal(Time time)	Formats the decimal portion of a Time.
protected static String	formatSignificantDigits(long num, int n)	Formats significant digits to a number of places.
final long	getAttoseconds()	Gets the number of attoseconds of the femtoseconds 0-999.
protected static int	getDecimalPlaces(DateTimeResolution granularity)	Gets the number of decimal places implied by a granularity.
final long	getFemtoseconds()	Gets the number of femtoseconds of the picosecond 0-999.
final DateTimeResolution	getGranularity()	Gets the granularity of this time.
final long	getGranularityMultiplier()	If the granularity of the time equals getGranularity(), then the multiplier is 1.
final long	getHour()	Gets the hour of the day 0-23.
final long	getMicroquectoseconds()	Gets the number of undaseconds of the vatosecond 0-999.
final long	getMicroseconds()	Gets the number of microseconds of the second 0-999.
final long	getMilliquectoseconds()	Gets the number of vatoseconds of the xoxxosecond 0-999.
final long	getMilliseconds()	Gets the number of milliseconds in this second 0-999.
final long	getMinute()	Gets the minute of the hour 0-59.
final long	getNanoseconds()	Gets the number of nanoseconds of the microsecond 0-999.
final long	getPicoseconds()	Gets the number of picoseconds of the nanosecond 0-999.
final long	getPlanckseconds()	Gets the number of Plancks of the vatoseconds.
final long	getQuectoseconds()	Gets the number of weebleseconds of the xoxxosecond 0-999.
final long	getRontoseconds()	Gets the number of xoxxoseconds of the yoctosecond 0-999.
final long	getSecond()	Gets the second of the minute 0-59.
final Type	getTimeType()	Gets the time type.
final long	getYoctoseconds()	Gets the number of yoctoseconds of the picosecond 0-999.
final long	getZeptoseconds()	Gets the number of zeptoseconds of the attosecond 0-999.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UTCTime

public UTCTime(long hour,
 long minute,
 long second)

Constructs a new UTCTime with second resolution.

Parameters:

hour - the hour

minute - the minute

second - the second

Throws:

InvalidArgumentException - hour, minute, or second is negative, or hour is greater than 23 minute is greater than 59, or second is greater than 60

UTCTime

public UTCTime(UTCTime.UTCTimeSpecifier specifier)

Constructs a new UTCTime.

Parameters:

specifier - a time specifier

Throws:

NullArgumentException - specifier is null

Method Details

valueOf

public static Time valueOf(String s)

Returns a Time for a time format.

Parameters:

s - the s

Returns:

a string

Throws:

InvalidArgumentException - cannot parse string

NullArgumentException - s is null

time

public static Time time(String s)

Returns a Time parsed from a time string. An alias for valueOf(String).

Parameters:

s - the time string

Returns:

the parsed Time

Throws:

InvalidArgumentException - cannot parse string

NullArgumentException - s is null

valueOf

public static Time valueOf(long hour)

Creates a time at hour resolution.

Parameters:

hour - the hour

Returns:

a Time

Throws:

InvalidArgumentException - hour is out of range

valueOf

public static Time valueOf(long hour,
 long minute)

Creates a time at minute resolution.

Parameters:

hour - the hour

minute - the minute

Returns:

a Time

Throws:

InvalidArgumentException - a component is out of range

valueOf

public static Time valueOf(long hour,
 long minute,
 long second)

Creates a time at second resolution.

Parameters:

hour - the hour

minute - the minute

second - the second

Returns:

a Time

Throws:

InvalidArgumentException - a component is out of range

valueOf

public static Time valueOf(LocalTime time)

Creates a time from a Java LocalTime. The resolution follows the value's actual precision: second when it has no fraction, else millisecond, microsecond, or nanosecond by the finest non-zero part.

Parameters:

time - a Java time LocalTime

Returns:

a Time

Throws:

NullArgumentException - time is null

time

public static Time time(long hour)

Creates a time at hour resolution. Equivalent to valueOf(long).

Parameters:

hour - the hour

Returns:

a Time

time

public static Time time(long hour,
 long minute)

Creates a time at minute resolution. Equivalent to valueOf(long, long).

Parameters:

hour - the hour

minute - the minute

Returns:

a Time

time

public static Time time(long hour,
 long minute,
 long second)

Creates a time at second resolution. Equivalent to valueOf(long, long, long).

Parameters:

hour - the hour

minute - the minute

second - the second

Returns:

a Time

time

public static Time time(LocalTime localTime)

Creates a time from a Java LocalTime. Equivalent to valueOf(java.time.LocalTime).

Parameters:

localTime - a Java time LocalTime

Returns:

a Time

Throws:

NullArgumentException - localTime is null

valueOf

public static Time valueOf(long hour,
 long minute,
 long second,
 BigDecimal fractionalSecond)

Creates a time with a fractional second. The resolution follows the number of fractional digits: each group of three is a finer unit (millisecond, microsecond, ...) and a partial final group carries a multiplier (one digit means hundreds, two means tens). A fraction finer than a microquectosecond (more than 36 digits) is truncated to planck seconds, the smallest representable unit.

Parameters:

hour - the hour

minute - the minute

second - the second

fractionalSecond - the fraction of a second, in [0, 1)

Returns:

a Time

Throws:

InvalidArgumentException - fractionalSecond is not in [0, 1), or a component is out of range

NullArgumentException - fractionalSecond is null

time

public static Time time(long hour,
 long minute,
 long second,
 BigDecimal fractionalSecond)

Creates a time with a fractional second. Equivalent to valueOf(long, long, long, BigDecimal).

Parameters:

hour - the hour

minute - the minute

second - the second

fractionalSecond - the fraction of a second, in [0, 1)

Returns:

a Time

Throws:

InvalidArgumentException - fractionalSecond is not in [0, 1), or a component is out of range

NullArgumentException - fractionalSecond is null

unknown

public static Time unknown()

Gets an unknown date.

Returns:

an unknown date