net.snowflake.common.core

Class SFDate

java.lang.Object

net.snowflake.common.core.SFInstant

net.snowflake.common.core.SFDate

All Implemented Interfaces:

Comparable<SFDate>

public class SFDate
extends SFInstant
implements Comparable<SFDate>

Represents dates without time. Used to store dates, as in 'midnights'. Stores UTC midnights always for a given date. Instances of this class are immutable.

Author:

mzukowski

Field Summary

Fields

Modifier and Type	Field and Description
static SFDate	MAX_VALID_VALUE
static SFDate	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

Constructor Summary

Constructors

Constructor and Description
SFDate(Date date) Constructor using Java Date
SFDate(long millis) Constructor using UTC milliseconds
SFDate(SFDate sfd) Copy constructor.

Method Summary

Modifier and Type	Method and Description
SFDate	addDays(int ndays) Increment current date by specified number of days and return a new SFDate object.
int	compareTo(SFDate other) Compare if we're smaller than, equal to, or larger than the other SFDate
boolean	equals(Object o)
boolean	equals(SFDate other) Returns if we're equal to the other SFDate
int	extract(int field, Integer optWeekStart, Integer optWoyPolicy) Extract a particular component of a date.
static SFDate	fromTimestamp(SFTimestamp timestamp) Utility function generating a new SFDate from a given SFTimestamp.
Date	getDate() Return the embedded Java date object
long	getTime() Return the number of milliseconds since UTC epoch
int	hashCode()
String	toString()
String	toUTCString() Construct 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 SFDate MIN_VALID_VALUE

MAX_VALID_VALUE

public static final SFDate MAX_VALID_VALUE

Constructor Detail

SFDate

public SFDate(long millis)

Constructor using UTC milliseconds

Parameters:

millis - epoch time in UTC in milliseconds

SFDate

public SFDate(Date date)

Constructor using Java Date

Parameters:

date - date instance

SFDate

public SFDate(SFDate sfd)

Copy constructor. Unless an explicit copy of original is needed, use of this constructor is unnecessary since SFDates are immutable.

Parameters:

sfd - SFDate instance

Method Detail

getDate

public Date getDate()

Return the embedded Java date object

Returns:

Date instance

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTime

public long getTime()

Return the number of milliseconds since UTC epoch

Returns:

milliseconds

toUTCString

public String toUTCString()

Construct a string that can be safely passed to XP.

Returns:

UTC string

compareTo

public int compareTo(SFDate other)

Compare if we're smaller than, equal to, or larger than the other SFDate

Specified by:

compareTo in interface Comparable<SFDate>

Parameters:

other - target SFDate

Returns:

value lower than 0 if we're smaller, 0 if we're equal, value larger than 0 if we're larger.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(SFDate other)

Returns if we're equal to the other SFDate

Parameters:

other - target SFDate

Returns:

true if identical otherwise false

fromTimestamp

public static SFDate fromTimestamp(SFTimestamp timestamp)

Utility function generating a new SFDate from a given SFTimestamp.

Parameters:

timestamp - source timestamp

Returns:

SFDate instance

extract

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

Extract a particular component of a date.

Specified by:

extract in class SFInstant

Parameters:

field - field id as specified in the Calendar class

optWeekStart - Optional WEEK_START value

optWoyPolicy - Optional WEEK_OF_YEAR_POLICY value

Returns:

value

toString

public String toString()

Overrides:

toString in class Object

addDays

public SFDate addDays(int ndays)

Increment current date by specified number of days and return a new SFDate object.

Parameters:

ndays -

Returns: