Module : time
Module Overview
This module provides implementations related to time, date, time zones, and durations.
The module has two main types as Time and TimeZone. The Time
type represents a time associated with a given time zone. It has time
and zone
as its attributes. The TimeZone
type represents the time zone associated with a given time. It has id
and offset
as its attributes. An id
can be one of the following:
- If
id
equals 'Z', the result is UTC. - If
id
equals 'GMT', 'UTC' or 'UT', it is equivalent to UTC. - If
id
starts with '+' or '-', the ID is parsed as an offset. The offset can be specified in one of the following ways: +h, +hh, +hh:mm, -hh:mm, +hhmm, -hhmm, +hh:mm:ss, -hh:mm:ss, +hhmmss, -hhmmss - Also,
id
can be a region-based zone ID. The format is '{area}/{city}' e.g., "America/Panama". The zones are based on IANA Time Zone Database (TZDB) supplied data.
For information on the operations, which you can perform with this module, see the below Functions. For an example on the usage of the operations, see the Time Example.
Patterns for formatting and parsing
The below patterns can be used to generate the formatter string when using the format()
and parse()
functions.
Symbol | Meaning | Presentation | Examples |
---|---|---|---|
G | era | text | AD; Anno Domini; A |
u | year | year | 2004; 04 |
y | year-of-era | year | 2004; 04 |
D | day-of-year | number | 189 |
M/L | month-of-year | number/text | 7; 07; Jul; July; J |
d | day-of-month | number | 10 |
Q/q | quarter-of-year | number/text | 3; 03; Q3; 3rd quarter |
Y | week-based-year | year | 1996; 96 |
w | week-of-week-based-year | number | 27 |
W | week-of-month | number | 4 |
E | day-of-week | text | Tue; Tuesday; T |
e/c | localized day-of-week | number/text | 2; 02; Tue; Tuesday; T |
F | week-of-month | number | 3 |
a | cam-pm-of-day | text | PM |
h | clock-hour-of-am-pm (1-12) | number | 12 |
K | hour-of-am-pm (0-11) | number | 0 |
k | clock-hour-of-am-pm (1-24) | number | 0 |
H | hour-of-day (0-23) | number | 0 |
m | minute-of-hour | number | 30 |
s | second-of-minute | number | 55 |
S | fraction-of-second | fraction | 978 |
A | milli-of-day | number | 1234 |
n | nano-of-second | number | 987654321 |
N | nano-of-day | number | 1234000000 |
V | ime-zone ID | zone-id | America/Los_Angeles; Z; -08:30 |
z | time-zone name | zone-name | Pacific Standard Time; PST |
O | localized zone-offset | offset-O | GMT+8; GMT+08:00; UTC-08:00 |
X | zone-offset 'Z' for zero | offset-X | Z; -08; -0830; -08:30; -083015; -08:30:15 |
x | zone-offset | offset-x | +0000; -08; -0830; -08:30; -083015; -08:30:15 |
Z | zone-offset | offset-Z | +0000; -0800; -08:00 |
p | pad next | pad modifier | 1 |
' | escape for text | delimiter | |
'' | single quote | literal | ' |
[ | optional section start | ||
] | optional section end |
Detail |
Details of an error. |
Time |
Represents a particular time with its associated time-zone. |
TimeZone |
Represents the time-zone information associated with a particular time. |
addDuration |
Add specified durations to the given time value. |
createTime |
Returns the Time object correspoding to the given time components and time-zone. |
currentTime |
Returns the current time value with the default system time-zone. |
format |
Returns the formatted string representation of the given time. |
getDate |
Returns the date representation of the given time. |
getDay |
Returns the date representation of the given time. |
getHour |
Returns the hour representation of the given time. |
getMilliSecond |
Returns the millisecond representation of the given time. |
getMinute |
Returns the minute representation of the given time. |
getMonth |
Returns the month representation of the given time. |
getSecond |
Returns the second representation of the given time. |
getTime |
Returns the time representation of the given time. |
getWeekday |
Returns the weekday representation of the given time. |
getYear |
Returns the year representation of the given time. |
nanoTime |
Returns the current system time in nano seconds. |
parse |
Returns the time for the given string representation based on the given format string. |
subtractDuration |
Subtract specified durations from the given time value. |
toString |
Returns the ISO 8601 string representation of the given time. |
toTimeZone |
Change the time-zone of the given time. |
TIME_ERROR_REASON |
Specifies the time error, which occurs in the module. |
TIME_FORMAT_RFC_1123 |
Specifies the time format defined by the RFC-1123. |
TimeFormat |
The time format defined by the RFC-1123. |
Error |
Represents the Time module related error. |