TmExt (GSCommon 4.0.1 API)

java.lang.Object
- net.snowflake.common.core.TmExt

```
public class TmExt
extends Object
```
This class represents decomposed time/date, similar to libc's struct tm, but with additional fields for handling missing data and timezones

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TmExt.YearDay

Nested Classes
Modifier and Type	Class and Description
`static class`	`TmExt.YearDay`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAYS_IN_WEEK`
`static long`	`EPOCH_AUTO_LIMIT`
`static long`	`EPOCH_END`
`static long`	`EPOCH_START`
`static int`	`FRAC_SECONDS`
`static int`	`HOURS_IN_DAY`
`static int`	`MAX_DAYS_IN_MONTH`
`static int`	`MAX_DAYS_IN_YEAR`
`static int`	`MAX_REGION_LEN`
`static int`	`MAX_SCALE`
`static int`	`MAX_YEAR`
`static int`	`MAX_ZONE_LEN`
`static int`	`MINUTES_IN_DAY`
`static int`	`MINUTES_IN_HOUR`
`static int`	`MONTHS_IN_YEAR`
`TimeZone`	`s_gmtTz`
`static int`	`SECONDS_IN_DAY`
`static int`	`SECONDS_IN_HOUR`
`static int`	`SECONDS_IN_MINUTE`
`long`	`tm_epochSec`
`int`	`tm_gmtoff`
`boolean`	`tm_has_epochSec`
`boolean`	`tm_has_offset`
`boolean`	`tm_has_tzidx`
`int`	`tm_hour`
`int`	`tm_isdst`
`int`	`tm_mday`
`int`	`tm_min`
`int`	`tm_mon`
`int`	`tm_nsec`
`String`	`tm_region`
`int`	`tm_sec`
`int`	`tm_sec_scale`
`int`	`tm_wday`
`int`	`tm_yday`
`int`	`tm_year`
`String`	`tm_zone`

Constructor Summary

Constructors
Constructor and Description

TmExt()
Constructor

Constructors
Constructor and Description
`TmExt()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`dayOfWeek(int date)` Compute American-style (Sunday = 0) day of the week from Unix epoch day (0 = Jan 1st 1970)
`SFDate`	`getDate()` Get SFDate from this structure
`SFTime`	`getTime()` Get time of day as SFTime
`SFTimestamp`	`getTimestamp(TimeZone tz)` Get timestamp as SFTimestamp
`static boolean`	`isGoodMonthDay(int month, int mday, boolean leap)` Check if the day of the month is good
`static boolean`	`isLeapYear(int year)` Check if it's a leap year in proleptic Gregorian calendar.
`static int`	`mdayFromYday(int yday, int month, boolean leap)` Returns day of the month by day of the year and month
`static int`	`monthFromYday(int yday, boolean leap)` Returns month # based on day of the year
`void`	`setDate(SFDate d)` Set this structure from SFDate NB: This relies on GeorgianCalendar, which is NOT ISO-8601 compliant proleptic Georgian calendar
`void`	`setTime(SFTime t, int scale)` Set this structure from SFTime
`void`	`setTimestamp(SFTimestamp ts, int scale, TimeZone tz)` Set this structure from SFTimestamp NB: This relies on GeorgianCalendar, which is NOT ISO-8601 compliant proleptic Georgian calendar
`static int`	`ydayFromMonthDay(int month, int mday, boolean leap)`
`static TmExt.YearDay`	`yearFromDate(int date)` Returns year based on Unix Epoch day (0 = Jan 1st, 1970) in proleptic Gregorian calendar.
`static int`	`yearStartDate(int year)` Returns starting day of the year in Unix epoch (0= Jan 1st, 1970) in proleptic Gregorian calendar.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tm_sec
```
public int tm_sec
```
  - tm_min
```
public int tm_min
```
  - tm_hour
```
public int tm_hour
```
  - tm_mday
```
public int tm_mday
```
  - tm_mon
```
public int tm_mon
```
  - tm_year
```
public int tm_year
```
  - tm_wday
```
public int tm_wday
```
  - tm_yday
```
public int tm_yday
```
  - tm_isdst
```
public int tm_isdst
```
  - tm_gmtoff
```
public int tm_gmtoff
```
  - tm_zone
```
public String tm_zone
```
  - tm_epochSec
```
public long tm_epochSec
```
  - tm_nsec
```
public int tm_nsec
```
  - tm_sec_scale
```
public int tm_sec_scale
```
  - tm_region
```
public String tm_region
```
  - tm_has_offset
```
public boolean tm_has_offset
```
  - tm_has_epochSec
```
public boolean tm_has_epochSec
```
  - tm_has_tzidx
```
public boolean tm_has_tzidx
```
  - SECONDS_IN_MINUTE
```
public static final int SECONDS_IN_MINUTE
```
    See Also:
    
    Constant Field Values
  - MINUTES_IN_HOUR
```
public static final int MINUTES_IN_HOUR
```
    See Also:
    
    Constant Field Values
  - SECONDS_IN_HOUR
```
public static final int SECONDS_IN_HOUR
```
    See Also:
    
    Constant Field Values
  - HOURS_IN_DAY
```
public static final int HOURS_IN_DAY
```
    See Also:
    
    Constant Field Values
  - MINUTES_IN_DAY
```
public static final int MINUTES_IN_DAY
```
    See Also:
    
    Constant Field Values
  - SECONDS_IN_DAY
```
public static final int SECONDS_IN_DAY
```
    See Also:
    
    Constant Field Values
  - DAYS_IN_WEEK
```
public static final int DAYS_IN_WEEK
```
    See Also:
    
    Constant Field Values
  - MONTHS_IN_YEAR
```
public static final int MONTHS_IN_YEAR
```
    See Also:
    
    Constant Field Values
  - MAX_DAYS_IN_MONTH
```
public static final int MAX_DAYS_IN_MONTH
```
    See Also:
    
    Constant Field Values
  - MAX_DAYS_IN_YEAR
```
public static final int MAX_DAYS_IN_YEAR
```
    See Also:
    
    Constant Field Values
  - MAX_YEAR
```
public static final int MAX_YEAR
```
    See Also:
    
    Constant Field Values
  - MAX_SCALE
```
public static final int MAX_SCALE
```
    See Also:
    
    Constant Field Values
  - FRAC_SECONDS
```
public static final int FRAC_SECONDS
```
    See Also:
    
    Constant Field Values
  - MAX_ZONE_LEN
```
public static final int MAX_ZONE_LEN
```
    See Also:
    
    Constant Field Values
  - MAX_REGION_LEN
```
public static final int MAX_REGION_LEN
```
    See Also:
    
    Constant Field Values
  - EPOCH_START
```
public static final long EPOCH_START
```
    See Also:
    
    Constant Field Values
  - EPOCH_END
```
public static final long EPOCH_END
```
    See Also:
    
    Constant Field Values
  - EPOCH_AUTO_LIMIT
```
public static final long EPOCH_AUTO_LIMIT
```
    See Also:
    
    Constant Field Values
  - s_gmtTz
```
public final TimeZone s_gmtTz
```
- Constructor Detail
  - TmExt
```
public TmExt()
```
    Constructor
- Method Detail
  - isLeapYear
```
public static boolean isLeapYear(int year)
```
    Check if it's a leap year in proleptic Gregorian calendar. This works for 0-based years (i.e. AD 1 = year 1, 1 BC = year 0).
    
    Parameters:
    
    year - (0-based) to look at
    
    Returns:
    
    true if it's a leap year, false otherwise.
  - yearFromDate
```
public static TmExt.YearDay yearFromDate(int date)
```
    Returns year based on Unix Epoch day (0 = Jan 1st, 1970) in proleptic Gregorian calendar.
    
    Parameters:
    
    date - the epoch day
    
    Returns:
    
    YearDay yday - day of the year (staring from 0) year - zero-based year (i.e. AD 1 = year 1, 1 BC = year 0)
  - yearStartDate
```
public static int yearStartDate(int year)
```
    Returns starting day of the year in Unix epoch (0= Jan 1st, 1970) in proleptic Gregorian calendar.
    
    Parameters:
    
    year - zero-based year (0 = 1 BC)
    
    Returns:
    
    the epoch day number for Jan 1st or the year
  - monthFromYday
```
public static int monthFromYday(int yday,
                                boolean leap)
```
    Returns month # based on day of the year
    
    Parameters:
    
    yday - day # in the year (staring from 0)
    
    leap - true for leap years
    
    Returns:
    
    month number (0=Jan ... 11=Dec)
  - mdayFromYday
```
public static int mdayFromYday(int yday,
                               int month,
                               boolean leap)
```
    Returns day of the month by day of the year and month
    
    Parameters:
    
    yday - Day of the year (starting from 0)
    
    month - Month (0-11)
    
    leap - True for leap years
    
    Returns:
    
    Day of the month (0-30)
  - dayOfWeek
```
public static int dayOfWeek(int date)
```
    Compute American-style (Sunday = 0) day of the week from Unix epoch day (0 = Jan 1st 1970)
    
    Parameters:
    
    date - Unix epoch day
    
    Returns:
    
    the day of the week (0=Sunday)
  - ydayFromMonthDay
```
public static int ydayFromMonthDay(int month,
                                   int mday,
                                   boolean leap)
```
  - isGoodMonthDay
```
public static boolean isGoodMonthDay(int month,
                                     int mday,
                                     boolean leap)
```
    Check if the day of the month is good
    
    Parameters:
    
    month - month of the year (0-11)
    
    mday - day of the month (0-30)
    
    leap - true if this is a leap year
    
    Returns:
    
    true if month and mday are valid
  - setTimestamp
```
public void setTimestamp(SFTimestamp ts,
                         int scale,
                         TimeZone tz)
```
    Set this structure from SFTimestamp NB: This relies on GeorgianCalendar, which is NOT ISO-8601 compliant proleptic Georgian calendar
    
    Parameters:
    
    ts - the timestamp
    
    scale - scale for fractional seconds
    
    tz - timezone to display (null to use TZ name from SFTimestamp)
  - setDate
```
public void setDate(SFDate d)
```
    Set this structure from SFDate NB: This relies on GeorgianCalendar, which is NOT ISO-8601 compliant proleptic Georgian calendar
    
    Parameters:
    
    d - SFDate
  - getDate
```
public SFDate getDate()
```
    Get SFDate from this structure
    
    Returns:
    
    SFDate object of null if conversion is impossible
  - setTime
```
public void setTime(SFTime t,
                    int scale)
```
    Set this structure from SFTime
    
    Parameters:
    
    t - SFTime
    
    scale - scale
  - getTime
```
public SFTime getTime()
```
    Get time of day as SFTime
    
    Returns:
    
    SFTime instance
  - getTimestamp
```
public SFTimestamp getTimestamp(TimeZone tz)
```
    Get timestamp as SFTimestamp
    
    Parameters:
    
    tz - the timezone to use by default
    
    Returns:
    
    timestamp structure or null on an error

Class TmExt

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tm_sec

tm_min

tm_hour

tm_mday

tm_mon

tm_year

tm_wday

tm_yday

tm_isdst

tm_gmtoff

tm_zone

tm_epochSec

tm_nsec

tm_sec_scale

tm_region

tm_has_offset

tm_has_epochSec

tm_has_tzidx

SECONDS_IN_MINUTE

MINUTES_IN_HOUR

SECONDS_IN_HOUR

HOURS_IN_DAY

MINUTES_IN_DAY

SECONDS_IN_DAY

DAYS_IN_WEEK

MONTHS_IN_YEAR

MAX_DAYS_IN_MONTH

MAX_DAYS_IN_YEAR

MAX_YEAR

MAX_SCALE

FRAC_SECONDS

MAX_ZONE_LEN

MAX_REGION_LEN

EPOCH_START

EPOCH_END

EPOCH_AUTO_LIMIT

s_gmtTz

Constructor Detail

TmExt

Method Detail

isLeapYear

yearFromDate

yearStartDate

monthFromYday

mdayFromYday

dayOfWeek

ydayFromMonthDay

isGoodMonthDay

setTimestamp

setDate

getDate

setTime

getTime

getTimestamp