net.snowflake.common.core

Class SFTime

java.lang.Object

net.snowflake.common.core.SFInstant

net.snowflake.common.core.SFTime

All Implemented Interfaces:

Comparable<SFTime>

public class SFTime
extends SFInstant
implements Comparable<SFTime>

Represents times without date. Stores fractional seconds since midnight, with nanosecond precision. Instances of this class are immutable.

Author:

mkember

Field Summary

Fields

Modifier and Type	Field and Description
static SFTime	MAX_VALID_VALUE
static SFTime	MIN_VALID_VALUE

Fields inherited from class net.snowflake.common.core.SFInstant

DAY_OF_WEEK_ISO, GMT, POWERS_OF_TEN, WEEK_ISO, YEAR_OF_WEEK, YEAR_OF_WEEK_ISO

Method Summary

Modifier and Type	Method and Description
SFTime	addComponent(int component, long increment) Create an SFTime by adding hours, minutes, seconds, or milliseconds.
SFTime	adjustScale(int scale) Create an SFTime with an adjusted scale.
int	compareTo(SFTime other) Compares with other SFTime
boolean	equals(Object other)
int	extract(int field, Integer optWeekStart, Integer optWoyPolicy)
static SFTime	fromFractionalSeconds(long value, int scale) Constructs an SFTime from fractional seconds at a particular scale.
static SFTime	fromNanoseconds(long nanos) Constructs an SFTime given nanoseconds since midnight.
static SFTime	fromTimestamp(SFTimestamp ts) Constructs an SFTime from an SFTimestamp.
long	getFractionalSeconds(int scale) Returns fractional seconds since midnight at the given scale, truncated from the internal nanosecond representation.
long	getNanoseconds() Returns nanoseconds since midnight.
int	getNanosecondsWithinSecond() Returns nanoseconds since the last whole-number second.
int	hashCode()
String	toSecondsString(int decimalPlaces) Constructs a string containing the number of seconds since midnight with the given number of decimal places.
String	toString()
String	toUTCString() Constructs a string that can be safely passed to XP.

Methods inherited from class net.snowflake.common.core.SFInstant

extract, extract

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VALID_VALUE

public static final SFTime MIN_VALID_VALUE

MAX_VALID_VALUE

public static final SFTime MAX_VALID_VALUE

Method Detail

fromNanoseconds

public static SFTime fromNanoseconds(long nanos)

Constructs an SFTime given nanoseconds since midnight.

Parameters:

nanos - nanoseconds

Returns:

SFTime instance

fromFractionalSeconds

public static SFTime fromFractionalSeconds(long value,
                                           int scale)

Constructs an SFTime from fractional seconds at a particular scale.

Parameters:

value - Fractional seconds since midnight.

scale - The scale for interpreting value. A scale of 0 means seconds, and a scale of 9 means nanoseconds.

Returns:

A new SFTime object.

fromTimestamp

public static SFTime fromTimestamp(SFTimestamp ts)

Constructs an SFTime from an SFTimestamp. The resulting SFTime contains the time of day

Parameters:

ts - SFTimestamp

Returns:

SFTime

getNanoseconds

public long getNanoseconds()

Returns nanoseconds since midnight.

Returns:

nanoseconds

getNanosecondsWithinSecond

public int getNanosecondsWithinSecond()

Returns nanoseconds since the last whole-number second.

Returns:

nanoseconds

getFractionalSeconds

public long getFractionalSeconds(int scale)

Returns fractional seconds since midnight at the given scale, truncated from the internal nanosecond representation.

Parameters:

scale - scale

Returns:

fractional seconds

See Also:

fromFractionalSeconds(long, int)

addComponent

public SFTime addComponent(int component,
                           long increment)

Create an SFTime by adding hours, minutes, seconds, or milliseconds. Performs the addition modulo 24 hours so that the result stays in range.

Parameters:

component - The time component from the Calendar class.

increment - Number of hours/minutes/etc. to add.

Returns:

A new SFTime with the result of the addition.

adjustScale

public SFTime adjustScale(int scale)

Create an SFTime with an adjusted scale.

Parameters:

scale - The desired scale.

Returns:

Returns a new SFTime if changing the scale would result in a different (less precise) time. Returns this object otherwise.

toUTCString

public String toUTCString()

Constructs a string that can be safely passed to XP.

Returns:

a UTC string

toSecondsString

public String toSecondsString(int decimalPlaces)

Constructs a string containing the number of seconds since midnight with the given number of decimal places.

Parameters:

decimalPlaces - decimal places

Returns:

seconds in a string

compareTo

public int compareTo(SFTime other)

Compares with other SFTime

Specified by:

compareTo in interface Comparable<SFTime>

Parameters:

other - target SFTime

Returns:

1 if larger, 0 if equal otherwise -1

extract

public int extract(int field,
                   Integer optWeekStart,
                   Integer optWoyPolicy)

Specified by:

extract in class SFInstant

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object