Package org.freedesktop.gstreamer.gst

Class DateTime

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.gst.DateTime

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class DateTime
extends ProxyInstance

Struct to store date, time and timezone information altogether. GstDateTime is refcounted and immutable.

Date information is handled using the [proleptic Gregorian calendar].

Provides basic creation functions and accessor functions to its fields.

[proleptic Gregorian calendar]: https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar

Constructor Summary

Constructors

Constructor	Description
DateTime(float tzoffset, int year, int month, int day, int hour, int minute, double seconds)	Creates a new GstDateTime using the date and times in the gregorian calendar in the supplied timezone.
DateTime(MemorySegment address)	Create a DateTime proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static DateTime	fromGDateTime(@Nullable DateTime dt)	Creates a new GstDateTime from a GDateTime object.
static DateTime	fromIso8601String(String string)	Tries to parse common variants of ISO-8601 datetime strings into a GstDateTime.
static DateTime	fromUnixEpochLocalTime(long secs)	Creates a new GstDateTime using the time since Jan 1, 1970 specified by secs. The GstDateTime is in the local timezone.
static DateTime	fromUnixEpochLocalTimeUsecs(long usecs)	Creates a new GstDateTime using the time since Jan 1, 1970 specified by usecs. The GstDateTime is in the local timezone.
static DateTime	fromUnixEpochUtc(long secs)	Creates a new GstDateTime using the time since Jan 1, 1970 specified by secs. The GstDateTime is in the UTC timezone.
static DateTime	fromUnixEpochUtcUsecs(long usecs)	Creates a new GstDateTime using the time since Jan 1, 1970 specified by usecs. The GstDateTime is in UTC.
int	getDay()	Returns the day of the month of this GstDateTime.
int	getHour()	Retrieves the hour of the day represented by this DateTime in the gregorian calendar.
int	getMicrosecond()	Retrieves the fractional part of the seconds in microseconds represented by this DateTime in the gregorian calendar.
int	getMinute()	Retrieves the minute of the hour represented by this DateTime in the gregorian calendar.
int	getMonth()	Returns the month of this GstDateTime.
int	getSecond()	Retrieves the second of the minute represented by this DateTime in the gregorian calendar.
float	getTimeZoneOffset()	Retrieves the offset from UTC in hours that the timezone specified by this DateTime represents.
static @Nullable Type	getType()	Get the GType of the DateTime class
int	getYear()	Returns the year of this GstDateTime.
boolean	hasDay()
boolean	hasMonth()
boolean	hasSecond()
boolean	hasTime()
boolean	hasYear()
static DateTime	localTime(int year, int month, int day, int hour, int minute, double seconds)	Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.
static DateTime	nowLocalTime()	Creates a new GstDateTime representing the current date and time.
static DateTime	nowUtc()	Creates a new GstDateTime that represents the current instant at Universal coordinated time.
DateTime	ref()	Atomically increments the reference count of this DateTime by one.
@Nullable DateTime	toGDateTime()	Creates a new GDateTime from a fully defined GstDateTime object.
@Nullable String	toIso8601String()	Create a minimal string compatible with ISO-8601.
void	unref()	Atomically decrements the reference count of this DateTime by one.
static DateTime	y(int year)	Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.
static DateTime	ym(int year, int month)	Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.
static DateTime	ymd(int year, int month, int day)	Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

DateTime

public DateTime(MemorySegment address)

Create a DateTime proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DateTime

public DateTime(float tzoffset,
 int year,
 int month,
 int day,
 int hour,
 int minute,
 double seconds)

Creates a new GstDateTime using the date and times in the gregorian calendar in the supplied timezone.

year should be from 1 to 9999, month should be from 1 to 12, day from 1 to 31, hour from 0 to 23, minutes and seconds from 0 to 59.

Note that tzoffset is a float and was chosen so for being able to handle some fractional timezones, while it still keeps the readability of representing it in hours for most timezones.

If value is -1 then all over value will be ignored. For example if month == -1, then GstDateTime will be created only for year. If day == -1, then GstDateTime will be created for year and month and so on.

Parameters:

tzoffset - Offset from UTC in hours.

year - the gregorian year

month - the gregorian month

day - the day of the gregorian month

hour - the hour of the day

minute - the minute of the hour

seconds - the second of the minute

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DateTime class

Returns:

the GType

fromGDateTime

public static DateTime fromGDateTime(@Nullable DateTime dt)

Creates a new GstDateTime from a GDateTime object.

Parameters:

dt - the GDateTime.

Returns:

a newly created GstDateTime, or null if dt is null.

fromIso8601String

public static DateTime fromIso8601String(String string)

Tries to parse common variants of ISO-8601 datetime strings into a GstDateTime. Possible input formats are (for example): 2012-06-30T22:46:43Z, 2012, 2012-06, 2012-06-30, 2012-06-30T22:46:43-0430, 2012-06-30T22:46Z, 2012-06-30T22:46-0430, 2012-06-30 22:46, 2012-06-30 22:46:43, 2012-06-00, 2012-00-00, 2012-00-30, 22:46:43Z, 22:46Z, 22:46:43-0430, 22:46-0430, 22:46:30, 22:46 If no date is provided, it is assumed to be "today" in the timezone provided (if any), otherwise UTC.

Parameters:

string - ISO 8601-formatted datetime string.

Returns:

a newly created GstDateTime, or null on error

fromUnixEpochLocalTime

public static DateTime fromUnixEpochLocalTime(long secs)

Creates a new GstDateTime using the time since Jan 1, 1970 specified by secs. The GstDateTime is in the local timezone.

Parameters:

secs - seconds from the Unix epoch

Returns:

the newly created GstDateTime, or null on error.

fromUnixEpochLocalTimeUsecs

public static DateTime fromUnixEpochLocalTimeUsecs(long usecs)

Creates a new GstDateTime using the time since Jan 1, 1970 specified by usecs. The GstDateTime is in the local timezone.

Parameters:

usecs - microseconds from the Unix epoch

Returns:

a newly created GstDateTime, or null on error.

Since:

1.18

fromUnixEpochUtc

public static DateTime fromUnixEpochUtc(long secs)

Creates a new GstDateTime using the time since Jan 1, 1970 specified by secs. The GstDateTime is in the UTC timezone.

Parameters:

secs - seconds from the Unix epoch

Returns:

the newly created GstDateTime, or null on error.

fromUnixEpochUtcUsecs

public static DateTime fromUnixEpochUtcUsecs(long usecs)

Creates a new GstDateTime using the time since Jan 1, 1970 specified by usecs. The GstDateTime is in UTC.

Parameters:

usecs - microseconds from the Unix epoch

Returns:

a newly created GstDateTime, or null on error.

Since:

1.18

localTime

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

Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.

year should be from 1 to 9999, month should be from 1 to 12, day from 1 to 31, hour from 0 to 23, minutes and seconds from 0 to 59.

If month is -1, then the GstDateTime created will only contain year, and all other fields will be considered not set.

If day is -1, then the GstDateTime created will only contain year and month and all other fields will be considered not set.

If hour is -1, then the GstDateTime created will only contain year and month and day, and the time fields will be considered not set. In this case minute and seconds should also be -1.

Parameters:

year - the gregorian year

month - the gregorian month, or -1

day - the day of the gregorian month, or -1

hour - the hour of the day, or -1

minute - the minute of the hour, or -1

seconds - the second of the minute, or -1

Returns:

the newly created GstDateTime, or null on error.

nowLocalTime

public static DateTime nowLocalTime()

Creates a new GstDateTime representing the current date and time.

Returns:

the newly created GstDateTime which should be freed with gst_date_time_unref(), or null on error.

nowUtc

public static DateTime nowUtc()

Creates a new GstDateTime that represents the current instant at Universal coordinated time.

Returns:

the newly created GstDateTime which should be freed with gst_date_time_unref(), or null on error.

y

public static DateTime y(int year)

Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.

year should be from 1 to 9999.

Parameters:

year - the gregorian year

Returns:

the newly created GstDateTime, or null on error.

ym

public static DateTime ym(int year,
 int month)

Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.

year should be from 1 to 9999, month should be from 1 to 12.

If value is -1 then all over value will be ignored. For example if month == -1, then GstDateTime will created only for year.

Parameters:

year - the gregorian year

month - the gregorian month

Returns:

the newly created GstDateTime, or null on error.

ymd

public static DateTime ymd(int year,
 int month,
 int day)

Creates a new GstDateTime using the date and times in the gregorian calendar in the local timezone.

year should be from 1 to 9999, month should be from 1 to 12, day from 1 to 31.

If value is -1 then all over value will be ignored. For example if month == -1, then GstDateTime will created only for year. If day == -1, then GstDateTime will created for year and month and so on.

Parameters:

year - the gregorian year

month - the gregorian month

day - the day of the gregorian month

Returns:

the newly created GstDateTime, or null on error.

getDay

public int getDay()

Returns the day of the month of this GstDateTime.

Returns:

The day of this GstDateTime, or -1 if none is set.

getHour

public int getHour()

Retrieves the hour of the day represented by this DateTime in the gregorian calendar. The return is in the range of 0 to 23.

Returns:

the hour of the day, or -1 if none is set.

getMicrosecond

public int getMicrosecond()

Retrieves the fractional part of the seconds in microseconds represented by this DateTime in the gregorian calendar.

Returns:

the microsecond of the second, or -1 if none is set.

getMinute

public int getMinute()

Retrieves the minute of the hour represented by this DateTime in the gregorian calendar.

Returns:

the minute of the hour, or -1 if none is set.

getMonth

public int getMonth()

Returns the month of this GstDateTime. January is 1, February is 2, etc..

Returns:

The month of this GstDateTime, or -1 if none is set.

getSecond

public int getSecond()

Retrieves the second of the minute represented by this DateTime in the gregorian calendar.

Returns:

the second represented by datetime, or -1 if none is set.

getTimeZoneOffset

public float getTimeZoneOffset()

Retrieves the offset from UTC in hours that the timezone specified by this DateTime represents. Timezones ahead (to the east) of UTC have positive values, timezones before (to the west) of UTC have negative values. If this DateTime represents UTC time, then the offset is zero.

Returns:

the offset from UTC in hours, or G_MAXFLOAT if none is set.

getYear

public int getYear()

Returns the year of this GstDateTime. Call gst_date_time_has_year() before, to avoid warnings.

Returns:

The year of this GstDateTime

hasDay

public boolean hasDay()

hasMonth

public boolean hasMonth()

hasSecond

public boolean hasSecond()

hasTime

public boolean hasTime()

hasYear

public boolean hasYear()

ref

public DateTime ref()

Atomically increments the reference count of this DateTime by one.

Returns:

the reference this DateTime

toGDateTime

public @Nullable DateTime toGDateTime()

Creates a new GDateTime from a fully defined GstDateTime object.

Returns:

a newly created GDateTime, or null on error or if this DateTime does not have a year, month, day, hour, minute and second.

toIso8601String

public @Nullable String toIso8601String()

Create a minimal string compatible with ISO-8601. Possible output formats are (for example): 2012, 2012-06, 2012-06-23, 2012-06-23T23:30Z, 2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100

Returns:

a newly allocated string formatted according to ISO 8601 and only including the datetime fields that are valid, or null in case there was an error.

unref

public void unref()

Atomically decrements the reference count of this DateTime by one. When the reference count reaches zero, the structure is freed.