Package ch.bailu.gtk.glib

Class DateTime

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.type.Record

ch.bailu.gtk.glib.DateTime

All Implemented Interfaces:

PointerInterface

public class DateTime
extends Record

An opaque structure that represents a date and time, including a time zone.

https://docs.gtk.org/glib/struct.DateTime.html

Field Summary

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
DateTime(TimeZone tz, int year, int month, int day, int hour, int minute, double seconds)	Creates a new #GDateTime corresponding to the given date and time in the time zone @tz.
DateTime(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
DateTime	addDays(int days)	Creates a copy of @datetime and adds the specified number of days to the copy.
DateTime	addFull(int years, int months, int days, int hours, int minutes, double seconds)	Creates a new #GDateTime adding the specified values to the current date and time in @datetime.
DateTime	addHours(int hours)	Creates a copy of @datetime and adds the specified number of hours.
DateTime	addMinutes(int minutes)	Creates a copy of @datetime adding the specified number of minutes.
DateTime	addMonths(int months)	Creates a copy of @datetime and adds the specified number of months to the copy.
DateTime	addSeconds(double seconds)	Creates a copy of @datetime and adds the specified number of seconds.
DateTime	addWeeks(int weeks)	Creates a copy of @datetime and adds the specified number of weeks to the copy.
DateTime	addYears(int years)	Creates a copy of @datetime and adds the specified number of years to the copy.
int	compare(Pointer dt2)	A comparison function for #GDateTimes that is suitable as a #GCompareFunc.
boolean	equal(Pointer dt2)	Checks to see if @dt1 and @dt2 are equal.
Str	format(Str format)	Creates a newly allocated string representing the requested @format.
Str	format(String format)	Creates a newly allocated string representing the requested @format.
Str	formatIso8601()	Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), including the date, time and time zone, and return that as a UTF-8 encoded string.
static ClassHandler	getClassHandler()
int	getDayOfMonth()	Retrieves the day of the month represented by @datetime in the gregorian calendar.
int	getDayOfWeek()	Retrieves the ISO 8601 day of the week on which @datetime falls (1 is Monday, 2 is Tuesday... 7 is Sunday).
int	getDayOfYear()	Retrieves the day of the year represented by @datetime in the Gregorian calendar.
int	getHour()	Retrieves the hour of the day represented by @datetime
static int	getInstanceSize()
int	getMicrosecond()	Retrieves the microsecond of the date represented by @datetime
int	getMinute()	Retrieves the minute of the hour represented by @datetime
int	getMonth()	Retrieves the month of the year represented by @datetime in the Gregorian calendar.
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
int	getSecond()	Retrieves the second of the minute represented by @datetime
double	getSeconds()	Retrieves the number of seconds since the start of the last minute, including the fractional part.
TimeZone	getTimezone()	Get the time zone for this @datetime.
Str	getTimezoneAbbreviation()	Determines the time zone abbreviation to be used at the time and in the time zone of @datetime.
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
int	getWeekNumberingYear()	Returns the ISO 8601 week-numbering year in which the week containing @datetime falls.
int	getWeekOfYear()	Returns the ISO 8601 week number for the week containing @datetime.
int	getYear()	Retrieves the year represented by @datetime in the Gregorian calendar.
void	getYmd(Int year, Int month, Int day)	Retrieves the Gregorian day, month, and year of a given #GDateTime.
int	hash()	Hashes @datetime into a #guint, suitable for use within #GHashTable.
boolean	isDaylightSavings()	Determines if daylight savings time is in effect at the time and in the time zone of @datetime.
static DateTime	newFromIso8601DateTime(Str text, TimeZone default_tz)	Creates a #GDateTime corresponding to the given [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) @text.
static DateTime	newFromIso8601DateTime(String text, TimeZone default_tz)	Creates a #GDateTime corresponding to the given [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) @text.
static DateTime	newFromUnixLocalDateTime(long t)	Creates a #GDateTime corresponding to the given Unix time @t in the local time zone.
static DateTime	newFromUnixUtcDateTime(long t)	Creates a #GDateTime corresponding to the given Unix time @t in UTC.
static DateTime	newLocalDateTime(int year, int month, int day, int hour, int minute, double seconds)	Creates a new #GDateTime corresponding to the given date and time in the local time zone.
static DateTime	newNowDateTime(TimeZone tz)	Creates a #GDateTime corresponding to this exact instant in the given time zone @tz.
static DateTime	newNowLocalDateTime()	Creates a #GDateTime corresponding to this exact instant in the local time zone.
static DateTime	newNowUtcDateTime()	Creates a #GDateTime corresponding to this exact instant in UTC.
static DateTime	newUtcDateTime(int year, int month, int day, int hour, int minute, double seconds)	Creates a new #GDateTime corresponding to the given date and time in UTC.
DateTime	ref()	Atomically increments the reference count of @datetime by one.
DateTime	toLocal()	Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in the local time zone.
DateTime	toTimezone(TimeZone tz)	Create a new #GDateTime corresponding to the same instant in time as @datetime, but in the time zone @tz.
long	toUnix()	Gives the Unix time corresponding to @datetime, rounding down to the nearest second.
DateTime	toUtc()	Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in UTC.
void	unref()	Atomically decrements the reference count of @datetime by one.

Methods inherited from class ch.bailu.gtk.type.Record

destroy

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

DateTime

public DateTime(PointerContainer pointer)

DateTime

public DateTime(@Nonnull
 TimeZone tz,
 int year,
 int month,
 int day,
 int hour,
 int minute,
 double seconds)

Creates a new #GDateTime corresponding to the given date and time in
the time zone @tz.

The @year must be between 1 and 9999, @month between 1 and 12 and @day
between 1 and 28, 29, 30 or 31 depending on the month and the year.

@hour must be between 0 and 23 and @minute must be between 0 and 59.

@seconds must be at least 0.0 and must be strictly less than 60.0.
It will be rounded down to the nearest microsecond.

If the given time is not representable in the given time zone (for
example, 02:30 on March 14th 2010 in Toronto, due to daylight savings
time) then the time will be rounded up to the nearest existing time
(in this case, 03:00). If this matters to you then you should verify
the return value for containing the same as the numbers you gave.

In the case that the given time is ambiguous in the given time zone
(for example, 01:30 on November 7th 2010 in Toronto, due to daylight
savings time) then the time falling within standard (ie:
non-daylight) time is taken.

It not considered a programmer error for the values to this function
to be out of range, but in the case that they are, the function will
return %NULL.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

tz - a #GTimeZone

year - the year component of the date

month - the month component of the date

day - the day component of the date

hour - the hour component of the date

minute - the minute component of the date

seconds - the number of seconds past the minute

Method Details

getClassHandler

public static ClassHandler getClassHandler()

newFromIso8601DateTime

public static DateTime newFromIso8601DateTime(@Nonnull
 Str text,
 @Nullable
 TimeZone default_tz)

Creates a #GDateTime corresponding to the given
[ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601)
@text. ISO 8601 strings of the form <date><sep><time><tz> are supported, with
some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as
mentioned below.

Note that as #GDateTime "is oblivious to leap seconds", leap seconds information
in an ISO-8601 string will be ignored, so a `23:59:60` time would be parsed as
`23:59:59`.

<sep> is the separator and can be either 'T', 't' or ' '. The latter two
separators are an extension from
[RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).

<date> is in the form:

- `YYYY-MM-DD` - Year/month/day, e.g. 2016-08-24.
- `YYYYMMDD` - Same as above without dividers.
- `YYYY-DDD` - Ordinal day where DDD is from 001 to 366, e.g. 2016-237.
- `YYYYDDD` - Same as above without dividers.
- `YYYY-Www-D` - Week day where ww is from 01 to 52 and D from 1-7,
e.g. 2016-W34-3.
- `YYYYWwwD` - Same as above without dividers.

<time> is in the form:

- `hh:mm:ss(.sss)` - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123.
- `hhmmss(.sss)` - Same as above without dividers.

<tz> is an optional timezone suffix of the form:

- `Z` - UTC.
- `+hh:mm` or `-hh:mm` - Offset from UTC in hours and minutes, e.g. +12:00.
- `+hh` or `-hh` - Offset from UTC in hours, e.g. +12.

If the timezone is not provided in @text it must be provided in @default_tz
(this field is otherwise ignored).

This call can fail (returning %NULL) if @text is not a valid ISO 8601
formatted string.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

text - an ISO 8601 formatted time string.

default_tz - a #GTimeZone to use if the text doesn't contain a timezone, or %NULL.

Returns:

a new #GDateTime, or %NULL

newFromIso8601DateTime

public static DateTime newFromIso8601DateTime(String text,
 @Nullable
 TimeZone default_tz)

Creates a #GDateTime corresponding to the given
[ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601)
@text. ISO 8601 strings of the form <date><sep><time><tz> are supported, with
some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as
mentioned below.

Note that as #GDateTime "is oblivious to leap seconds", leap seconds information
in an ISO-8601 string will be ignored, so a `23:59:60` time would be parsed as
`23:59:59`.

<sep> is the separator and can be either 'T', 't' or ' '. The latter two
separators are an extension from
[RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).

<date> is in the form:

- `YYYY-MM-DD` - Year/month/day, e.g. 2016-08-24.
- `YYYYMMDD` - Same as above without dividers.
- `YYYY-DDD` - Ordinal day where DDD is from 001 to 366, e.g. 2016-237.
- `YYYYDDD` - Same as above without dividers.
- `YYYY-Www-D` - Week day where ww is from 01 to 52 and D from 1-7,
e.g. 2016-W34-3.
- `YYYYWwwD` - Same as above without dividers.

<time> is in the form:

- `hh:mm:ss(.sss)` - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123.
- `hhmmss(.sss)` - Same as above without dividers.

<tz> is an optional timezone suffix of the form:

- `Z` - UTC.
- `+hh:mm` or `-hh:mm` - Offset from UTC in hours and minutes, e.g. +12:00.
- `+hh` or `-hh` - Offset from UTC in hours, e.g. +12.

If the timezone is not provided in @text it must be provided in @default_tz
(this field is otherwise ignored).

This call can fail (returning %NULL) if @text is not a valid ISO 8601
formatted string.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

text - an ISO 8601 formatted time string.

default_tz - a #GTimeZone to use if the text doesn't contain a timezone, or %NULL.

Returns:

a new #GDateTime, or %NULL

newFromUnixLocalDateTime

public static DateTime newFromUnixLocalDateTime(long t)

Creates a #GDateTime corresponding to the given Unix time @t in the
local time zone.

Unix time is the number of seconds that have elapsed since 1970-01-01
00:00:00 UTC, regardless of the local time offset.

This call can fail (returning %NULL) if @t represents a time outside
of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

t - the Unix time

Returns:

a new #GDateTime, or %NULL

newFromUnixUtcDateTime

public static DateTime newFromUnixUtcDateTime(long t)

Creates a #GDateTime corresponding to the given Unix time @t in UTC.

Unix time is the number of seconds that have elapsed since 1970-01-01
00:00:00 UTC.

This call can fail (returning %NULL) if @t represents a time outside
of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

t - the Unix time

Returns:

a new #GDateTime, or %NULL

newLocalDateTime

public static DateTime newLocalDateTime(int year,
 int month,
 int day,
 int hour,
 int minute,
 double seconds)

Creates a new #GDateTime corresponding to the given date and time in
the local time zone.

This call is equivalent to calling g_date_time_new() with the time
zone returned by g_time_zone_new_local().

Parameters:

year - the year component of the date

month - the month component of the date

day - the day component of the date

hour - the hour component of the date

minute - the minute component of the date

seconds - the number of seconds past the minute

Returns:

a #GDateTime, or %NULL

newNowDateTime

public static DateTime newNowDateTime(@Nonnull
 TimeZone tz)

Creates a #GDateTime corresponding to this exact instant in the given
time zone @tz. The time is as accurate as the system allows, to a
maximum accuracy of 1 microsecond.

This function will always succeed unless GLib is still being used after the
year 9999.

You should release the return value by calling g_date_time_unref()
when you are done with it.

Parameters:

tz - a #GTimeZone

Returns:

a new #GDateTime, or %NULL

newNowLocalDateTime

public static DateTime newNowLocalDateTime()

Creates a #GDateTime corresponding to this exact instant in the local
time zone.

This is equivalent to calling g_date_time_new_now() with the time
zone returned by g_time_zone_new_local().

Returns:

a new #GDateTime, or %NULL

newNowUtcDateTime

public static DateTime newNowUtcDateTime()

Creates a #GDateTime corresponding to this exact instant in UTC.

This is equivalent to calling g_date_time_new_now() with the time
zone returned by g_time_zone_new_utc().

Returns:

a new #GDateTime, or %NULL

newUtcDateTime

public static DateTime newUtcDateTime(int year,
 int month,
 int day,
 int hour,
 int minute,
 double seconds)

Creates a new #GDateTime corresponding to the given date and time in
UTC.

This call is equivalent to calling g_date_time_new() with the time
zone returned by g_time_zone_new_utc().

Parameters:

year - the year component of the date

month - the month component of the date

day - the day component of the date

hour - the hour component of the date

minute - the minute component of the date

seconds - the number of seconds past the minute

Returns:

a #GDateTime, or %NULL

addDays

public DateTime addDays(int days)

Creates a copy of @datetime and adds the specified number of days to the
copy. Add negative values to subtract days.

Parameters:

days - the number of days

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addFull

public DateTime addFull(int years,
 int months,
 int days,
 int hours,
 int minutes,
 double seconds)

Creates a new #GDateTime adding the specified values to the current date and
time in @datetime. Add negative values to subtract.

Parameters:

years - the number of years to add

months - the number of months to add

days - the number of days to add

hours - the number of hours to add

minutes - the number of minutes to add

seconds - the number of seconds to add

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addHours

public DateTime addHours(int hours)

Creates a copy of @datetime and adds the specified number of hours.
Add negative values to subtract hours.

Parameters:

hours - the number of hours to add

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addMinutes

public DateTime addMinutes(int minutes)

Creates a copy of @datetime adding the specified number of minutes.
Add negative values to subtract minutes.

Parameters:

minutes - the number of minutes to add

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addMonths

public DateTime addMonths(int months)

Creates a copy of @datetime and adds the specified number of months to the
copy. Add negative values to subtract months.

The day of the month of the resulting #GDateTime is clamped to the number
of days in the updated calendar month. For example, if adding 1 month to
31st January 2018, the result would be 28th February 2018. In 2020 (a leap
year), the result would be 29th February.

Parameters:

months - the number of months

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addSeconds

public DateTime addSeconds(double seconds)

Creates a copy of @datetime and adds the specified number of seconds.
Add negative values to subtract seconds.

Parameters:

seconds - the number of seconds to add

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addWeeks

public DateTime addWeeks(int weeks)

Creates a copy of @datetime and adds the specified number of weeks to the
copy. Add negative values to subtract weeks.

Parameters:

weeks - the number of weeks

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

addYears

public DateTime addYears(int years)

Creates a copy of @datetime and adds the specified number of years to the
copy. Add negative values to subtract years.

As with g_date_time_add_months(), if the resulting date would be 29th
February on a non-leap year, the day will be clamped to 28th February.

Parameters:

years - the number of years

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

compare

public int compare(@Nonnull
 Pointer dt2)

A comparison function for #GDateTimes that is suitable
as a #GCompareFunc. Both #GDateTimes must be non-%NULL.

Parameters:

dt2 - second #GDateTime to compare

Returns:

-1, 0 or 1 if @dt1 is less than, equal to or greater than @dt2.

equal

public boolean equal(@Nonnull
 Pointer dt2)

Checks to see if @dt1 and @dt2 are equal.

Equal here means that they represent the same moment after converting
them to the same time zone.

Parameters:

dt2 - a #GDateTime

Returns:

%TRUE if @dt1 and @dt2 are equal

format

public Str format(@Nonnull
 Str format)

Creates a newly allocated string representing the requested @format.

The format strings understood by this function are a subset of the
strftime() format language as specified by C99. The \%D, \%U and \%W
conversions are not supported, nor is the 'E' modifier. The GNU
extensions \%k, \%l, \%s and \%P are supported, however, as are the
'0', '_' and '-' modifiers. The Python extension \%f is also supported.

In contrast to strftime(), this function always produces a UTF-8
string, regardless of the current locale. Note that the rendering of
many formats is locale-dependent and may not match the strftime()
output exactly.

The following format specifiers are supported:

- \%a: the abbreviated weekday name according to the current locale
- \%A: the full weekday name according to the current locale
- \%b: the abbreviated month name according to the current locale
- \%B: the full month name according to the current locale
- \%c: the preferred date and time representation for the current locale
- \%C: the century number (year/100) as a 2-digit integer (00-99)
- \%d: the day of the month as a decimal number (range 01 to 31)
- \%e: the day of the month as a decimal number (range 1 to 31);
single digits are preceded by a figure space
- \%F: equivalent to `%Y-%m-%d` (the ISO 8601 date format)
- \%g: the last two digits of the ISO 8601 week-based year as a
decimal number (00-99). This works well with \%V and \%u.
- \%G: the ISO 8601 week-based year as a decimal number. This works
well with \%V and \%u.
- \%h: equivalent to \%b
- \%H: the hour as a decimal number using a 24-hour clock (range 00 to 23)
- \%I: the hour as a decimal number using a 12-hour clock (range 01 to 12)
- \%j: the day of the year as a decimal number (range 001 to 366)
- \%k: the hour (24-hour clock) as a decimal number (range 0 to 23);
single digits are preceded by a figure space
- \%l: the hour (12-hour clock) as a decimal number (range 1 to 12);
single digits are preceded by a figure space
- \%m: the month as a decimal number (range 01 to 12)
- \%M: the minute as a decimal number (range 00 to 59)
- \%f: the microsecond as a decimal number (range 000000 to 999999)
- \%p: either "AM" or "PM" according to the given time value, or the
corresponding strings for the current locale. Noon is treated as
"PM" and midnight as "AM". Use of this format specifier is discouraged, as
many locales have no concept of AM/PM formatting. Use \%c or \%X instead.
- \%P: like \%p but lowercase: "am" or "pm" or a corresponding string for
the current locale. Use of this format specifier is discouraged, as
many locales have no concept of AM/PM formatting. Use \%c or \%X instead.
- \%r: the time in a.m. or p.m. notation. Use of this format specifier is
discouraged, as many locales have no concept of AM/PM formatting. Use \%c
or \%X instead.
- \%R: the time in 24-hour notation (\%H:\%M)
- \%s: the number of seconds since the Epoch, that is, since 1970-01-01
00:00:00 UTC
- \%S: the second as a decimal number (range 00 to 60)
- \%t: a tab character
- \%T: the time in 24-hour notation with seconds (\%H:\%M:\%S)
- \%u: the ISO 8601 standard day of the week as a decimal, range 1 to 7,
Monday being 1. This works well with \%G and \%V.
- \%V: the ISO 8601 standard week number of the current year as a decimal
number, range 01 to 53, where week 1 is the first week that has at
least 4 days in the new year. See g_date_time_get_week_of_year().
This works well with \%G and \%u.
- \%w: the day of the week as a decimal, range 0 to 6, Sunday being 0.
This is not the ISO 8601 standard format -- use \%u instead.
- \%x: the preferred date representation for the current locale without
the time
- \%X: the preferred time representation for the current locale without
the date
- \%y: the year as a decimal number without the century
- \%Y: the year as a decimal number including the century
- \%z: the time zone as an offset from UTC (+hhmm)
- \%:z: the time zone as an offset from UTC (+hh:mm).
This is a gnulib strftime() extension. Since: 2.38
- \%::z: the time zone as an offset from UTC (+hh:mm:ss). This is a
gnulib strftime() extension. Since: 2.38
- \%:::z: the time zone as an offset from UTC, with : to necessary
precision (e.g., -04, +05:30). This is a gnulib strftime() extension. Since: 2.38
- \%Z: the time zone or name or abbreviation
- \%\%: a literal \% character

Some conversion specifications can be modified by preceding the
conversion specifier by one or more modifier characters. The
following modifiers are supported for many of the numeric
conversions:

- O: Use alternative numeric symbols, if the current locale supports those.
- _: Pad a numeric result with spaces. This overrides the default padding
for the specifier.
- -: Do not pad a numeric result. This overrides the default padding
for the specifier.
- 0: Pad a numeric result with zeros. This overrides the default padding
for the specifier.

Additionally, when O is used with B, b, or h, it produces the alternative
form of a month name. The alternative form should be used when the month
name is used without a day number (e.g., standalone). It is required in
some languages (Baltic, Slavic, Greek, and more) due to their grammatical
rules. For other languages there is no difference. \%OB is a GNU and BSD
strftime() extension expected to be added to the future POSIX specification,
\%Ob and \%Oh are GNU strftime() extensions. Since: 2.56

Parameters:

format - a valid UTF-8 string, containing the format for the #GDateTime

Returns:

a newly allocated string formatted to the requested format or %NULL in the case that there was an error (such as a format specifier not being supported in the current locale). The string should be freed with g_free().

format

public Str format(String format)

Creates a newly allocated string representing the requested @format.

The format strings understood by this function are a subset of the
strftime() format language as specified by C99. The \%D, \%U and \%W
conversions are not supported, nor is the 'E' modifier. The GNU
extensions \%k, \%l, \%s and \%P are supported, however, as are the
'0', '_' and '-' modifiers. The Python extension \%f is also supported.

In contrast to strftime(), this function always produces a UTF-8
string, regardless of the current locale. Note that the rendering of
many formats is locale-dependent and may not match the strftime()
output exactly.

The following format specifiers are supported:

- \%a: the abbreviated weekday name according to the current locale
- \%A: the full weekday name according to the current locale
- \%b: the abbreviated month name according to the current locale
- \%B: the full month name according to the current locale
- \%c: the preferred date and time representation for the current locale
- \%C: the century number (year/100) as a 2-digit integer (00-99)
- \%d: the day of the month as a decimal number (range 01 to 31)
- \%e: the day of the month as a decimal number (range 1 to 31);
single digits are preceded by a figure space
- \%F: equivalent to `%Y-%m-%d` (the ISO 8601 date format)
- \%g: the last two digits of the ISO 8601 week-based year as a
decimal number (00-99). This works well with \%V and \%u.
- \%G: the ISO 8601 week-based year as a decimal number. This works
well with \%V and \%u.
- \%h: equivalent to \%b
- \%H: the hour as a decimal number using a 24-hour clock (range 00 to 23)
- \%I: the hour as a decimal number using a 12-hour clock (range 01 to 12)
- \%j: the day of the year as a decimal number (range 001 to 366)
- \%k: the hour (24-hour clock) as a decimal number (range 0 to 23);
single digits are preceded by a figure space
- \%l: the hour (12-hour clock) as a decimal number (range 1 to 12);
single digits are preceded by a figure space
- \%m: the month as a decimal number (range 01 to 12)
- \%M: the minute as a decimal number (range 00 to 59)
- \%f: the microsecond as a decimal number (range 000000 to 999999)
- \%p: either "AM" or "PM" according to the given time value, or the
corresponding strings for the current locale. Noon is treated as
"PM" and midnight as "AM". Use of this format specifier is discouraged, as
many locales have no concept of AM/PM formatting. Use \%c or \%X instead.
- \%P: like \%p but lowercase: "am" or "pm" or a corresponding string for
the current locale. Use of this format specifier is discouraged, as
many locales have no concept of AM/PM formatting. Use \%c or \%X instead.
- \%r: the time in a.m. or p.m. notation. Use of this format specifier is
discouraged, as many locales have no concept of AM/PM formatting. Use \%c
or \%X instead.
- \%R: the time in 24-hour notation (\%H:\%M)
- \%s: the number of seconds since the Epoch, that is, since 1970-01-01
00:00:00 UTC
- \%S: the second as a decimal number (range 00 to 60)
- \%t: a tab character
- \%T: the time in 24-hour notation with seconds (\%H:\%M:\%S)
- \%u: the ISO 8601 standard day of the week as a decimal, range 1 to 7,
Monday being 1. This works well with \%G and \%V.
- \%V: the ISO 8601 standard week number of the current year as a decimal
number, range 01 to 53, where week 1 is the first week that has at
least 4 days in the new year. See g_date_time_get_week_of_year().
This works well with \%G and \%u.
- \%w: the day of the week as a decimal, range 0 to 6, Sunday being 0.
This is not the ISO 8601 standard format -- use \%u instead.
- \%x: the preferred date representation for the current locale without
the time
- \%X: the preferred time representation for the current locale without
the date
- \%y: the year as a decimal number without the century
- \%Y: the year as a decimal number including the century
- \%z: the time zone as an offset from UTC (+hhmm)
- \%:z: the time zone as an offset from UTC (+hh:mm).
This is a gnulib strftime() extension. Since: 2.38
- \%::z: the time zone as an offset from UTC (+hh:mm:ss). This is a
gnulib strftime() extension. Since: 2.38
- \%:::z: the time zone as an offset from UTC, with : to necessary
precision (e.g., -04, +05:30). This is a gnulib strftime() extension. Since: 2.38
- \%Z: the time zone or name or abbreviation
- \%\%: a literal \% character

Some conversion specifications can be modified by preceding the
conversion specifier by one or more modifier characters. The
following modifiers are supported for many of the numeric
conversions:

- O: Use alternative numeric symbols, if the current locale supports those.
- _: Pad a numeric result with spaces. This overrides the default padding
for the specifier.
- -: Do not pad a numeric result. This overrides the default padding
for the specifier.
- 0: Pad a numeric result with zeros. This overrides the default padding
for the specifier.

Additionally, when O is used with B, b, or h, it produces the alternative
form of a month name. The alternative form should be used when the month
name is used without a day number (e.g., standalone). It is required in
some languages (Baltic, Slavic, Greek, and more) due to their grammatical
rules. For other languages there is no difference. \%OB is a GNU and BSD
strftime() extension expected to be added to the future POSIX specification,
\%Ob and \%Oh are GNU strftime() extensions. Since: 2.56

Parameters:

format - a valid UTF-8 string, containing the format for the #GDateTime

Returns:

a newly allocated string formatted to the requested format or %NULL in the case that there was an error (such as a format specifier not being supported in the current locale). The string should be freed with g_free().

formatIso8601

public Str formatIso8601()

Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601),
including the date, time and time zone, and return that as a UTF-8 encoded
string.

Since GLib 2.66, this will output to sub-second precision if needed.

Returns:

a newly allocated string formatted in ISO 8601 format or %NULL in the case that there was an error. The string should be freed with g_free().

getDayOfMonth

public int getDayOfMonth()

Retrieves the day of the month represented by @datetime in the gregorian
calendar.

Returns:

the day of the month

getDayOfWeek

public int getDayOfWeek()

Retrieves the ISO 8601 day of the week on which @datetime falls (1 is
Monday, 2 is Tuesday... 7 is Sunday).

Returns:

the day of the week

getDayOfYear

public int getDayOfYear()

Retrieves the day of the year represented by @datetime in the Gregorian
calendar.

Returns:

the day of the year

getHour

public int getHour()

Retrieves the hour of the day represented by @datetime

Returns:

the hour of the day

getMicrosecond

public int getMicrosecond()

Retrieves the microsecond of the date represented by @datetime

Returns:

the microsecond of the second

getMinute

public int getMinute()

Retrieves the minute of the hour represented by @datetime

Returns:

the minute of the hour

getMonth

public int getMonth()

Retrieves the month of the year represented by @datetime in the Gregorian
calendar.

Returns:

the month represented by @datetime

getSecond

public int getSecond()

Retrieves the second of the minute represented by @datetime

Returns:

the second represented by @datetime

getSeconds

public double getSeconds()

Retrieves the number of seconds since the start of the last minute,
including the fractional part.

Returns:

the number of seconds

getTimezone

public TimeZone getTimezone()

Get the time zone for this @datetime.

Returns:

the time zone

getTimezoneAbbreviation

public Str getTimezoneAbbreviation()

Determines the time zone abbreviation to be used at the time and in
the time zone of @datetime.

For example, in Toronto this is currently "EST" during the winter
months and "EDT" during the summer months when daylight savings
time is in effect.

Returns:

the time zone abbreviation. The returned string is owned by the #GDateTime and it should not be modified or freed

getWeekNumberingYear

public int getWeekNumberingYear()

Returns the ISO 8601 week-numbering year in which the week containing
@datetime falls.

This function, taken together with g_date_time_get_week_of_year() and
g_date_time_get_day_of_week() can be used to determine the full ISO
week date on which @datetime falls.

This is usually equal to the normal Gregorian year (as returned by
g_date_time_get_year()), except as detailed below:

For Thursday, the week-numbering year is always equal to the usual
calendar year. For other days, the number is such that every day
within a complete week (Monday to Sunday) is contained within the
same week-numbering year.

For Monday, Tuesday and Wednesday occurring near the end of the year,
this may mean that the week-numbering year is one greater than the
calendar year (so that these days have the same week-numbering year
as the Thursday occurring early in the next year).

For Friday, Saturday and Sunday occurring near the start of the year,
this may mean that the week-numbering year is one less than the
calendar year (so that these days have the same week-numbering year
as the Thursday occurring late in the previous year).

An equivalent description is that the week-numbering year is equal to
the calendar year containing the majority of the days in the current
week (Monday to Sunday).

Note that January 1 0001 in the proleptic Gregorian calendar is a
Monday, so this function never returns 0.

Returns:

the ISO 8601 week-numbering year for @datetime

getWeekOfYear

public int getWeekOfYear()

Returns the ISO 8601 week number for the week containing @datetime.
The ISO 8601 week number is the same for every day of the week (from
Moday through Sunday). That can produce some unusual results
(described below).

The first week of the year is week 1. This is the week that contains
the first Thursday of the year. Equivalently, this is the first week
that has more than 4 of its days falling within the calendar year.

The value 0 is never returned by this function. Days contained
within a year but occurring before the first ISO 8601 week of that
year are considered as being contained in the last week of the
previous year. Similarly, the final days of a calendar year may be
considered as being part of the first ISO 8601 week of the next year
if 4 or more days of that week are contained within the new year.

Returns:

the ISO 8601 week number for @datetime.

getYear

public int getYear()

Retrieves the year represented by @datetime in the Gregorian calendar.

Returns:

the year represented by @datetime

getYmd

public void getYmd(@Nullable
 Int year,
 @Nullable
 Int month,
 @Nullable
 Int day)

Retrieves the Gregorian day, month, and year of a given #GDateTime.

Parameters:

year - the return location for the gregorian year, or %NULL.

month - the return location for the month of the year, or %NULL.

day - the return location for the day of the month, or %NULL.

hash

public int hash()

Hashes @datetime into a #guint, suitable for use within #GHashTable.

Returns:

a #guint containing the hash

isDaylightSavings

public boolean isDaylightSavings()

Determines if daylight savings time is in effect at the time and in
the time zone of @datetime.

Returns:

%TRUE if daylight savings time is in effect

ref

public DateTime ref()

Atomically increments the reference count of @datetime by one.

Returns:

the #GDateTime with the reference count increased

toLocal

public DateTime toLocal()

Creates a new #GDateTime corresponding to the same instant in time as
@datetime, but in the local time zone.

This call is equivalent to calling g_date_time_to_timezone() with the
time zone returned by g_time_zone_new_local().

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

toTimezone

public DateTime toTimezone(@Nonnull
 TimeZone tz)

Create a new #GDateTime corresponding to the same instant in time as
@datetime, but in the time zone @tz.

This call can fail in the case that the time goes out of bounds. For
example, converting 0001-01-01 00:00:00 UTC to a time zone west of
Greenwich will fail (due to the year 0 being out of range).

Parameters:

tz - the new #GTimeZone

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

toUnix

public long toUnix()

Gives the Unix time corresponding to @datetime, rounding down to the
nearest second.

Unix time is the number of seconds that have elapsed since 1970-01-01
00:00:00 UTC, regardless of the time zone associated with @datetime.

Returns:

the Unix time corresponding to @datetime

toUtc

public DateTime toUtc()

Creates a new #GDateTime corresponding to the same instant in time as
@datetime, but in UTC.

This call is equivalent to calling g_date_time_to_timezone() with the
time zone returned by g_time_zone_new_utc().

Returns:

the newly created #GDateTime which should be freed with g_date_time_unref(), or %NULL

unref

public void unref()

Atomically decrements the reference count of @datetime by one.

When the reference count reaches zero, the resources allocated by
@datetime are freed

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()