agi.foundation.time

(agi.foundation.core-2024r3.jar)

Class GregorianDate

java.lang.Object

agi.foundation.time.GregorianDate

All Implemented Interfaces:

IEquatable<GregorianDate>, ImmutableValueType, ValueType, Comparable<GregorianDate>

public final class GregorianDate
extends Object
implements Comparable<GregorianDate>, IEquatable<GregorianDate>, ImmutableValueType

Represents a calendar date in the Gregorian calendar. A GregorianDate does not include a TimeStandard as JulianDate does. However, without explicitly specifying a TimeStandard for the date, the GregorianDate is assumed to be represented in CoordinatedUniversalTime (get). GregorianDate is also capable of representing leap seconds, which are represented as the second measured from 60 to 61. In this case, the GregorianDate is assumed to be the CoordinatedUniversalTime (get) represented in InternationalAtomicTime (get) which can represent leap seconds exactly.

Field Summary

Fields

Modifier and Type	Field and Description
static GregorianDate	MaxValue Represents the largest possible value of GregorianDate.
static GregorianDate	MinValue Represents the smallest possible value of GregorianDate.

Constructor Summary

Constructors

Constructor and Description
GregorianDate() Initializes a new instance.
GregorianDate(int year, double daysOfYear) Initializes a GregorianDate from the provided values.
GregorianDate(int year, int month, int day) Initializes a GregorianDate from the provided values.
GregorianDate(int year, int dayOfYear, int hour, int minute, double second) Initializes a GregorianDate from the provided values.
GregorianDate(int year, int month, int day, int hour, int minute, double second) Initializes a GregorianDate from the provided values.
GregorianDate(JulianDate julianDate) Initializes a GregorianDate from the provided JulianDate.
GregorianDate(JulianDate julianDate, TimeStandard timeStandard) Initializes a GregorianDate from the provided JulianDate.
GregorianDate(ZonedDateTime dateTime) Initializes a GregorianDate from the provided ZonedDateTime.

Method Summary

Modifier and Type	Method and Description
GregorianDate	addDays(double days) Adds the specified number of days to this date and returns the new date.
GregorianDate	addHours(double hours) Adds the specified number of hours to this date and returns the new date.
GregorianDate	addMinutes(double minutes) Adds the specified number of minutes to this date and returns the new date.
GregorianDate	addSeconds(double seconds) Adds the specified number of seconds to this date and returns the new date.
int	compareTo(GregorianDate other) Compares this instance with another instance of the same type.
static boolean	equals(GregorianDate left, GregorianDate right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(GregorianDate other) Indicates whether another instance of this type is exactly equal to this instance.
int	getDay() Gets the day of the month (in the range 1 through the number of days in the month).
DayOfWeek	getDayOfWeek() Gets the day of the week represented by this instance.
int	getDayOfYear() Gets the day of the year represented by this instance.
int	getHour() Gets the hour (in the range 0 through 23).
double	getJulianSecondsOfDay() Gets the corresponding seconds past noon for this instance.
int	getMinute() Gets the minute (in the range 0 through 59).
int	getMonth() Gets the month of the year (in the range 1 through 12).
static GregorianDate	getNow() Gets the GregorianDate that represents the current date and time.
double	getSecond() Gets the second, including fractional seconds (in the range 0.0 up to, but not including, 61.0).
double	getSecondsOfDay() Gets the corresponding seconds past midnight for this instance.
int	getYear() Gets the year.
static boolean	greaterThan(GregorianDate left, GregorianDate right) Returns true if left is greater than right.
static boolean	greaterThanOrEqual(GregorianDate left, GregorianDate right) Returns true if left is greater than or equal to right.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	isValid(int year, int month, int day, int hour, int minute, double second) Indicates whether the date values provided are a valid representation of a date and time.
static boolean	lessThan(GregorianDate left, GregorianDate right) Returns true if left is less than right.
static boolean	lessThanOrEqual(GregorianDate left, GregorianDate right) Returns true if left is less than or equal to right.
static boolean	notEquals(GregorianDate left, GregorianDate right) Returns true if the two instances are not exactly equal.
static GregorianDate	parse(String s) Converts the specified string representation of a date and time to its GregorianDate equivalent.
static GregorianDate	parse(String s, Locale provider) Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified culture-specific format information.
static GregorianDate	parseExact(String s, String[] format, Locale provider) Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified format and culture-specific format information.
static GregorianDate	parseExact(String s, String format, Locale provider) Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified format and culture-specific format information.
GregorianDate	roundSeconds(int digits) Rounds this instance to the specified number of decimal digits in the seconds, rolling over to minutes, hours, days, etc.
GregorianDate	roundSeconds(int digits, TimeStandard timeStandard) Rounds this instance to the specified number of decimal digits in the seconds, rolling over to minutes, hours, days, etc.
GregorianDate	subtractDays(double days) Subtracts the specified number of days from this date and returns the new date.
GregorianDate	subtractHours(double hours) Subtracts the specified number of hours from this date and returns the new date.
GregorianDate	subtractMinutes(double minutes) Subtracts the specified number of minutes from this date and returns the new date.
GregorianDate	subtractSeconds(double seconds) Subtracts the specified number of seconds from this date and returns the new date.
ZonedDateTime	toDateTime() Convert this GregorianDate to a ZonedDateTime.
String	toIso8601String() Converts the value of this instance to its equivalent ISO8601 extended string representation, with fractional seconds represented to 15 digits.
String	toIso8601String(Iso8601Format format) Converts the value of this instance to its equivalent ISO8601 string representation, with fractional seconds represented to 15 digits.
String	toIso8601String(Iso8601Format format, int digitsOfFractionalSeconds) Converts the value of this instance to its equivalent ISO8601 string representation, with fractional seconds represented to the specified number of digits.
JulianDate	toJulianDate() Convert this GregorianDate to a JulianDate.
JulianDate	toJulianDate(TimeStandard timeStandard) Convert this GregorianDate to a JulianDate.
String	toLongDateString() Converts the value of this instance to its equivalent long date string representation.
String	toLongTimeString() Converts the value of this instance to its equivalent long time string representation.
String	toShortDateString() Converts the value of this instance to its equivalent short date string representation.
String	toShortTimeString() Converts the value of this instance to its equivalent short time string representation.
String	toString() Converts the value of this instance to its equivalent string representation.
String	toString(Locale provider) Converts the value of this instance to its equivalent string representation using the specified culture-specific format information.
String	toString(String format) Converts the value of this instance to its equivalent string representation using the specified format.
String	toString(String format, Locale provider) Converts the value of this instance to its equivalent string representation using the specified format and culture-specific format information.
static boolean	tryParse(String s, GregorianDate[] result) Converts the specified string representation of a date and time to its GregorianDate equivalent.
static boolean	tryParse(String s, Locale provider, GregorianDate[] result) Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified culture-specific format information.

Methods inherited from class java.lang.Object

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

Field Detail

MaxValue

@Nonnull
public static final GregorianDate MaxValue

Represents the largest possible value of GregorianDate. Corresponds to DateTimeHelper.maxValue().

MinValue

@Nonnull
public static final GregorianDate MinValue

Represents the smallest possible value of GregorianDate. Corresponds to DateTimeHelper.minValue().

Constructor Detail

GregorianDate

public GregorianDate()

Initializes a new instance.

GregorianDate

public GregorianDate(int year,
                     int month,
                     int day,
                     int hour,
                     int minute,
                     double second)

Initializes a GregorianDate from the provided values.

Parameters:

year - The year.

month - The month of the year (in the range 1 through 12)

day - The day of the month (in the range 1 through the number of days in month)

hour - The hour (in the range 0 through 23).

minute - The minute (in the range 0 through 59).

second - The second, including fractional seconds (in the range 0.0 up to, but not including, 61.0). A second between 60.0 and 61.0 (a leap second) is only valid if the overall time is during one of the official leap seconds.

Throws:

ArgumentException - Thrown when one of the provided parameters is outside its acceptable range.

GregorianDate

public GregorianDate(int year,
                     int month,
                     int day)

Initializes a GregorianDate from the provided values. The remaining values are assumed to be zero.

Parameters:

year - The year.

month - The month of the year (in the range 1 through 12)

day - The day of the month (in the range 1 through the number of days in month)

Throws:

ArgumentException - Thrown when one of the provided parameters is outside its acceptable range.

GregorianDate

public GregorianDate(int year,
                     int dayOfYear,
                     int hour,
                     int minute,
                     double second)

Initializes a GregorianDate from the provided values.

Parameters:

year - The year.

dayOfYear - The day of year (in the range 1 through the number of days in the given year).

hour - The hour (in the range 0 through 23).

minute - The minute (in the range 0 through 59).

second - The second, including fractional seconds (in the range 0.0 up to, but not including, 61.0). A second between 60.0 and 61.0 (a leap second) is only valid if the overall time is during one of the official leap seconds.

Throws:

ArgumentException - Thrown when one of the provided parameters is outside its acceptable range.

GregorianDate

public GregorianDate(int year,
                     double daysOfYear)

Initializes a GregorianDate from the provided values. The fractional portion of the daysOfYear will be converted into hours, minutes, and seconds.

Parameters:

year - The year.

daysOfYear - The day of year plus the fractional portion of the day (in the range 1 through the number of days in the given year).

GregorianDate

public GregorianDate(@Nonnull
                     JulianDate julianDate)

Initializes a GregorianDate from the provided JulianDate. The new GregorianDate will be in the CoordinatedUniversalTime (get) (UTC) time standard.

Parameters:

julianDate - The JulianDate.

GregorianDate

public GregorianDate(@Nonnull
                     JulianDate julianDate,
                     TimeStandard timeStandard)

Initializes a GregorianDate from the provided JulianDate. The new GregorianDate will be in the provided TimeStandard.

Parameters:

julianDate - The JulianDate.

timeStandard - The TimeStandard to represent the new GregorianDate in.

GregorianDate

public GregorianDate(@Nonnull
                     ZonedDateTime dateTime)

Initializes a GregorianDate from the provided ZonedDateTime. If the provided ZonedDateTime is in local time, it is converted to UTC.

Parameters:

dateTime - The ZonedDateTime.

Method Detail

getYear

public final int getYear()

Gets the year.

getMonth

public final int getMonth()

Gets the month of the year (in the range 1 through 12).

getDay

public final int getDay()

Gets the day of the month (in the range 1 through the number of days in the month).

getHour

public final int getHour()

Gets the hour (in the range 0 through 23).

getMinute

public final int getMinute()

Gets the minute (in the range 0 through 59).

getSecond

public final double getSecond()

Gets the second, including fractional seconds (in the range 0.0 up to, but not including, 61.0). A value between 60.0 and 61.0 indicates a leap second.

getSecondsOfDay

public final double getSecondsOfDay()

Gets the corresponding seconds past midnight for this instance.

getJulianSecondsOfDay

public final double getJulianSecondsOfDay()

Gets the corresponding seconds past noon for this instance.

getDayOfWeek

@Nonnull
public final DayOfWeek getDayOfWeek()

Gets the day of the week represented by this instance.

Returns:

A DayOfWeek (get) value that indicates the day of the week. This property value ranges from zero, indicating Sunday, to six, indicating Saturday.

getDayOfYear

public final int getDayOfYear()

Gets the day of the year represented by this instance.

Returns:

An integer that indicates the day of the year. This property value ranges from 1 through the number of days in the year.

getNow

@Nonnull
public static GregorianDate getNow()

Gets the GregorianDate that represents the current date and time.

isValid

public static boolean isValid(int year,
                              int month,
                              int day,
                              int hour,
                              int minute,
                              double second)

Indicates whether the date values provided are a valid representation of a date and time.

Parameters:

year - The year.

month - The month of the year (in the range 1 through 12)

day - The day of the month (in the range 1 through the number of days in month)

hour - The hour (in the range 0 through 23).

minute - The minute (in the range 0 through 59).

second - The second, including fractional seconds (in the range 0.0 up to, but not including, 61.0). A second between 60.0 and 61.0 (a leap second) is only valid if the overall time is during one of the official leap seconds.

Returns:

true if the representation is valid and false if it is not.

toJulianDate

@Nonnull
public final JulianDate toJulianDate()

Convert this GregorianDate to a JulianDate. The time standard will be CoordinatedUniversalTime (get) (UTC), unless this GregorianDate represents the instant of a leap second, in which case the JulianDate will be in InternationalAtomicTime (get) (TAI).

Returns:

A JulianDate representing this date.

toJulianDate

@Nonnull
public final JulianDate toJulianDate(TimeStandard timeStandard)

Convert this GregorianDate to a JulianDate. The GregorianDate is assumed to specify a time in the specified TimeStandard.

Parameters:

timeStandard - The time standard in which this GregorianDate is expressed. The returned JulianDate will be expressed in this time standard as well, if possible.

Returns:

A JulianDate representing this date.

toDateTime

@Nonnull
public final ZonedDateTime toDateTime()

Convert this GregorianDate to a ZonedDateTime. The ZonedDateTime will be in UTC.

Returns:

A ZonedDateTime representing this date.

roundSeconds

@Nonnull
public final GregorianDate roundSeconds(int digits)

Rounds this instance to the specified number of decimal digits in the seconds, rolling over to minutes, hours, days, etc. as necessary. This instance is assumed to express a time in the CoordinatedUniversalTime (get) (UTC) time standard so the Second (get) will be allowed to go above 60 during a leap second.

Parameters:

digits - The number of digits after the decimal point to include in the seconds.

Returns:

The rounded date.

roundSeconds

@Nonnull
public final GregorianDate roundSeconds(int digits,
                                                  TimeStandard timeStandard)

Rounds this instance to the specified number of decimal digits in the seconds, rolling over to minutes, hours, days, etc. as necessary. If the specified timeStandard is CoordinatedUniversalTime (get), (UTC), the seconds will be allowed to go above 60 during a leap second. For any other time standard, the Second (get) will be below 60.

Parameters:

digits - The number of digits after the decimal point to include in the seconds.

timeStandard - The time standard in which this GregorianDate is expressed.

Returns:

The rounded date.

compareTo

public final int compareTo(@Nonnull
                           GregorianDate other)

Compares this instance with another instance of the same type.

Specified by:

compareTo in interface Comparable<GregorianDate>

Parameters:

other - An object to compare with this instance.

Returns:

A value indicating the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                GregorianDate other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<GregorianDate>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

toString

public String toString()

Converts the value of this instance to its equivalent string representation.

Overrides:

toString in class Object

Returns:

A string representation of value of this instance.

toString

@Nonnull
public final String toString(@Nullable
                                       String format)

Converts the value of this instance to its equivalent string representation using the specified format.

Parameters:

format - A format string.

Returns:

A string representation of value of this instance as specified by format.

Throws:

NumberFormatException - Thrown if the length of format is 1, and it is not one of the format specifier characters defined for DateTimeFormatInfo, or if format does not contain a valid custom format pattern.

toString

@Nonnull
public final String toString(@Nullable
                                       Locale provider)

Converts the value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters:

provider - An Locale that supplies culture-specific formatting information.

Returns:

A string representation of value of this instance as specified by provider.

toString

@Nonnull
public final String toString(@Nullable
                                       String format,
                                       @Nullable
                                       Locale provider)

Converts the value of this instance to its equivalent string representation using the specified format and culture-specific format information.

Parameters:

format - A format string.

provider - An Locale that supplies culture-specific formatting information.

Returns:

A string representation of value of this instance as specified by format and provider.

Throws:

NumberFormatException - Thrown if the length of format is 1, and it is not one of the format specifier characters defined for DateTimeFormatInfo, or if format does not contain a valid custom format pattern.

toIso8601String

@Nonnull
public final String toIso8601String()

Converts the value of this instance to its equivalent ISO8601 extended string representation, with fractional seconds represented to 15 digits.

Returns:

A string representing this date and time in extended ISO8601 format.

toIso8601String

@Nonnull
public final String toIso8601String(@Nonnull
                                              Iso8601Format format)

Converts the value of this instance to its equivalent ISO8601 string representation, with fractional seconds represented to 15 digits.

Parameters:

format - The type of ISO8601 string to create.

Returns:

A string representing this date and time in ISO8601 format.

toIso8601String

@Nonnull
public final String toIso8601String(@Nonnull
                                              Iso8601Format format,
                                              int digitsOfFractionalSeconds)

Converts the value of this instance to its equivalent ISO8601 string representation, with fractional seconds represented to the specified number of digits.

Parameters:

format - The type of ISO8601 string to create.

digitsOfFractionalSeconds - The number of digits after the decimal point in the 'seconds' portion of the time.

Returns:

A string representing this date and time in ISO8601 format.

toLongDateString

@Nonnull
public final String toLongDateString()

Converts the value of this instance to its equivalent long date string representation.

Returns:

A string containing the name of the day of the week, the name of the month, the numeric day of the month, and the year equivalent to the date value of this instance.

toLongTimeString

@Nonnull
public final String toLongTimeString()

Converts the value of this instance to its equivalent long time string representation.

Returns:

A string containing the name of the day of the week, the name of the month, the numeric day of the hours, minutes, and seconds equivalent to the time value of this instance.

toShortDateString

@Nonnull
public final String toShortDateString()

Converts the value of this instance to its equivalent short date string representation.

Returns:

A string containing the numeric month, the numeric day of the month, and the year equivalent to the date value of this instance.

toShortTimeString

@Nonnull
public final String toShortTimeString()

Converts the value of this instance to its equivalent short time string representation.

Returns:

A string containing the name of the day of the week, the name of the month, the numeric day of the hours, minutes, and seconds equivalent to the time value of this instance.

equals

public static boolean equals(@Nonnull
                             GregorianDate left,
                             @Nonnull
                             GregorianDate right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                GregorianDate left,
                                @Nonnull
                                GregorianDate right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

lessThan

public static boolean lessThan(@Nonnull
                               GregorianDate left,
                               @Nonnull
                               GregorianDate right)

Returns true if left is less than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than right; otherwise false.

greaterThan

public static boolean greaterThan(@Nonnull
                                  GregorianDate left,
                                  @Nonnull
                                  GregorianDate right)

Returns true if left is greater than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than right; otherwise false.

lessThanOrEqual

public static boolean lessThanOrEqual(@Nonnull
                                      GregorianDate left,
                                      @Nonnull
                                      GregorianDate right)

Returns true if left is less than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than or equal to right; otherwise false.

greaterThanOrEqual

public static boolean greaterThanOrEqual(@Nonnull
                                         GregorianDate left,
                                         @Nonnull
                                         GregorianDate right)

Returns true if left is greater than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than or equal to right; otherwise false.

parse

@Nonnull
public static GregorianDate parse(@Nonnull
                                            String s)

Converts the specified string representation of a date and time to its GregorianDate equivalent.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information. However, this will handle three common ISO8601 formats:

• the extended format "YYYY-MM-DDThh:mm:ss.sZ"
• The "day of year" equivalent "YYYY-DDDThh:mm:ss.sZ"
• The basic format "YYYYMMDDThhmmss.sZ"

Parameters:

s - A string containing a date and time to convert.

Returns:

A GregorianDate equivalent to the date and time contained in s.

Throws:

ArgumentNullException - Thrown if s is null.

NumberFormatException - Thrown if s does not contain a valid string representation of a date and time.

parse

@Nonnull
public static GregorianDate parse(@Nonnull
                                            String s,
                                            @Nullable
                                            Locale provider)

Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified culture-specific format information.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information. However, this will handle three common ISO8601 formats:

• the extended format "YYYY-MM-DDThh:mm:ss.sZ"
• The "day of year" equivalent "YYYY-DDDThh:mm:ss.sZ"
• The basic format "YYYYMMDDThhmmss.sZ"

Parameters:

s - A string containing a date and time to convert.

provider - An Locale that supplies culture-specific format information about s.

Returns:

A GregorianDate equivalent to the date and time contained in s as specified by provider.

Throws:

ArgumentNullException - Thrown if s is null.

NumberFormatException - Thrown if s does not contain a valid string representation of a date and time.

parseExact

@Nonnull
public static GregorianDate parseExact(@Nonnull
                                                 String s,
                                                 @Nonnull
                                                 String format,
                                                 @Nullable
                                                 Locale provider)

Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information.

Parameters:

s - A string containing a date and time to convert.

format - The expected format of s.

provider - An Locale that supplies culture-specific format information about s.

Returns:

A GregorianDate equivalent to the date and time contained in s as specified by format and provider.

Throws:

ArgumentNullException - Thrown if s or format is null.

NumberFormatException - Thrown if s or format is an empty string, or if s does not contain a date and time that corresponds to the pattern specified in format.

parseExact

@Nonnull
public static GregorianDate parseExact(@Nonnull
                                                 String s,
                                                 @Nonnull
                                                 String[] format,
                                                 @Nullable
                                                 Locale provider)

Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information.

Parameters:

s - A list of strings containing a date and time to convert.

format - The expected format of s.

provider - An Locale that supplies culture-specific format information about s.

Returns:

A GregorianDate equivalent to the date and time contained in s as specified by format and provider.

Throws:

ArgumentNullException - Thrown if s or format is null.

NumberFormatException - Thrown if s or format is an empty string, or if s does not contain a date and time that corresponds to the pattern specified in format.

tryParse

public static boolean tryParse(String s,
                               @Nonnull
                               GregorianDate[] result)

Converts the specified string representation of a date and time to its GregorianDate equivalent.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information. However, this method handles three common ISO8601 formats:

• the extended format "YYYY-MM-DDThh:mm:ss.sZ"
• The "day of year" equivalent "YYYY-DDDThh:mm:ss.sZ"
• The basic format "YYYYMMDDThhmmss.sZ"

Parameters:

s - A string containing a date and time to convert.

result - On input, an array with one element. On return, the array is populated with the GregorianDate value equivalent to the date and time contained in s, if the conversion succeeded, or GregorianDate.MinValue if the conversion failed. The conversion fails if the s parameter is null, or does not contain a valid string representation of a date and time.

Returns:

true if s was parsed successfully; otherwise false.

tryParse

public static boolean tryParse(String s,
                               Locale provider,
                               @Nonnull
                               GregorianDate[] result)

Converts the specified string representation of a date and time to its GregorianDate equivalent using the specified culture-specific format information.

Note: GregorianDate is always assumed to be in UTC. You cannot parse strings containing time zone information. However, this method handles three common ISO8601 formats:

• the extended format "YYYY-MM-DDThh:mm:ss.sZ"
• The "day of year" equivalent "YYYY-DDDThh:mm:ss.sZ"
• The basic format "YYYYMMDDThhmmss.sZ"

Parameters:

s - A string containing a date and time to convert.

provider - An Locale that supplies culture-specific format information about s.

result - On input, an array with one element. On return, the array is populated with the GregorianDate value equivalent to the date and time contained in s, if the conversion succeeded, or GregorianDate.MinValue if the conversion failed. The conversion fails if the s parameter is null, or does not contain a valid string representation of a date and time.

Returns:

true if s was parsed successfully; otherwise false.

addSeconds

@Nonnull
public final GregorianDate addSeconds(double seconds)

Adds the specified number of seconds to this date and returns the new date.

Parameters:

seconds - The number of seconds.

Returns:

The new date.

subtractSeconds

@Nonnull
public final GregorianDate subtractSeconds(double seconds)

Subtracts the specified number of seconds from this date and returns the new date.

Parameters:

seconds - The number of seconds.

Returns:

The new date.

addMinutes

@Nonnull
public final GregorianDate addMinutes(double minutes)

Adds the specified number of minutes to this date and returns the new date.

Parameters:

minutes - The number of minutes.

Returns:

The new date.

subtractMinutes

@Nonnull
public final GregorianDate subtractMinutes(double minutes)

Subtracts the specified number of minutes from this date and returns the new date.

Parameters:

minutes - The number of minutes.

Returns:

The new date.

addHours

@Nonnull
public final GregorianDate addHours(double hours)

Adds the specified number of hours to this date and returns the new date.

Parameters:

hours - The number of hours.

Returns:

The new date.

subtractHours

@Nonnull
public final GregorianDate subtractHours(double hours)

Subtracts the specified number of hours from this date and returns the new date.

Parameters:

hours - The number of hours.

Returns:

The new date.

addDays

@Nonnull
public final GregorianDate addDays(double days)

Adds the specified number of days to this date and returns the new date.

Parameters:

days - The number of days.

Returns:

The new date.

subtractDays

@Nonnull
public final GregorianDate subtractDays(double days)

Subtracts the specified number of days from this date and returns the new date.

Parameters:

days - The number of days.

Returns:

The new date.