org.pojava.datetime

Class Tm

java.lang.Object

org.pojava.datetime.Tm

public class Tm
extends Object

This class converts a DateTime into year, month, day, hour, minute, second, millisecond, nanosecond. It is similar to the tm struct in C.

Author:

John Pile

Constructor Summary

Constructors

Constructor and Description
Tm(DateTime dt) Populate year, month, day, hour, min, sec, nano from a DateTime
Tm(DateTime dt, TimeZone tz) Constructor
Tm(long millis) Populate year, month, day, hour, min, sec, nano
Tm(long millis, TimeZone tz) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static long	calcTime(int year, int month, int day) Determine "time" in milliseconds since epoch, UTC, as of the entered local time.
static long	calcTime(int year, int month, int day, int hour, int min, int sec, int milli) Determine "time" in milliseconds since epoch, UTC, as of the entered local time.
static long	calcTime(int year, int month, int day, int hour, int min, int sec, int milli, TimeZone tz) Determine "time" in milliseconds since epoch, UTC, as of the given time zone provided.
static int	calcWeekday(long millis, TimeZone timeZone) Return numeric day of week, usually Sun=1, Mon=2, ...
int	getDay() Returns day of month between 1 and 31.
int	getHour() Returns hour of day between 0 and 23.
int	getMillisecond() Returns millisecond fraction of second between 0 and 999999.
int	getMinute() Returns minute of hour between 0 and 59.
int	getMonth() Returns month between 1 and 12.
int	getNanosecond() Returns nanosecond fraction of second between 0 and 999999999.
int	getSecond() Returns second of minute between 0 and 59.
int	getWeekday() Returns weekday between 1 and 7
int	getYear()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tm

public Tm(DateTime dt)

Populate year, month, day, hour, min, sec, nano from a DateTime

Parameters:

dt - DateTime object

Tm

public Tm(DateTime dt,
  TimeZone tz)

Constructor

Parameters:

dt - Populate year, month, day, hour, min, sec, nano from a DateTime

tz - Assert a time zone under which those values are represented.

Tm

public Tm(long millis)

Populate year, month, day, hour, min, sec, nano

Parameters:

millis - Date/Time in UTC assuming the default time zone.

Tm

public Tm(long millis,
  TimeZone tz)

Constructor

Parameters:

millis - Millis since epoch

tz - TimeZone represented by the Tm

Method Detail

calcWeekday

public static int calcWeekday(long millis,
              TimeZone timeZone)

Return numeric day of week, usually Sun=1, Mon=2, ... , Sat=7;

Parameters:

millis - milliseconds since epoch

timeZone - TimeZone under which Tm will be represented

Returns:

Numeric day of week, usually Sun=1, Mon=2, ... , Sat=7. See DateTimeConfig.

calcTime

public static long calcTime(int year,
            int month,
            int day)

Determine "time" in milliseconds since epoch, UTC, as of the entered local time.

Parameters:

year - calendar year

month - calendar month

day - calendar day

Returns:

time in milliseconds since epoch, UTC.

calcTime

public static long calcTime(int year,
            int month,
            int day,
            int hour,
            int min,
            int sec,
            int milli)

Determine "time" in milliseconds since epoch, UTC, as of the entered local time. It is acceptable to use numbers outside of a normal range, such as a 15th month, or 64th minute.

Parameters:

year - calendar year

month - calendar month

day - calendar day

hour - hour of day

min - minute of hour

sec - seconds

milli - milliseconds

Returns:

time in milliseconds since epoch, UTC.

calcTime

public static long calcTime(int year,
            int month,
            int day,
            int hour,
            int min,
            int sec,
            int milli,
            TimeZone tz)

Determine "time" in milliseconds since epoch, UTC, as of the given time zone provided.

Parameters:

year - calendar year

month - calendar month

day - calendar day

hour - hour of day

min - minute of hour

sec - seconds

milli - millisecons

tz - time zone in which the date parts are given

Returns:

number of milliseconds since Epoch

getYear

public int getYear()

Returns:

Year as YYYY

getMonth

public int getMonth()

Returns month between 1 and 12. Differs from C version of tm, but you can always subtract 1 if you want zero-based.

Returns:

Month as Jan=1, Feb=2, ..., Dec=12

getDay

public int getDay()

Returns day of month between 1 and 31.

Returns:

Day of month.

getHour

public int getHour()

Returns hour of day between 0 and 23.

Returns:

Hour of day.

getMinute

public int getMinute()

Returns minute of hour between 0 and 59.

Returns:

Minute of hour.

getSecond

public int getSecond()

Returns second of minute between 0 and 59.

Returns:

Second of minute.

getMillisecond

public int getMillisecond()

Returns millisecond fraction of second between 0 and 999999.

Returns:

Millisecond fraction of second.

getNanosecond

public int getNanosecond()

Returns nanosecond fraction of second between 0 and 999999999.

Returns:

Nanosecond fraction of second.

getWeekday

public int getWeekday()

Returns weekday between 1 and 7

Returns:

Typically (although configurable) Sun=1 .. Sat=7