Package ch.bailu.gtk.glib

Class Date

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.glib.Date
All Implemented Interfaces:
PointerInterface
public class Date extends Record
Represents a day between January 1, Year 1 and a few thousand years in
the future. None of its members should be accessed directly.

If the `GDate` is obtained from g_date_new(), it will be safe
to mutate but invalid and thus not safe for calendrical computations.

If it's declared on the stack, it will contain garbage so must be
initialized with g_date_clear(). g_date_clear() makes the date invalid
but safe. An invalid date doesn't represent a day, it's "empty." A date
becomes valid after you set it to a Julian day or you set a day, month,
and year.

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

  • Field Details

  • Constructor Details

    • Date

      public Date(PointerContainer pointer)

    • Date

      public Date()
      Allocates a #GDate and initializes
      it to a safe state. The new date will
      be cleared (as if you'd called g_date_clear()) but invalid (it won't
      represent an existing day). Free the return value with g_date_free().

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setFieldJulianDays

      public void setFieldJulianDays(int julian_days)
      the Julian representation of the date

    • getFieldJulianDays

      public int getFieldJulianDays()
      the Julian representation of the date

    • setFieldJulian

      public void setFieldJulian(int julian)
      this bit is set if @julian_days is valid

    • getFieldJulian

      public int getFieldJulian()
      this bit is set if @julian_days is valid

    • setFieldDmy

      public void setFieldDmy(int dmy)
      this is set if @day, @month and @year are valid

    • getFieldDmy

      public int getFieldDmy()
      this is set if @day, @month and @year are valid

    • setFieldDay

      public void setFieldDay(int day)
      the day of the day-month-year representation of the date,
      as a number between 1 and 31

    • getFieldDay

      public int getFieldDay()
      the day of the day-month-year representation of the date,
      as a number between 1 and 31

    • setFieldMonth

      public void setFieldMonth(int month)
      the day of the day-month-year representation of the date,
      as a number between 1 and 12

    • getFieldMonth

      public int getFieldMonth()
      the day of the day-month-year representation of the date,
      as a number between 1 and 12

    • setFieldYear

      public void setFieldYear(int year)
      the day of the day-month-year representation of the date

    • getFieldYear

      public int getFieldYear()
      the day of the day-month-year representation of the date

    • newJulianDate

      public static Date newJulianDate(int julian_day)
      Create a new #GDate representing the given Julian date.

      The @julian_day you pass in must be valid. Use g_date_valid_julian() if
      needed to validate it. The returned #GDate is guaranteed to be non-%NULL and
      valid.
      Parameters:
      julian_day - days since January 1, Year 1
      Returns:
      a newly-allocated #GDate initialized with @julian_day

    • addDays

      public void addDays(int n_days)
      Increments a date some number of days.
      To move forward by weeks, add weeks*7 days.
      The date must be valid.
      Parameters:
      n_days - number of days to move the date forward

    • addMonths

      public void addMonths(int n_months)
      Increments a date by some number of months.
      If the day of the month is greater than 28,
      this routine may change the day of the month
      (because the destination month may not have
      the current day in it). The date must be valid.
      Parameters:
      n_months - number of months to move forward

    • addYears

      public void addYears(int n_years)
      Increments a date by some number of years.
      If the date is February 29, and the destination
      year is not a leap year, the date will be changed
      to February 28. The date must be valid.
      Parameters:
      n_years - number of years to move forward

    • clamp

      public void clamp(@Nonnull Date min_date, @Nonnull Date max_date)
      If @date is prior to @min_date, sets @date equal to @min_date.
      If @date falls after @max_date, sets @date equal to @max_date.
      Otherwise, @date is unchanged.
      Either of @min_date and @max_date may be %NULL.
      All non-%NULL dates must be valid.
      Parameters:
      min_date - minimum accepted value for @date
      max_date - maximum accepted value for @date

    • clear

      public void clear(int n_dates)
      Initializes one or more #GDate structs to a safe but invalid
      state. The cleared dates will not represent an existing date, but will
      not contain garbage. Useful to init a date declared on the stack.
      Validity can be tested with g_date_valid().
      Parameters:
      n_dates - number of dates to clear

    • compare

      public int compare(@Nonnull Date rhs)
      qsort()-style comparison function for dates.
      Both dates must be valid.
      Parameters:
      rhs - second date to compare
      Returns:
      0 for equal, less than zero if @lhs is less than @rhs, greater than zero if @lhs is greater than @rhs

    • copy

      public Date copy()
      Copies a GDate to a newly-allocated GDate. If the input was invalid
      (as determined by g_date_valid()), the invalid state will be copied
      as is into the new object.
      Returns:
      a newly-allocated #GDate initialized from @date

    • daysBetween

      public int daysBetween(@Nonnull Date date2)
      Computes the number of days between two dates.
      If @date2 is prior to @date1, the returned value is negative.
      Both dates must be valid.
      Parameters:
      date2 - the second date
      Returns:
      the number of days between @date1 and @date2

    • free

      public void free()
      Frees a #GDate returned from g_date_new().

    • getDayOfYear

      public int getDayOfYear()
      Returns the day of the year, where Jan 1 is the first day of the
      year. The date must be valid.
      Returns:
      day of the year

    • getIso8601WeekOfYear

      public int getIso8601WeekOfYear()
      Returns the week of the year, where weeks are interpreted according
      to ISO 8601.
      Returns:
      ISO 8601 week number of the year.

    • getJulian

      public int getJulian()
      Returns the Julian day or "serial number" of the #GDate. The
      Julian day is simply the number of days since January 1, Year 1; i.e.,
      January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2,
      etc. The date must be valid.
      Returns:
      Julian day

    • getMondayWeekOfYear

      public int getMondayWeekOfYear()
      Returns the week of the year, where weeks are understood to start on
      Monday. If the date is before the first Monday of the year, return 0.
      The date must be valid.
      Returns:
      week of the year

    • getMonth

      public int getMonth()
      Returns the month of the year. The date must be valid.
      Returns:
      month of the year as a #GDateMonth

    • getSundayWeekOfYear

      public int getSundayWeekOfYear()
      Returns the week of the year during which this date falls, if
      weeks are understood to begin on Sunday. The date must be valid.
      Can return 0 if the day is before the first Sunday of the year.
      Returns:
      week number

    • getWeekday

      public int getWeekday()
      Returns the day of the week for a #GDate. The date must be valid.
      Returns:
      day of the week as a #GDateWeekday.

    • isFirstOfMonth

      public boolean isFirstOfMonth()
      Returns %TRUE if the date is on the first of a month.
      The date must be valid.
      Returns:
      %TRUE if the date is the first of the month

    • isLastOfMonth

      public boolean isLastOfMonth()
      Returns %TRUE if the date is the last day of the month.
      The date must be valid.
      Returns:
      %TRUE if the date is the last day of the month

    • order

      public void order(@Nonnull Date date2)
      Checks if @date1 is less than or equal to @date2,
      and swap the values if this is not the case.
      Parameters:
      date2 - the second date

    • setJulian

      public void setJulian(int julian_date)
      Sets the value of a #GDate from a Julian day number.
      Parameters:
      julian_date - Julian day number (days since January 1, Year 1)

    • setMonth

      public void setMonth(int month)
      Sets the month of the year for a #GDate. If the resulting
      day-month-year triplet is invalid, the date will be invalid.
      Parameters:
      month - month to set

    • setParse

      public void setParse(@Nonnull Str str)
      Parses a user-inputted string @str, and try to figure out what date it
      represents, taking the [current locale][setlocale] into account. If the
      string is successfully parsed, the date will be valid after the call.
      Otherwise, it will be invalid. You should check using g_date_valid()
      to see whether the parsing succeeded.

      This function is not appropriate for file formats and the like; it
      isn't very precise, and its exact behavior varies with the locale.
      It's intended to be a heuristic routine that guesses what the user
      means by a given string (and it does work pretty well in that
      capacity).
      Parameters:
      str - string to parse

    • setParse

      public void setParse(String str)
      Parses a user-inputted string @str, and try to figure out what date it
      represents, taking the [current locale][setlocale] into account. If the
      string is successfully parsed, the date will be valid after the call.
      Otherwise, it will be invalid. You should check using g_date_valid()
      to see whether the parsing succeeded.

      This function is not appropriate for file formats and the like; it
      isn't very precise, and its exact behavior varies with the locale.
      It's intended to be a heuristic routine that guesses what the user
      means by a given string (and it does work pretty well in that
      capacity).
      Parameters:
      str - string to parse

    • setTimeT

      public void setTimeT(long timet)
      Sets the value of a date to the date corresponding to a time
      specified as a time_t. The time to date conversion is done using
      the user's current timezone.

      To set the value of a date to the current day, you could write: 
      <!-- language="C" -->
  time_t now = time (NULL);
  if (now == (time_t) -1)
    // handle the error
  g_date_set_time_t (date, now);
      Parameters:
      timet - time_t value to set

    • subtractDays

      public void subtractDays(int n_days)
      Moves a date some number of days into the past.
      To move by weeks, just move by weeks*7 days.
      The date must be valid.
      Parameters:
      n_days - number of days to move

    • subtractMonths

      public void subtractMonths(int n_months)
      Moves a date some number of months into the past.
      If the current day of the month doesn't exist in
      the destination month, the day of the month
      may change. The date must be valid.
      Parameters:
      n_months - number of months to move

    • subtractYears

      public void subtractYears(int n_years)
      Moves a date some number of years into the past.
      If the current day doesn't exist in the destination
      year (i.e. it's February 29 and you move to a non-leap-year)
      then the day is changed to February 29. The date
      must be valid.
      Parameters:
      n_years - number of years to move

    • valid

      public boolean valid()
      Returns %TRUE if the #GDate represents an existing day. The date must not
      contain garbage; it should have been initialized with g_date_clear()
      if it wasn't allocated by one of the g_date_new() variants.
      Returns:
      Whether the date is valid

    • strftime

      public static long strftime(@Nonnull Str s, long slen, @Nonnull Str format, @Nonnull Date date)
      Generates a printed representation of the date, in a
      [locale][setlocale]-specific way.
      Works just like the platform's C library strftime() function,
      but only accepts date-related formats; time-related formats
      give undefined results. Date must be valid. Unlike strftime()
      (which uses the locale encoding), works on a UTF-8 format
      string and stores a UTF-8 result.

      This function does not provide any conversion specifiers in
      addition to those implemented by the platform's C library.
      For example, don't expect that using g_date_strftime() would
      make the \%F provided by the C99 strftime() work on Windows
      where the C library only complies to C89.
      Parameters:
      s - destination buffer
      slen - buffer size
      format - format string
      date - valid #GDate
      Returns:
      number of characters written to the buffer, or 0 the buffer was too small

    • validJulian

      public static boolean validJulian(int julian_date)
      Returns %TRUE if the Julian day is valid. Anything greater than zero
      is basically a valid Julian, though there is a 32-bit limit.
      Parameters:
      julian_date - Julian day to check
      Returns:
      %TRUE if the Julian day is valid

    • validMonth

      public static boolean validMonth(int month)
      Returns %TRUE if the month value is valid. The 12 #GDateMonth
      enumeration values are the only valid months.
      Parameters:
      month - month
      Returns:
      %TRUE if the month is valid

    • validWeekday

      public static boolean validWeekday(int weekday)
      Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration
      values are the only valid weekdays.
      Parameters:
      weekday - weekday
      Returns:
      %TRUE if the weekday is valid

    • 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()