SFTimestamp (GSCommon 4.0.1 API)

java.lang.Object
- net.snowflake.common.core.SFInstant
- - net.snowflake.common.core.SFTimestamp

All Implemented Interfaces:

Comparable<SFTimestamp>
```
public class SFTimestamp
extends SFInstant
implements Comparable<SFTimestamp>
```
Represents timestamps, including their originating time zone. Stores data in UTC, with nanosecond precision. Instances of this class are immutable.

Author:

mzukowski

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SFTimestamp.TimestampOperationNotAvailableException` Thrown when a Snowflake timestamp cannot be manipulated in Java due to size limitations.

Field Summary

Fields
Modifier and Type Field and Description

static SFTimestamp MAX_VALID_VALUE

static SFTimestamp 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

Fields
Modifier and Type	Field and Description
`static SFTimestamp`	`MAX_VALID_VALUE`
`static SFTimestamp`	`MIN_VALID_VALUE`

Constructor Summary

Constructors
Constructor and Description
`SFTimestamp()` Empty constructor, will create a timestamp at this instant
`SFTimestamp(SFDate date)` Constructs an SFTimestamp from SFDate.
`SFTimestamp(SFTimestamp sft)` Copy constructor.
`SFTimestamp(Timestamp ts)` Constructs an SFTimestamp from a java Timestamp.
`SFTimestamp(Timestamp ts, TimeZone tz)` Constructs an SFTimestamp from a java Timestamp and java TimeZone.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SFTimestamp`	`adjustScale(int scale)` Adjusts fractional second accuracy if necessary.
`SFTimestamp`	`changeTimeZone(TimeZone timeZone)` Returns a new SFTimestamp object, with specified timeZone set in it.
`int`	`compareTo(SFTimestamp other)` Compares with other SFTimestamp
`static TimeZone`	`convertTimezoneIndexToTimeZone(int timezoneIndex)` Convert a timezone index to timezone.
`boolean`	`equals(Object o)`
`boolean`	`equals(SFTimestamp other)` Checks if equals with other SFTimestamp
`int`	`extract(int field, Integer optWeekStart, Integer optWoyPolicy)` Extract a particular component of a date.
`static SFTimestamp`	`fromBinary(BigDecimal binary, int scale, TimeZone tz)` Constructs an SFTimestamp from a binary representation
`static SFTimestamp`	`fromDate(Date date, int nanos, TimeZone tz)` Constructs an SF timestamp from a Date and a number of nanoseconds.
`static SFTimestamp`	`fromMilliseconds(long ms, TimeZone tz)` Constructs an SF timestamp from a given number of UTC milliseconds and an originating timezone.
`static SFTimestamp`	`fromNanoseconds(BigDecimal ns)` Constructs an SF timestamp from a given number of UTC nanoseconds, using the GMT timezone.
`static SFTimestamp`	`fromNanoseconds(BigDecimal ns, TimeZone tz)` Constructs an SF timestamp from a given number of UTC nanoseconds, using the specified timezone
`static SFTimestamp`	`fromNanoseconds(long ns, TimeZone tz)` Constructs an SF timestamp from a given number of UTC nanoseconds and an originating timezone.
`static SFTimestamp`	`fromSFDate(SFDate sfd, TimeZone tz)` Constructs an SF timestamp from an SF date,
`int`	`getNanos()` Returns the fractional seconds component of this timestamp, i.e.
`BigDecimal`	`getNanosSinceEpoch()`
`BigInteger`	`getSeconds()` Returns the integral seconds component of this timestamp.
`long`	`getTime()` Returns epoch time in milliseconds as a long.
`BigInteger`	`getTimeInMsBigInt()` Returns the epoch time in milliseconds.
`Timestamp`	`getTimestamp()` Convert this to a Java timestamp.
`TimeZone`	`getTimeZone()` Returns Timezone
`int`	`getTimeZoneOffsetMillis()` Calculates the offset of this timestamp's time zone at this timestamp's time instant.
`int`	`hashCode()`
`SFTimestamp`	`moveToTimeZone(TimeZone newTimeZone)` Moves the timestamp to another time zone without changing its displayed value.
`SFTimestamp`	`moveToTimeZone(TimeZone newTimeZone, boolean cCompatibility)` Moves the timestamp to another time zone without changing its displayed value.
`BigInteger`	`toBinary(int scale, boolean includeTimeZone)` Constructs a binary representation of this timestamp.
`String`	`toString()`
`String`	`toUTCString()` Returns UTC string

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 SFTimestamp MIN_VALID_VALUE
```
  - MAX_VALID_VALUE
```
public static final SFTimestamp MAX_VALID_VALUE
```
- Constructor Detail
  - SFTimestamp
```
public SFTimestamp(Timestamp ts,
                   TimeZone tz)
```
    Constructs an SFTimestamp from a java Timestamp and java TimeZone.
    
    Parameters:
    
    ts - timestamp
    
    tz - timezone
  - SFTimestamp
```
public SFTimestamp(Timestamp ts)
```
    Constructs an SFTimestamp from a java Timestamp. The result timestamp has no timezone.
    
    Parameters:
    
    ts - Java timestamp
  - SFTimestamp
```
public SFTimestamp(SFDate date)
```
    Constructs an SFTimestamp from SFDate. The result timestamp has no timezone
    
    Parameters:
    
    date - SFDate instance
  - SFTimestamp
```
public SFTimestamp()
```
    Empty constructor, will create a timestamp at this instant
  - SFTimestamp
```
public SFTimestamp(SFTimestamp sft)
```
    Copy constructor. Unless an explicit copy of original is needed, use of this constructor is unnecessary since SFTimestamps are immutable.
    
    Parameters:
    
    sft - source SFTimestamp instance
- Method Detail
  - fromMilliseconds
```
public static SFTimestamp fromMilliseconds(long ms,
                                           TimeZone tz)
```
    Constructs an SF timestamp from a given number of UTC milliseconds and an originating timezone.
    
    Parameters:
    
    ms - milliseconds
    
    tz - timezone
    
    Returns:
    
    SFTimestamp instance
  - fromNanoseconds
```
public static SFTimestamp fromNanoseconds(long ns,
                                          TimeZone tz)
```
    Constructs an SF timestamp from a given number of UTC nanoseconds and an originating timezone.
    
    Parameters:
    
    ns - nanoseconds
    
    tz - timezone
    
    Returns:
    
    SFTimestamp instance
  - fromNanoseconds
```
public static SFTimestamp fromNanoseconds(BigDecimal ns,
                                          TimeZone tz)
```
    Constructs an SF timestamp from a given number of UTC nanoseconds, using the specified timezone
    
    Parameters:
    
    ns - nanoseconds in BigDecimal
    
    tz - timezone
    
    Returns:
    
    SFTimestamp instance
  - fromNanoseconds
```
public static SFTimestamp fromNanoseconds(BigDecimal ns)
```
    Constructs an SF timestamp from a given number of UTC nanoseconds, using the GMT timezone.
    
    Parameters:
    
    ns - nanoseconds in BigDecimal
    
    Returns:
    
    SFTimestamp instance
  - convertTimezoneIndexToTimeZone
```
public static TimeZone convertTimezoneIndexToTimeZone(int timezoneIndex)
```
    Convert a timezone index to timezone.
    
    Parameters:
    
    timezoneIndex - timezone index where 1440 is UTC
    
    Returns:
    
    Timezone instance
  - fromBinary
```
public static SFTimestamp fromBinary(BigDecimal binary,
                                     int scale,
                                     TimeZone tz)
```
    Constructs an SFTimestamp from a binary representation
    
    Parameters:
    
    binary - Physical representation, consists of UTC fractions (scaled decimals) and optional timezone index
    
    scale - Scale of fractional seconds
    
    tz - If specified, TimeZone to use. If null, we'll assume the timezone is embedded in the number
    
    Returns:
    
    SFTimestamp instance
  - fromDate
```
public static SFTimestamp fromDate(Date date,
                                   int nanos,
                                   TimeZone tz)
```
    Constructs an SF timestamp from a Date and a number of nanoseconds.
    
    Parameters:
    
    date - date instance
    
    nanos - nanoseconds
    
    tz - timezone
    
    Returns:
    
    SFTImestamp instance
  - fromSFDate
```
public static SFTimestamp fromSFDate(SFDate sfd,
                                     TimeZone tz)
```
    Constructs an SF timestamp from an SF date,
    
    Parameters:
    
    sfd - SFDate representing a date. Note - it's always UTC milliseconds.
    
    tz - timezone
    
    Returns:
    
    SFTimestamp representing a midnight in a specified timezone.
  - getNanosSinceEpoch
```
public BigDecimal getNanosSinceEpoch()
```
  - getTimestamp
```
public Timestamp getTimestamp()
                       throws SFTimestamp.TimestampOperationNotAvailableException
```
    Convert this to a Java timestamp.
    
    Returns:
    
    Java timestamp or null
    
    Throws:
    
    SFTimestamp.TimestampOperationNotAvailableException - if this timestamp doesn't fit in a Java timestamp
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns Timezone
    
    Returns:
    
    Timezone
  - changeTimeZone
```
public SFTimestamp changeTimeZone(TimeZone timeZone)
```
    Returns a new SFTimestamp object, with specified timeZone set in it.
    
    Parameters:
    
    timeZone - the timezone for this timestamp
    
    Returns:
    
    the new SFTimestamp in the new timezone
  - moveToTimeZone
```
public SFTimestamp moveToTimeZone(TimeZone newTimeZone)
                           throws SFTimestamp.TimestampOperationNotAvailableException
```
    Moves the timestamp to another time zone without changing its displayed value. For example, 18:53:21 PDT will become 18:53:21 EDT. This is NOT the same as changeTimestamp(); that will change 18:53:21 PDT into 21:53:21 EDT.
    
    Parameters:
    
    newTimeZone - a target Timezone
    
    Returns:
    
    SFTimestamp instance
    
    Throws:
    
    SFTimestamp.TimestampOperationNotAvailableException - if this timestamp doesn't fit into a Java timestamp
  - moveToTimeZone
```
public SFTimestamp moveToTimeZone(TimeZone newTimeZone,
                                  boolean cCompatibility)
                           throws SFTimestamp.TimestampOperationNotAvailableException
```
    Moves the timestamp to another time zone without changing its displayed value. For example, 18:53:21 PDT will become 18:53:21 EDT. This is NOT the same as changeTimestamp(); that will change 18:53:21 PDT into 21:53:21 EDT.
    
    Parameters:
    
    newTimeZone - a target Timezone
    
    cCompatibility - corrects incompatibilities between Java and C libraries for timestamps that are ambiguous (e.g. '2016-11-06 01:30') or illegal (e.g. '2016-03-13 02:30') due to DST rules.
    
    Returns:
    
    SFTimestamp instance
    
    Throws:
    
    SFTimestamp.TimestampOperationNotAvailableException - if this timestamp doesn't fit into a Java timestamp
  - adjustScale
```
public SFTimestamp adjustScale(int scale)
```
    Adjusts fractional second accuracy if necessary.
    
    Parameters:
    
    scale - scale
    
    Returns:
    
    SFTimestamp instance
  - toUTCString
```
public String toUTCString()
```
    Returns UTC string
    
    Returns:
    
    UTC string
  - compareTo
```
public int compareTo(SFTimestamp other)
```
    Compares with other SFTimestamp
    
    Specified by:
    
    compareTo in interface Comparable<SFTimestamp>
    
    Parameters:
    
    other - target SFTimestamp
    
    Returns:
    
    1 if larger, 0 if equals otherwise -1
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(SFTimestamp other)
```
    Checks if equals with other SFTimestamp
    
    Parameters:
    
    other - target SFTimestamp
    
    Returns:
    
    true if equal otherwise false
  - getTime
```
public long getTime()
             throws SFTimestamp.TimestampOperationNotAvailableException
```
    Returns epoch time in milliseconds as a long. CAUTION: If this timestamp's millis since epoch can't fit into a long, an exception will be thrown!
    
    Returns:
    
    milliseconds since epoch as a long
    
    Throws:
    
    SFTimestamp.TimestampOperationNotAvailableException - if this timestamp doesn't fit into a Java timestamp
  - getTimeInMsBigInt
```
public BigInteger getTimeInMsBigInt()
```
    Returns the epoch time in milliseconds.
    
    Returns:
    
    milliseconds since epoch
  - getSeconds
```
public BigInteger getSeconds()
```
    Returns the integral seconds component of this timestamp.
    
    Returns:
  - getNanos
```
public int getNanos()
```
    Returns the fractional seconds component of this timestamp, i.e. the number of nanos from the nearest integral second (rounded down).
    
    Returns:
    
    nanoseconds
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTimeZoneOffsetMillis
```
public int getTimeZoneOffsetMillis()
```
    Calculates the offset of this timestamp's time zone at this timestamp's time instant. This is equivalent to getTimeZone().getOffset(getTime()) except it won't throw TimestampOperationNotAvailableException for timestamps that don't fit in Java timestamp.
    
    Returns:
    
    the time zone offset in millis
  - toBinary
```
public BigInteger toBinary(int scale,
                           boolean includeTimeZone)
```
    Constructs a binary representation of this timestamp. This is the opposite of fromBinary().
    
    Parameters:
    
    scale - scale of fractional seconds
    
    includeTimeZone - encode the time zone in the lower-order bits
    
    Returns:
    
    the binary representation of this timestamp
  - extract
```
public int extract(int field,
                   Integer optWeekStart,
                   Integer optWoyPolicy)
            throws SFTimestamp.TimestampOperationNotAvailableException
```
    Extract a particular component of a date.
    
    Specified by:
    
    extract in class SFInstant
    
    Parameters:
    
    field - field id as specified in the Calendar class. TODO: we don't support e.g. nanosecond nor timezones for now
    
    Returns:
    
    The value of the extracted field.
    
    Throws:
    
    SFTimestamp.TimestampOperationNotAvailableException - if this timestamp doesn't fit into a Java timestamp
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SFTimestamp

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

MIN_VALID_VALUE

MAX_VALID_VALUE

Constructor Detail

SFTimestamp

SFTimestamp

SFTimestamp

SFTimestamp

SFTimestamp

Method Detail

fromMilliseconds

fromNanoseconds

fromNanoseconds

fromNanoseconds

convertTimezoneIndexToTimeZone

fromBinary

fromDate

fromSFDate

getNanosSinceEpoch

getTimestamp

getTimeZone

changeTimeZone

moveToTimeZone

moveToTimeZone

adjustScale

toUTCString

compareTo

equals

equals

getTime

getTimeInMsBigInt

getSeconds

getNanos

hashCode

getTimeZoneOffsetMillis

toBinary

extract

toString