Class DateTimeExtensions
- java.lang.Object
-
- org.apache.groovy.datetime.extensions.DateTimeExtensions
-
public class DateTimeExtensions extends Object
This class defines new Groovy methods which appear on normal JDK Date/Time API (java.time) classes inside the Groovy environment. These extensions require JDK 8 or above.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static LocalDateTimeclearTime(LocalDateTime self)Returns aLocalDateTimewith the time portion cleared.static OffsetDateTimeclearTime(OffsetDateTime self)Returns anOffsetDateTimewith the time portion cleared.static ZonedDateTimeclearTime(ZonedDateTime self)Returns anZonedDateTimewith the time portion cleared.static Durationdiv(Duration self, long scalar)Supports the division operator; equivalent to calling theDuration.dividedBy(long)method.static voiddownto(Temporal from, Temporal to, Closure closure)Iterates from this to thetoTemporal, inclusive, decrementing by one unit each iteration, calling the closure once per iteration.static voiddownto(Temporal from, Temporal to, TemporalUnit unit, Closure closure)Iterates from this to thetoTemporal, inclusive, decrementing by oneuniteach iteration, calling the closure once per iteration.static Stringformat(LocalDate self, String pattern)Formats this date with the providedDateTimeFormatterpattern.static Stringformat(LocalDate self, FormatStyle dateStyle)Formats this date in the provided, localizedFormatStyle.static Stringformat(LocalDateTime self, String pattern)Formats this date/time with the providedDateTimeFormatterpattern.static Stringformat(LocalDateTime self, FormatStyle dateTimeStyle)Formats this date/time in the provided, localizedFormatStyle.static Stringformat(LocalTime self, String pattern)Formats this time with the providedDateTimeFormatterpattern.static Stringformat(LocalTime self, FormatStyle timeStyle)Formats this time in the provided, localizedFormatStyle.static Stringformat(OffsetDateTime self, String pattern)Formats this date/time with the providedDateTimeFormatterpattern.static Stringformat(OffsetDateTime self, FormatStyle dateTimeStyle)Formats this date/time in the provided, localizedFormatStyle.static Stringformat(OffsetTime self, String pattern)Formats this time with the providedDateTimeFormatterpattern.static Stringformat(OffsetTime self, FormatStyle timeStyle)Formats this time in the provided, localizedFormatStyle.static Stringformat(ZonedDateTime self, String pattern)Formats this date/time with the providedDateTimeFormatterpattern.static Stringformat(ZonedDateTime self, FormatStyle dateTimeStyle)Formats this date/time in the provided, localizedFormatStyle.static longgetAt(TemporalAccessor self, TemporalField field)Supports the getAt operator; equivalent to calling theTemporalAccessor.getLong(java.time.temporal.TemporalField)method.static longgetAt(TemporalAmount self, TemporalUnit unit)Supports the getAt operator; equivalent to calling theTemporalAmount.get(TemporalUnit)method.static longgetAt(ZoneOffset self, TemporalField field)Supports the getAt operator; equivalent to calling theZoneOffset.getLong(java.time.temporal.TemporalField)method.static StringgetDateString(LocalDate self)Formats this date with theDateTimeFormatter.ISO_LOCAL_DATEformatter.static StringgetDateString(LocalDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATEformatter.static StringgetDateString(OffsetDateTime self)Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATEformatter.static StringgetDateString(ZonedDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATEformatter and appends the zone's short name, e.g.static StringgetDateTimeString(LocalDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIMEformatter.static StringgetDateTimeString(OffsetDateTime self)Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE_TIMEformatter.static StringgetDateTimeString(ZonedDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIMEformatter and appends the zone's short name, e.g.static intgetEra(Year self)Equivalent to calling theYear.get(java.time.temporal.TemporalField)method with aChronoField.ERAargument.static StringgetFullName(ZoneId self)Returns the name of this zone formatted according to theTextStyle.FULLtext style.static StringgetFullName(ZoneId self, Locale locale)Returns the name of this zone formatted according to theTextStyle.FULLtext style for the providedLocale.static intgetHours(ZoneOffset self)Returns the hours component of this offset.static intgetMinutes(ZoneOffset self)Returns the minutes component of this offset.static ZoneOffsetgetOffset(ZoneId self)Returns aZoneOffsetfor this zone as of now.static ZoneOffsetgetOffset(ZoneId self, Instant instant)Returns aZoneOffsetfor this zone as of the providedInstant.static intgetSeconds(ZoneOffset self)Returns the seconds component of this offset.static StringgetShortName(ZoneId self)Returns the name of this zone formatted according to theTextStyle.SHORTtext style.static StringgetShortName(ZoneId self, Locale locale)Returns the name of this zone formatted according to theTextStyle.SHORTtext style for the providedLocale.static StringgetTimeString(LocalDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter.static StringgetTimeString(LocalTime self)Formats this time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter.static StringgetTimeString(OffsetDateTime self)Formats this date/time with theDateTimeFormatter.ISO_OFFSET_TIMEformatter.static StringgetTimeString(OffsetTime self)Formats this time with theDateTimeFormatter.ISO_OFFSET_TIMEformatter.static StringgetTimeString(ZonedDateTime self)Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter and appends the zone's short name, e.g.static intgetYearOfEra(Year self)Equivalent to calling theYear.get(java.time.temporal.TemporalField)method with aChronoField.YEAR_OF_ERAargument.static ZoneIdgetZoneId(Calendar self)Returns the Time Zone of the Calendar as a java.time.ZoneId.static ZoneIdgetZoneId(Date self)Returns the Time Zone of the Date as aZoneId.static ZoneOffsetgetZoneOffset(Calendar self)Returns the Time Zone offset of the Calendar as aZoneOffset.static ZoneOffsetgetZoneOffset(Date self)Returns the Time Zone offset of the Date as aZoneOffset, which will typically be system's default offset.static booleanisNonnegative(ChronoPeriod self)Returns true if this period is zero or positive.static booleanisNonnegative(Duration self)Returns true if this duration is zero or positive.static booleanisNonpositive(ChronoPeriod self)Returns true if this period is zero or negative.static booleanisNonpositive(Duration self)Returns true if this duration is zero or negative.static booleanisPositive(ChronoPeriod self)Returns true if this period is positive, excluding zero.static booleanisPositive(Duration self)Returns true if this duration is positive, excluding zero.static booleanisWeekday(DayOfWeek self)Returnstrueif the DayOfWeek is a weekday.static booleanisWeekend(DayOfWeek self)Returnstrueif this day of the week is a weekend day (Saturday or Sunday).static LocalDateTimeleftShift(LocalDate self, LocalTime time)Returns aLocalDateTimefrom this date and the providedLocalTime.static OffsetDateTimeleftShift(LocalDate self, OffsetTime time)Returns aOffsetDateTimefrom this date and the providedOffsetTime.static ZonedDateTimeleftShift(LocalDateTime self, ZoneId zone)Returns aOffsetDateTimeof this date/time and the providedZoneId.static OffsetDateTimeleftShift(LocalDateTime self, ZoneOffset offset)Returns anOffsetDateTimeof this date/time and the providedZoneOffset.static LocalDateTimeleftShift(LocalTime self, LocalDate date)Returns aLocalDateTimeof this time and the providedLocalDate.static OffsetTimeleftShift(LocalTime self, ZoneOffset offset)Returns anOffsetTimeof this time and the providedZoneOffset.static LocalDateleftShift(MonthDay self, int year)Returns aLocalDateof this month/day and the provided year.static LocalDateleftShift(MonthDay self, Year year)static MonthDayleftShift(Month self, int dayOfMonth)Creates aMonthDayat the provided day of the month.static YearMonthleftShift(Month self, Year year)static OffsetDateTimeleftShift(OffsetTime self, LocalDate date)Returns anOffsetDateTimeof this time and the providedLocalDate.static LocalDateleftShift(YearMonth self, int dayOfMonth)Returns aLocalDateof this year/month and the given day of the month.static YearMonthleftShift(Year self, Month month)static LocalDateleftShift(Year self, MonthDay monthDay)static ZonedDateTimeleftShift(ZoneId self, LocalDateTime dateTime)Returns aZonedDateTimeof this zone and the givenLocalDateTime.static OffsetDateTimeleftShift(ZoneOffset self, LocalDateTime dateTime)Returns anOffsetDateTimeof this offset and the providedLocalDateTime.static OffsetTimeleftShift(ZoneOffset self, LocalTime time)Returns anOffsetDateTimeof this offset and the providedLocalTime.static DayOfWeekminus(DayOfWeek self, int days)Returns theDayOfWeekthat isdaysmany days before this day of the week.static Durationminus(Duration self, long seconds)Returns aDurationthat issecondsseconds shorter that this duration.static Instantminus(Instant self, long seconds)Returns anInstantthat issecondsseconds before this instant.static LocalDateminus(LocalDate self, long days)Returns aLocalDatethat isdaysdays before this date.static longminus(LocalDate self, LocalDate other)Calculates the number of days between two datesstatic LocalDateTimeminus(LocalDateTime self, long seconds)Returns aLocalDateTimethat issecondsseconds before this date/time.static LocalTimeminus(LocalTime self, long seconds)Returns aLocalTimethat issecondsseconds before this time.static Monthminus(Month self, int months)Returns theMonththat ismonthsmonths before this month.static OffsetDateTimeminus(OffsetDateTime self, long seconds)Returns anOffsetDateTimethat issecondsseconds before this date/time.static OffsetTimeminus(OffsetTime self, long seconds)Returns anOffsetTimethat issecondsseconds before this time.static Periodminus(Period self, long days)Returns aPeriodthat isdaysdays shorter than this period.static YearMonthminus(YearMonth self, long months)Returns aYearMonththat ismonthsmonths before this year/month.static Yearminus(Year self, long years)Returns aYearthat isyearsyears before this year.static ZonedDateTimeminus(ZonedDateTime self, long seconds)Returns aZonedDateTimethat issecondsseconds before this date/time.static Durationmultiply(Duration self, long scalar)Supports the multiplication operator; equivalent to calling theDuration.multipliedBy(long)method.static Periodmultiply(Period self, int scalar)Supports the multiply operator; equivalent to calling thePeriod.multipliedBy(int)method.static Durationnegative(Duration self)Supports the unary minus operator; equivalent to calling theDuration.negated()method.static Periodnegative(Period self)Supports the unary minus operator; equivalent to calling thePeriod.negated()method.static Durationnext(Duration self)Returns aDurationthat is one second longer than this duration.static Instantnext(Instant self)Returns anInstantthat is one second after this instant.static LocalDatenext(LocalDate self)Returns aLocalDateone day after this date.static LocalDateTimenext(LocalDateTime self)Returns aLocalDateTimethat is one second after this date/time.static LocalTimenext(LocalTime self)Returns aLocalTimethat is one second after this time.static OffsetDateTimenext(OffsetDateTime self)Returns anOffsetDateTimeone second after this date/time.static OffsetTimenext(OffsetTime self)Returns anOffsetTimethat is one second after this time.static Periodnext(Period self)Returns aPeriodthat is one day longer than this period.static Yearnext(Year self)Returns aYearafter this year.static YearMonthnext(YearMonth self)Returns aYearMonththat is the month after this year/month.static ZonedDateTimenext(ZonedDateTime self)Returns aZonedDateTimethat is one second after this date/time.static DayOfWeekplus(DayOfWeek self, int days)Returns theDayOfWeekthat isdaysmany days after this day of the week.static Durationplus(Duration self, long seconds)Returns aDurationthat issecondsseconds longer than this duration.static Instantplus(Instant self, long seconds)Returns anInstantthat issecondsseconds after this instant.static LocalDateplus(LocalDate self, long days)Returns aLocalDatethat isdaysdays after this date.static LocalDateTimeplus(LocalDateTime self, long seconds)Returns aLocalDateTimethat issecondsseconds after this date/time.static LocalTimeplus(LocalTime self, long seconds)Returns aLocalTimethat issecondsseconds after this time.static Monthplus(Month self, int months)Returns theMonththat ismonthsmonths after this month.static OffsetDateTimeplus(OffsetDateTime self, long seconds)Returns anOffsetDateTimethat issecondsseconds after this date/time.static OffsetTimeplus(OffsetTime self, long seconds)Returns anOffsetTimethat issecondsseconds after this time.static Periodplus(Period self, long days)Returns aPeriodthat isdaysdays longer than this period.static YearMonthplus(YearMonth self, long months)Returns aYearMonththat ismonthsmonths after this year/month.static Yearplus(Year self, long years)Returns aYearthat isyearsyears after this year.static ZonedDateTimeplus(ZonedDateTime self, long seconds)Returns aZonedDateTimethat issecondsseconds after this date/time.static Durationpositive(Duration self)Supports the unary plus operator; equivalent to calling theDuration.abs()method.static Periodpositive(Period self)Supports the unary plus operator; returns aPeriodwith all unit values positive.static Durationprevious(Duration self)Returns aDurationthat is one second shorter than this duration.static Instantprevious(Instant self)Returns anInstantthat one second before this instant.static LocalDateprevious(LocalDate self)Returns aLocalDateone day before this date.static LocalDateTimeprevious(LocalDateTime self)Returns aLocalDateTimethat is one second before this date/time.static LocalTimeprevious(LocalTime self)Returns aLocalTimethat is one second before this time.static OffsetDateTimeprevious(OffsetDateTime self)Returns anOffsetDateTimeone second before this date/time.static OffsetTimeprevious(OffsetTime self)Returns anOffsetTimethat is one second before this time.static Periodprevious(Period self)Returns aPeriodthat is one day shorter than this period.static Yearprevious(Year self)Returns aYearbefore this year.static YearMonthprevious(YearMonth self)Returns aYearMonththat is the month before this year/month.static ZonedDateTimeprevious(ZonedDateTime self)Returns aZonedDateTimethat is one second before this date/time.static PeriodrightShift(LocalDate self, LocalDate other)static TemporalAmountrightShift(Temporal self, Temporal other)static PeriodrightShift(YearMonth self, YearMonth other)static PeriodrightShift(Year self, Year year)static CalendartoCalendar(Instant self)Returns a generally equivalentCalendarin the GMT time zone, truncated to milliseconds.static CalendartoCalendar(LocalDate self)Returns an equivalent instance ofCalendar.static CalendartoCalendar(LocalDateTime self)Returns a generally equivalent instance ofCalendar.static CalendartoCalendar(LocalTime self)Returns a generally equivalent instance ofCalendar.static CalendartoCalendar(OffsetDateTime self)Returns a generally equivalent instance ofCalendar.static CalendartoCalendar(OffsetTime self)Returns a generally equivalent instance ofCalendar.static CalendartoCalendar(ZonedDateTime self)Returns a generally equivalent instance ofCalendar.static DatetoDate(Instant self)Returns a generally equivalentDateaccording the number of milliseconds since the epoch, adjusted into the system default time zone.static DatetoDate(LocalDate self)Returns an equivalent instance ofDate.static DatetoDate(LocalDateTime self)Returns a generally equivalent instance ofDate.static DatetoDate(LocalTime self)Returns a generally equivalent instance ofDate.static DatetoDate(OffsetDateTime self)Returns a generally equivalent instance ofDate.static DatetoDate(OffsetTime self)Returns a generally equivalent instance ofDate.static DatetoDate(ZonedDateTime self)Returns a generally equivalent instance ofDate.static DayOfWeektoDayOfWeek(Calendar self)Converts the Calendar to a correspondingDayOfWeek.static DayOfWeektoDayOfWeek(Date self)Converts the Date to a correspondingDayOfWeek.static InstanttoInstant(Calendar self)Convenience method for converting a Calendar to a correspondingInstant.static LocalDatetoLocalDate(Date self)Converts the Date to a correspondingLocalDate.static LocalDateTimetoLocalDateTime(Calendar self)Converts the Calendar to a correspondingLocalDateTime.static LocalDateTimetoLocalDateTime(Date self)Converts the Date to a correspondingLocalDateTime.static LocalTimetoLocalTime(Calendar self)Converts the Calendar to a correspondingLocalTime.static LocalTimetoLocalTime(Date self)Converts the Date to a correspondingLocalTime.static MonthtoMonth(Calendar self)Converts the Calendar to a correspondingMonth.static MonthtoMonth(Date self)Converts the Date to a correspondingMonth.static MonthDaytoMonthDay(Calendar self)Converts the Calendar to a correspondingMonthDay.static MonthDaytoMonthDay(Date self)Converts the Date to a correspondingMonthDay.static OffsetDateTimetoOffsetDateTime(Calendar self)Converts the Calendar to a correspondingOffsetDateTime.static OffsetDateTimetoOffsetDateTime(Date self)Converts the Date to a correspondingOffsetDateTime.static OffsetTimetoOffsetTime(Calendar self)Converts the Calendar to a correspondingOffsetTime.static OffsetTimetoOffsetTime(Date self)Converts the Date to a correspondingOffsetTime.static TimeZonetoTimeZone(ZoneId self)Returns aTimeZoneequivalent to this zone.static TimeZonetoTimeZone(ZoneOffset self)Returns a generally equivalentTimeZone.static YeartoYear(Calendar self)Converts the Calendar to a correspondingYear.static YeartoYear(Date self)Converts the Date to a correspondingYear.static YearMonthtoYearMonth(Calendar self)Converts the Calendar to a correspondingYearMonth.static YearMonthtoYearMonth(Date self)Converts the Date to a correspondingYearMonth.static ZonedDateTimetoZonedDateTime(Calendar self)Converts the Calendar to a correspondingZonedDateTime.static ZonedDateTimetoZonedDateTime(Date self)Converts the Date to a correspondingZonedDateTime.static ZoneOffsettoZoneOffset(TimeZone self)Converts the TimeZone to a correspondingZoneOffset.static ZoneOffsettoZoneOffset(TimeZone self, Instant instant)Converts this TimeZone to a correspondingZoneOffset.static voidupto(Temporal from, Temporal to, Closure closure)Iterates from this to thetoTemporal, inclusive, incrementing by one unit each iteration, calling the closure once per iteration.static voidupto(Temporal from, Temporal to, TemporalUnit unit, Closure closure)Iterates from this to thetoTemporal, inclusive, incrementing by oneuniteach iteration, calling the closure once per iteration.
-
-
-
Method Detail
-
upto
public static void upto(Temporal from, Temporal to, Closure closure)
Iterates from this to thetoTemporal, inclusive, incrementing by one unit each iteration, calling the closure once per iteration. The closure may accept a singleTemporalargument.The particular unit incremented by depends on the specific sub-type of
Temporal. Most sub-types use a unit ofChronoUnit.SECONDSexcept forChronoLocalDateand its sub-types useChronoUnit.DAYS.YearMonthusesChronoUnit.MONTHS.YearusesChronoUnit.YEARS.
- Parameters:
from- the starting Temporalto- the ending Temporalclosure- the zero or one-argument closure to call- Throws:
GroovyRuntimeException- if this value is later thantoGroovyRuntimeException- iftois a different type than this- Since:
- 2.5.0
-
upto
public static void upto(Temporal from, Temporal to, TemporalUnit unit, Closure closure)
Iterates from this to thetoTemporal, inclusive, incrementing by oneuniteach iteration, calling the closure once per iteration. The closure may accept a singleTemporalargument.If the unit is too large to iterate to the second Temporal exactly, such as iterating from two LocalDateTimes that are seconds apart using
ChronoUnit.DAYSas the unit, the iteration will cease as soon as the current value of the iteration is later than the second Temporal argument. The closure will not be called with any value later than thetovalue.- Parameters:
from- the starting Temporalto- the ending Temporalunit- the TemporalUnit to increment byclosure- the zero or one-argument closure to call- Throws:
GroovyRuntimeException- if this value is later thantoGroovyRuntimeException- iftois a different type than this- Since:
- 2.5.0
-
downto
public static void downto(Temporal from, Temporal to, Closure closure)
Iterates from this to thetoTemporal, inclusive, decrementing by one unit each iteration, calling the closure once per iteration. The closure may accept a singleTemporalargument.The particular unit decremented by depends on the specific sub-type of
Temporal. Most sub-types use a unit ofChronoUnit.SECONDSexcept forChronoLocalDateand its sub-types useChronoUnit.DAYS.YearMonthusesChronoUnit.MONTHS.YearusesChronoUnit.YEARS.
- Parameters:
from- the starting Temporalto- the ending Temporalclosure- the zero or one-argument closure to call- Throws:
GroovyRuntimeException- if this value is earlier thantoGroovyRuntimeException- iftois a different type than this- Since:
- 2.5.0
-
downto
public static void downto(Temporal from, Temporal to, TemporalUnit unit, Closure closure)
Iterates from this to thetoTemporal, inclusive, decrementing by oneuniteach iteration, calling the closure once per iteration. The closure may accept a singleTemporalargument.If the unit is too large to iterate to the second Temporal exactly, such as iterating from two LocalDateTimes that are seconds apart using
ChronoUnit.DAYSas the unit, the iteration will cease as soon as the current value of the iteration is earlier than the second Temporal argument. The closure will not be called with any value earlier than thetovalue.- Parameters:
from- the starting Temporalto- the ending Temporalunit- the TemporalUnit to increment byclosure- the zero or one-argument closure to call- Throws:
GroovyRuntimeException- if this value is earlier thantoGroovyRuntimeException- iftois a different type than this- Since:
- 2.5.0
-
rightShift
public static TemporalAmount rightShift(Temporal self, Temporal other)
Returns aDurationorPeriodbetween this (inclusive) and theotherTemporal(exclusive).A Period will be returned for types
Year,YearMonth, andChronoLocalDate; otherwise, a Duration will be returned.Note: if the Temporal is a ChronoLocalDate but not a
LocalDate, a generalChronoPeriodwill be returned as per the return type of the methodChronoLocalDate.until(ChronoLocalDate).- Parameters:
self- a Temporalother- another Temporal of the same type- Returns:
- an TemporalAmount between the two Temporals
- Since:
- 2.5.0
-
getAt
public static long getAt(TemporalAccessor self, TemporalField field)
Supports the getAt operator; equivalent to calling theTemporalAccessor.getLong(java.time.temporal.TemporalField)method.- Parameters:
self- a TemporalAccessorfield- a non-null TemporalField- Returns:
- the value for the field
- Throws:
DateTimeException- if a value for the field cannot be obtainedUnsupportedTemporalTypeException- if the field is not supportedArithmeticException- if numeric overflow occurs- Since:
- 2.5.0
-
getAt
public static long getAt(TemporalAmount self, TemporalUnit unit)
Supports the getAt operator; equivalent to calling theTemporalAmount.get(TemporalUnit)method.- Parameters:
self- a TemporalAmountunit- a non-null TemporalUnit- Returns:
- the value for the field
- Throws:
DateTimeException- if a value for the field cannot be obtainedUnsupportedTemporalTypeException- if the field is not supportedArithmeticException- if numeric overflow occurs- Since:
- 2.5.0
-
plus
public static Duration plus(Duration self, long seconds)
Returns aDurationthat issecondsseconds longer than this duration.- Parameters:
self- a Durationseconds- the number of seconds to add- Returns:
- a Duration
- Since:
- 2.5.0
-
minus
public static Duration minus(Duration self, long seconds)
Returns aDurationthat issecondsseconds shorter that this duration.- Parameters:
self- a Durationseconds- the number of seconds to subtract- Returns:
- a Duration
- Since:
- 2.5.0
-
next
public static Duration next(Duration self)
Returns aDurationthat is one second longer than this duration.- Parameters:
self- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
previous
public static Duration previous(Duration self)
Returns aDurationthat is one second shorter than this duration.- Parameters:
self- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
negative
public static Duration negative(Duration self)
Supports the unary minus operator; equivalent to calling theDuration.negated()method.- Parameters:
self- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
positive
public static Duration positive(Duration self)
Supports the unary plus operator; equivalent to calling theDuration.abs()method.- Parameters:
self- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
multiply
public static Duration multiply(Duration self, long scalar)
Supports the multiplication operator; equivalent to calling theDuration.multipliedBy(long)method.- Parameters:
self- a Durationscalar- the value to multiply by- Returns:
- a Duration
- Since:
- 2.5.0
-
div
public static Duration div(Duration self, long scalar)
Supports the division operator; equivalent to calling theDuration.dividedBy(long)method.- Parameters:
self- a Durationscalar- the value to divide by- Returns:
- a Duration
- Since:
- 2.5.0
-
isPositive
public static boolean isPositive(Duration self)
Returns true if this duration is positive, excluding zero.- Parameters:
self- a Duration- Returns:
- true if positive
- Since:
- 2.5.0
-
isNonnegative
public static boolean isNonnegative(Duration self)
Returns true if this duration is zero or positive.- Parameters:
self- a Duration- Returns:
- true if nonnegative
- Since:
- 2.5.0
-
isNonpositive
public static boolean isNonpositive(Duration self)
Returns true if this duration is zero or negative.- Parameters:
self- a Duration- Returns:
- true if nonpositive
- Since:
- 2.5.0
-
plus
public static Instant plus(Instant self, long seconds)
Returns anInstantthat issecondsseconds after this instant.- Parameters:
self- an Instantseconds- the number of seconds to add- Returns:
- an Instant
- Since:
- 2.5.0
-
minus
public static Instant minus(Instant self, long seconds)
Returns anInstantthat issecondsseconds before this instant.- Parameters:
self- an Instantseconds- the number of seconds to subtract- Returns:
- an Instant
- Since:
- 2.5.0
-
next
public static Instant next(Instant self)
Returns anInstantthat is one second after this instant.- Parameters:
self- an Instant- Returns:
- an Instant one second ahead
- Since:
- 2.5.0
-
previous
public static Instant previous(Instant self)
Returns anInstantthat one second before this instant.- Parameters:
self- an Instant- Returns:
- an Instant one second behind
- Since:
- 2.5.0
-
toDate
public static Date toDate(Instant self)
Returns a generally equivalentDateaccording the number of milliseconds since the epoch, adjusted into the system default time zone.- Parameters:
self- an Instant- Returns:
- a Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(Instant self)
Returns a generally equivalentCalendarin the GMT time zone, truncated to milliseconds.- Parameters:
self- an Instant- Returns:
- a Calendar
- Since:
- 2.5.0
-
format
public static String format(LocalDate self, String pattern)
Formats this date with the providedDateTimeFormatterpattern.- Parameters:
self- a LocalDatepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(LocalDate self, FormatStyle dateStyle)
Formats this date in the provided, localizedFormatStyle.- Parameters:
self- a LocalDatedateStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateString
public static String getDateString(LocalDate self)
Formats this date with theDateTimeFormatter.ISO_LOCAL_DATEformatter.- Parameters:
self- a LocalDate- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
plus
public static LocalDate plus(LocalDate self, long days)
Returns aLocalDatethat isdaysdays after this date.- Parameters:
self- a LocalDatedays- the number of days to add- Returns:
- a LocalDate
- Since:
- 2.5.0
-
minus
public static LocalDate minus(LocalDate self, long days)
Returns aLocalDatethat isdaysdays before this date.- Parameters:
self- a LocalDatedays- the number of days to subtract- Returns:
- a LocalDate
- Since:
- 2.5.0
-
minus
public static long minus(LocalDate self, LocalDate other)
Calculates the number of days between two dates- Parameters:
self- a LocalDateother- the other LocalDate- Returns:
- the number of days
- Since:
- 3.0.0
-
next
public static LocalDate next(LocalDate self)
Returns aLocalDateone day after this date.- Parameters:
self- a LocalDate- Returns:
- the next day
- Since:
- 2.5.0
-
previous
public static LocalDate previous(LocalDate self)
Returns aLocalDateone day before this date.- Parameters:
self- a LocalDate- Returns:
- the previous day
- Since:
- 2.5.0
-
rightShift
public static Period rightShift(LocalDate self, LocalDate other)
Returns aPeriodequivalent to the time between this date (inclusive) and the providedLocalDate(exclusive).- Parameters:
self- a LocalDateother- another LocalDate- Returns:
- a Period representing the time between the two LocalDates
- Since:
- 2.5.0
-
leftShift
public static LocalDateTime leftShift(LocalDate self, LocalTime time)
Returns aLocalDateTimefrom this date and the providedLocalTime.- Parameters:
self- a LocalDatetime- a LocalTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
public static OffsetDateTime leftShift(LocalDate self, OffsetTime time)
Returns aOffsetDateTimefrom this date and the providedOffsetTime.- Parameters:
self- a LocalDatetime- an OffsetTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(LocalDate self)
Returns an equivalent instance ofDate. The time portion of the returned date is cleared.- Parameters:
self- a LocalDate- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(LocalDate self)
Returns an equivalent instance ofCalendar. The time portion of the returned calendar is cleared and the time zone is the current system default.- Parameters:
self- a LocalDate- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
format
public static String format(LocalDateTime self, String pattern)
Formats this date/time with the providedDateTimeFormatterpattern.- Parameters:
self- a LocalDateTimepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(LocalDateTime self, FormatStyle dateTimeStyle)
Formats this date/time in the provided, localizedFormatStyle.- Parameters:
self- a LocalDateTimedateTimeStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateTimeString
public static String getDateTimeString(LocalDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIMEformatter.- Parameters:
self- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateString
public static String getDateString(LocalDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATEformatter.- Parameters:
self- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getTimeString
public static String getTimeString(LocalDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter.- Parameters:
self- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
clearTime
public static LocalDateTime clearTime(LocalDateTime self)
Returns aLocalDateTimewith the time portion cleared.- Parameters:
self- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
plus
public static LocalDateTime plus(LocalDateTime self, long seconds)
Returns aLocalDateTimethat issecondsseconds after this date/time.- Parameters:
self- a LocalDateTimeseconds- the number of seconds to add- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
minus
public static LocalDateTime minus(LocalDateTime self, long seconds)
Returns aLocalDateTimethat issecondsseconds before this date/time.- Parameters:
self- a LocalDateTimeseconds- the number of seconds to subtract- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
next
public static LocalDateTime next(LocalDateTime self)
Returns aLocalDateTimethat is one second after this date/time.- Parameters:
self- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
previous
public static LocalDateTime previous(LocalDateTime self)
Returns aLocalDateTimethat is one second before this date/time.- Parameters:
self- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
public static OffsetDateTime leftShift(LocalDateTime self, ZoneOffset offset)
Returns anOffsetDateTimeof this date/time and the providedZoneOffset.- Parameters:
self- a LocalDateTimeoffset- a ZoneOffset- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
leftShift
public static ZonedDateTime leftShift(LocalDateTime self, ZoneId zone)
Returns aOffsetDateTimeof this date/time and the providedZoneId.- Parameters:
self- a LocalDateTimezone- a ZoneId- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(LocalDateTime self)
Returns a generally equivalent instance ofDate. The time value of the returned date is truncated to milliseconds.- Parameters:
self- a LocalDateTime- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(LocalDateTime self)
Returns a generally equivalent instance ofCalendar. The time value of the returned calendar is truncated to milliseconds and the time zone is the current system default.- Parameters:
self- a LocalDateTime- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
format
public static String format(LocalTime self, String pattern)
Formats this time with the providedDateTimeFormatterpattern.- Parameters:
self- a LocalDateTimepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(LocalTime self, FormatStyle timeStyle)
Formats this time in the provided, localizedFormatStyle.- Parameters:
self- a LocalTimetimeStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getTimeString
public static String getTimeString(LocalTime self)
Formats this time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter.- Parameters:
self- a LocalTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
plus
public static LocalTime plus(LocalTime self, long seconds)
Returns aLocalTimethat issecondsseconds after this time.- Parameters:
self- a LocalTimeseconds- the number of seconds to add- Returns:
- a LocalTime
- Since:
- 2.5.0
-
minus
public static LocalTime minus(LocalTime self, long seconds)
Returns aLocalTimethat issecondsseconds before this time.- Parameters:
self- a LocalTimeseconds- the number of seconds to subtract- Returns:
- a LocalTime
- Since:
- 2.5.0
-
next
public static LocalTime next(LocalTime self)
Returns aLocalTimethat is one second after this time.- Parameters:
self- a LocalTime- Returns:
- a LocalTime
- Since:
- 2.5.0
-
previous
public static LocalTime previous(LocalTime self)
Returns aLocalTimethat is one second before this time.- Parameters:
self- a LocalTime- Returns:
- a LocalTime
- Since:
- 2.5.0
-
leftShift
public static LocalDateTime leftShift(LocalTime self, LocalDate date)
Returns aLocalDateTimeof this time and the providedLocalDate.- Parameters:
self- a LocalTimedate- a LocalDate- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
public static OffsetTime leftShift(LocalTime self, ZoneOffset offset)
Returns anOffsetTimeof this time and the providedZoneOffset.- Parameters:
self- a LocalTimeoffset- a ZoneOffset- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(LocalTime self)
Returns a generally equivalent instance ofDate. The day-month-year value of the returned date is today and the time is truncated to milliseconds.- Parameters:
self- a LocalTime- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(LocalTime self)
Returns a generally equivalent instance ofCalendar. The day-month-year value of the returned calendar is today, the time is truncated to milliseconds, and the time zone is the current system default.- Parameters:
self- a LocalTime- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
leftShift
public static LocalDate leftShift(MonthDay self, int year)
Returns aLocalDateof this month/day and the provided year.- Parameters:
self- a MonthDayyear- a year- Returns:
- a LocalDate
- Since:
- 2.5.0
-
leftShift
public static LocalDate leftShift(MonthDay self, Year year)
- Parameters:
self- a MonthDayyear- a Year- Returns:
- a LocalDate
- Since:
- 2.5.0
-
format
public static String format(OffsetDateTime self, String pattern)
Formats this date/time with the providedDateTimeFormatterpattern.- Parameters:
self- an OffsetDateTimepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(OffsetDateTime self, FormatStyle dateTimeStyle)
Formats this date/time in the provided, localizedFormatStyle.- Parameters:
self- an OffsetDateTimedateTimeStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateTimeString
public static String getDateTimeString(OffsetDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE_TIMEformatter.- Parameters:
self- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateString
public static String getDateString(OffsetDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATEformatter.- Parameters:
self- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getTimeString
public static String getTimeString(OffsetDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_TIMEformatter.- Parameters:
self- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
clearTime
public static OffsetDateTime clearTime(OffsetDateTime self)
Returns anOffsetDateTimewith the time portion cleared.- Parameters:
self- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
plus
public static OffsetDateTime plus(OffsetDateTime self, long seconds)
Returns anOffsetDateTimethat issecondsseconds after this date/time.- Parameters:
self- an OffsetDateTimeseconds- the number of seconds to add- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
minus
public static OffsetDateTime minus(OffsetDateTime self, long seconds)
Returns anOffsetDateTimethat issecondsseconds before this date/time.- Parameters:
self- an OffsetDateTimeseconds- the number of seconds to subtract- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
next
public static OffsetDateTime next(OffsetDateTime self)
Returns anOffsetDateTimeone second after this date/time.- Parameters:
self- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
previous
public static OffsetDateTime previous(OffsetDateTime self)
Returns anOffsetDateTimeone second before this date/time.- Parameters:
self- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(OffsetDateTime self)
Returns a generally equivalent instance ofDate. The time value of the returned date is truncated to milliseconds and will be adjusted to the current system default time zone.- Parameters:
self- an OffsetDateTime- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(OffsetDateTime self)
Returns a generally equivalent instance ofCalendar. The time value of the returned calendar is truncated to milliseconds and the time zone is based on the offset of this date/time.- Parameters:
self- an OffsetDateTime- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
format
public static String format(OffsetTime self, String pattern)
Formats this time with the providedDateTimeFormatterpattern.- Parameters:
self- an OffsetTimepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(OffsetTime self, FormatStyle timeStyle)
Formats this time in the provided, localizedFormatStyle.- Parameters:
self- an OffsetTimetimeStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getTimeString
public static String getTimeString(OffsetTime self)
Formats this time with theDateTimeFormatter.ISO_OFFSET_TIMEformatter.- Parameters:
self- an OffsetTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
plus
public static OffsetTime plus(OffsetTime self, long seconds)
Returns anOffsetTimethat issecondsseconds after this time.- Parameters:
self- an OffsetTimeseconds- the number of seconds to add- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
minus
public static OffsetTime minus(OffsetTime self, long seconds)
Returns anOffsetTimethat issecondsseconds before this time.- Parameters:
self- an OffsetTimeseconds- the number of seconds to subtract- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
next
public static OffsetTime next(OffsetTime self)
Returns anOffsetTimethat is one second after this time.- Parameters:
self- an OffsetTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
previous
public static OffsetTime previous(OffsetTime self)
Returns anOffsetTimethat is one second before this time.- Parameters:
self- an OffsetTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
leftShift
public static OffsetDateTime leftShift(OffsetTime self, LocalDate date)
Returns anOffsetDateTimeof this time and the providedLocalDate.- Parameters:
self- an OffsetTimedate- a LocalDate- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(OffsetTime self)
Returns a generally equivalent instance ofDate. The time value of the returned date is truncated to milliseconds and will be adjusted to the current system default time zone.- Parameters:
self- an OffsetTime- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(OffsetTime self)
Returns a generally equivalent instance ofCalendar. The date value of the returned calendar is now, the time value is truncated to milliseconds, and the time zone is based on the offset of this time.- Parameters:
self- an OffsetTime- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
plus
public static Period plus(Period self, long days)
Returns aPeriodthat isdaysdays longer than this period. No normalization is performed.- Parameters:
self- a Perioddays- the number of days to increase this Period by- Returns:
- a Period
- Since:
- 2.5.0
-
minus
public static Period minus(Period self, long days)
Returns aPeriodthat isdaysdays shorter than this period. No normalization is performed.- Parameters:
self- a Perioddays- the number of days to decrease this Period by- Returns:
- a Period
- Since:
- 2.5.0
-
next
public static Period next(Period self)
Returns aPeriodthat is one day longer than this period. No normalization is performed.- Parameters:
self- a Period- Returns:
- a Period one day longer in length
- Since:
- 2.5.0
-
previous
public static Period previous(Period self)
Returns aPeriodthat is one day shorter than this period. No normalization is performed.- Parameters:
self- a Period- Returns:
- a Period one day shorter in length
- Since:
- 2.5.0
-
negative
public static Period negative(Period self)
Supports the unary minus operator; equivalent to calling thePeriod.negated()method.- Parameters:
self- a Period- Returns:
- a negated Period
- Since:
- 2.5.0
-
positive
public static Period positive(Period self)
Supports the unary plus operator; returns aPeriodwith all unit values positive. For example, a period of "2 years, -3 months, and -4 days" would result in a period of "2 years, 3 months, and 4 days." No normalization is performed.- Parameters:
self- a Period- Returns:
- a positive Period
- Since:
- 2.5.0
-
multiply
public static Period multiply(Period self, int scalar)
Supports the multiply operator; equivalent to calling thePeriod.multipliedBy(int)method.- Parameters:
self- a Periodscalar- a scalar to multiply each unit by- Returns:
- a Period
- Since:
- 2.5.0
-
isPositive
public static boolean isPositive(ChronoPeriod self)
Returns true if this period is positive, excluding zero.- Parameters:
self- a ChronoPeriod- Returns:
- true if positive
- Since:
- 2.5.0
-
isNonnegative
public static boolean isNonnegative(ChronoPeriod self)
Returns true if this period is zero or positive.- Parameters:
self- a ChronoPeriod- Returns:
- true if nonnegative
- Since:
- 2.5.0
-
isNonpositive
public static boolean isNonpositive(ChronoPeriod self)
Returns true if this period is zero or negative.- Parameters:
self- a ChronoPeriod- Returns:
- true if nonpositive
- Since:
- 2.5.0
-
plus
public static Year plus(Year self, long years)
Returns aYearthat isyearsyears after this year.- Parameters:
self- a Yearyears- the number of years to add- Returns:
- a Year
- Since:
- 2.5.0
-
minus
public static Year minus(Year self, long years)
Returns aYearthat isyearsyears before this year.- Parameters:
self- a Yearyears- the number of years to subtract- Returns:
- a Year
- Since:
- 2.5.0
-
next
public static Year next(Year self)
Returns aYearafter this year.- Parameters:
self- a Year- Returns:
- the next Year
- Since:
- 2.5.0
-
previous
public static Year previous(Year self)
Returns aYearbefore this year.- Parameters:
self- a Year- Returns:
- the previous Year
- Since:
- 2.5.0
-
rightShift
public static Period rightShift(Year self, Year year)
Returns aPeriodbetween the first day of this year (inclusive) and the first day of the providedYear(exclusive).- Parameters:
self- a Yearyear- another Year- Returns:
- a Period between the Years
- Since:
- 2.5.0
-
leftShift
public static YearMonth leftShift(Year self, Month month)
- Parameters:
self- a Yearmonth- a Month- Returns:
- a YearMonth
- Since:
- 2.5.0
-
leftShift
public static LocalDate leftShift(Year self, MonthDay monthDay)
- Parameters:
self- a YearmonthDay- a MonthDay- Returns:
- a LocalDate
- Since:
- 2.5.0
-
getEra
public static int getEra(Year self)
Equivalent to calling theYear.get(java.time.temporal.TemporalField)method with aChronoField.ERAargument.Returns the era of the year, which is currently either 0 (BC) or 1 (AD).
- Parameters:
self- a Year- Returns:
- an int representing the era
- Since:
- 2.5.0
-
getYearOfEra
public static int getYearOfEra(Year self)
Equivalent to calling theYear.get(java.time.temporal.TemporalField)method with aChronoField.YEAR_OF_ERAargument.Since Year=0 represents 1 BC, the yearOfEra value of Year=0 is 1, Year=-1 is 2, and so on.
- Parameters:
self- a Year- Returns:
- the year value of the era
- Since:
- 2.5.0
-
plus
public static YearMonth plus(YearMonth self, long months)
Returns aYearMonththat ismonthsmonths after this year/month.- Parameters:
self- a YearMonthmonths- the number of months to add- Returns:
- a Year
- Since:
- 2.5.0
-
minus
public static YearMonth minus(YearMonth self, long months)
Returns aYearMonththat ismonthsmonths before this year/month.- Parameters:
self- a YearMonthmonths- the number of months to subtract- Returns:
- a Year
- Since:
- 2.5.0
-
next
public static YearMonth next(YearMonth self)
Returns aYearMonththat is the month after this year/month.- Parameters:
self- a YearMonth- Returns:
- the next YearMonth
- Since:
- 2.5.0
-
previous
public static YearMonth previous(YearMonth self)
Returns aYearMonththat is the month before this year/month.- Parameters:
self- a YearMonth- Returns:
- the previous YearMonth
- Since:
- 2.5.0
-
leftShift
public static LocalDate leftShift(YearMonth self, int dayOfMonth)
Returns aLocalDateof this year/month and the given day of the month.- Parameters:
self- a YearMonthdayOfMonth- a day of the month- Returns:
- a LocalDate
- Since:
- 2.5.0
-
rightShift
public static Period rightShift(YearMonth self, YearMonth other)
Returns aPeriodof time between the first day of this year/month (inclusive) and the givenYearMonth(exclusive).- Parameters:
self- a YearMonthother- another YearMonth- Returns:
- a Period
- Since:
- 2.5.0
-
format
public static String format(ZonedDateTime self, String pattern)
Formats this date/time with the providedDateTimeFormatterpattern.- Parameters:
self- a ZonedDateTimepattern- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
format
public static String format(ZonedDateTime self, FormatStyle dateTimeStyle)
Formats this date/time in the provided, localizedFormatStyle.- Parameters:
self- a ZonedDateTimedateTimeStyle- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateTimeString
public static String getDateTimeString(ZonedDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIMEformatter and appends the zone's short name, e.g.2018-03-10T14:34:55.144EST.- Parameters:
self- a ZonedDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getDateString
public static String getDateString(ZonedDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATEformatter and appends the zone's short name, e.g.2018-03-10EST.- Parameters:
self- a ZonedDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
getTimeString
public static String getTimeString(ZonedDateTime self)
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIMEformatter and appends the zone's short name, e.g.14:34:55.144EST.- Parameters:
self- a ZonedDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
DateTimeFormatter
-
clearTime
public static ZonedDateTime clearTime(ZonedDateTime self)
Returns anZonedDateTimewith the time portion cleared.- Parameters:
self- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
plus
public static ZonedDateTime plus(ZonedDateTime self, long seconds)
Returns aZonedDateTimethat issecondsseconds after this date/time.- Parameters:
self- an ZonedDateTimeseconds- the number of seconds to add- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
minus
public static ZonedDateTime minus(ZonedDateTime self, long seconds)
Returns aZonedDateTimethat issecondsseconds before this date/time.- Parameters:
self- a ZonedDateTimeseconds- the number of seconds to subtract- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
next
public static ZonedDateTime next(ZonedDateTime self)
Returns aZonedDateTimethat is one second after this date/time.- Parameters:
self- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
previous
public static ZonedDateTime previous(ZonedDateTime self)
Returns aZonedDateTimethat is one second before this date/time.- Parameters:
self- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toDate
public static Date toDate(ZonedDateTime self)
Returns a generally equivalent instance ofDate. The time value of the returned date is truncated to milliseconds and will be adjusted to the current system default time zone.- Parameters:
self- a ZonedDateTime- Returns:
- a java.util.Date
- Since:
- 2.5.0
-
toCalendar
public static Calendar toCalendar(ZonedDateTime self)
Returns a generally equivalent instance ofCalendar. The time value of the returned calendar is truncated to milliseconds and the time zone is determined by the zone of this date/time.- Parameters:
self- an ZonedDateTime- Returns:
- a java.util.Calendar
- Since:
- 2.5.0
-
toTimeZone
public static TimeZone toTimeZone(ZoneId self)
Returns aTimeZoneequivalent to this zone.- Parameters:
self- a ZoneId- Returns:
- a TimeZone
- Since:
- 2.5.0
-
getFullName
public static String getFullName(ZoneId self)
Returns the name of this zone formatted according to theTextStyle.FULLtext style.- Parameters:
self- a ZoneId- Returns:
- the full display name of the ZoneId
- Since:
- 2.5.0
-
getFullName
public static String getFullName(ZoneId self, Locale locale)
Returns the name of this zone formatted according to theTextStyle.FULLtext style for the providedLocale.- Parameters:
self- a ZoneIdlocale- a Locale- Returns:
- the full display name of the ZoneId
- Since:
- 2.5.0
-
getShortName
public static String getShortName(ZoneId self)
Returns the name of this zone formatted according to theTextStyle.SHORTtext style.- Parameters:
self- a ZoneId- Returns:
- the short display name of the ZoneId
- Since:
- 2.5.0
-
getShortName
public static String getShortName(ZoneId self, Locale locale)
Returns the name of this zone formatted according to theTextStyle.SHORTtext style for the providedLocale.- Parameters:
self- a ZoneIdlocale- a Locale- Returns:
- the short display name of the ZoneId
- Since:
- 2.5.0
-
getOffset
public static ZoneOffset getOffset(ZoneId self)
Returns aZoneOffsetfor this zone as of now.- Parameters:
self- a ZoneId- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
getOffset
public static ZoneOffset getOffset(ZoneId self, Instant instant)
Returns aZoneOffsetfor this zone as of the providedInstant.- Parameters:
self- a ZoneIdinstant- an Instant- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
leftShift
public static ZonedDateTime leftShift(ZoneId self, LocalDateTime dateTime)
Returns aZonedDateTimeof this zone and the givenLocalDateTime.- Parameters:
self- a ZoneId- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toTimeZone
public static TimeZone toTimeZone(ZoneOffset self)
Returns a generally equivalentTimeZone. The offset will be truncated to minutes.- Parameters:
self- a ZoneOffset- Returns:
- a TimeZone
- Since:
- 2.5.0
-
getHours
public static int getHours(ZoneOffset self)
Returns the hours component of this offset. If the offset's total seconds are negative, a negative value will be returned.- Parameters:
self- a ZoneOffset- Returns:
- the hours component value
- Since:
- 2.5.0
-
getMinutes
public static int getMinutes(ZoneOffset self)
Returns the minutes component of this offset. If the offset's total seconds are negative, a negative value will be returned.- Parameters:
self- a ZoneOffset- Returns:
- the minutes component value
- Since:
- 2.5.0
-
getSeconds
public static int getSeconds(ZoneOffset self)
Returns the seconds component of this offset. This is not the same as the total seconds. For example:def offset = ZoneOffset.ofHoursMinutesSeconds(0, 1, 1) assert offset.seconds == 1 assert offset.totalSeconds == 61If the offset's total seconds are negative, a negative value will be returned.
- Parameters:
self- a ZoneOffset- Returns:
- the seconds component value
- Since:
- 2.5.0
-
getAt
public static long getAt(ZoneOffset self, TemporalField field)
Supports the getAt operator; equivalent to calling theZoneOffset.getLong(java.time.temporal.TemporalField)method.- Parameters:
self- a ZoneOffsetfield- a TemporalField- Returns:
- the ZoneOffset's field value
- Since:
- 2.5.0
-
leftShift
public static OffsetDateTime leftShift(ZoneOffset self, LocalDateTime dateTime)
Returns anOffsetDateTimeof this offset and the providedLocalDateTime.- Parameters:
self- a ZoneOffsetdateTime- a LocalDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
leftShift
public static OffsetTime leftShift(ZoneOffset self, LocalTime time)
Returns anOffsetDateTimeof this offset and the providedLocalTime.- Parameters:
self- a ZoneOffsettime- a LocalTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
plus
public static DayOfWeek plus(DayOfWeek self, int days)
Returns theDayOfWeekthat isdaysmany days after this day of the week.- Parameters:
self- a DayOfWeekdays- the number of days to move forward- Returns:
- the DayOfWeek
- Since:
- 2.5.0
-
minus
public static DayOfWeek minus(DayOfWeek self, int days)
Returns theDayOfWeekthat isdaysmany days before this day of the week.- Parameters:
self- a DayOfWeekdays- the number of days to move back- Returns:
- the DayOfWeek
- Since:
- 2.5.0
-
isWeekend
public static boolean isWeekend(DayOfWeek self)
Returnstrueif this day of the week is a weekend day (Saturday or Sunday).- Parameters:
self- a DayOfWeek- Returns:
- true if this DayOfWeek is Saturday or Sunday
- Since:
- 2.5.0
-
isWeekday
public static boolean isWeekday(DayOfWeek self)
Returnstrueif the DayOfWeek is a weekday.- Returns:
- true if this DayOfWeek is Monday through Friday
- Since:
- 2.5.0
-
plus
public static Month plus(Month self, int months)
Returns theMonththat ismonthsmonths after this month.- Parameters:
self- a Monthmonths- the number of months move forward- Returns:
- the Month
- Since:
- 2.5.0
-
minus
public static Month minus(Month self, int months)
Returns theMonththat ismonthsmonths before this month.- Parameters:
self- a Monthmonths- the number of months to move back- Returns:
- the Month
- Since:
- 2.5.0
-
leftShift
public static MonthDay leftShift(Month self, int dayOfMonth)
Creates aMonthDayat the provided day of the month.- Parameters:
self- a MonthdayOfMonth- a day of the month- Returns:
- a MonthDay
- Since:
- 2.5.0
-
leftShift
public static YearMonth leftShift(Month self, Year year)
- Parameters:
self- a Monthyear- a Year- Returns:
- a YearMonth
- Since:
- 2.5.0
-
getZoneOffset
public static ZoneOffset getZoneOffset(Calendar self)
Returns the Time Zone offset of the Calendar as aZoneOffset.- Parameters:
self- a Calendar- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
getZoneOffset
public static ZoneOffset getZoneOffset(Date self)
Returns the Time Zone offset of the Date as aZoneOffset, which will typically be system's default offset.- Parameters:
self- a Date- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
getZoneId
public static ZoneId getZoneId(Calendar self)
Returns the Time Zone of the Calendar as a java.time.ZoneId.- Parameters:
self- a Calendar- Returns:
- a ZoneId
- Since:
- 2.5.0
-
getZoneId
public static ZoneId getZoneId(Date self)
Returns the Time Zone of the Date as aZoneId. This will typically be the system's default ZoneId.- Parameters:
self- a Date- Returns:
- a ZoneId
- Since:
- 2.5.0
-
toYear
public static Year toYear(Calendar self)
Converts the Calendar to a correspondingYear. If the Calendar has a different time zone than the system default, the Year will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a Year
- Since:
- 2.5.0
-
toYear
public static Year toYear(Date self)
Converts the Date to a correspondingYear.- Parameters:
self- a Date- Returns:
- a Year
- Since:
- 2.5.0
-
toMonth
public static Month toMonth(Calendar self)
Converts the Calendar to a correspondingMonth. If the Calendar has a different time zone than the system default, the Month will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a Month
- Since:
- 2.5.0
-
toMonth
public static Month toMonth(Date self)
Converts the Date to a correspondingMonth.- Parameters:
self- a Date- Returns:
- a Month
- Since:
- 2.5.0
-
toMonthDay
public static MonthDay toMonthDay(Calendar self)
Converts the Calendar to a correspondingMonthDay. If the Calendar has a different time zone than the system default, the MonthDay will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a MonthDay
- Since:
- 2.5.0
-
toMonthDay
public static MonthDay toMonthDay(Date self)
Converts the Date to a correspondingMonthDay.- Parameters:
self- a Date- Returns:
- a MonthDay
- Since:
- 2.5.0
-
toYearMonth
public static YearMonth toYearMonth(Calendar self)
Converts the Calendar to a correspondingYearMonth. If the Calendar has a different time zone than the system default, the YearMonth will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a YearMonth
- Since:
- 2.5.0
-
toYearMonth
public static YearMonth toYearMonth(Date self)
Converts the Date to a correspondingYearMonth.- Parameters:
self- a Date- Returns:
- a YearMonth
- Since:
- 2.5.0
-
toDayOfWeek
public static DayOfWeek toDayOfWeek(Calendar self)
Converts the Calendar to a correspondingDayOfWeek. If the Calendar has a different time zone than the system default, the DayOfWeek will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a DayOfWeek
- Since:
- 2.5.0
-
toDayOfWeek
public static DayOfWeek toDayOfWeek(Date self)
Converts the Date to a correspondingDayOfWeek.- Parameters:
self- a Date- Returns:
- a DayOfWeek
- Since:
- 2.5.0
-
toLocalDate
public static LocalDate toLocalDate(Date self)
Converts the Date to a correspondingLocalDate.- Parameters:
self- a Date- Returns:
- a LocalDate
- Since:
- 2.5.0
-
toLocalTime
public static LocalTime toLocalTime(Calendar self)
Converts the Calendar to a correspondingLocalTime. If the Calendar has a different time zone than the system default, the LocalTime will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a LocalTime
- Since:
- 2.5.0
-
toLocalTime
public static LocalTime toLocalTime(Date self)
Converts the Date to a correspondingLocalTime.- Parameters:
self- a Date- Returns:
- a LocalTime
- Since:
- 2.5.0
-
toLocalDateTime
public static LocalDateTime toLocalDateTime(Calendar self)
Converts the Calendar to a correspondingLocalDateTime. If the Calendar has a different time zone than the system default, the LocalDateTime will be adjusted into the default time zone.- Parameters:
self- a Calendar- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
toLocalDateTime
public static LocalDateTime toLocalDateTime(Date self)
Converts the Date to a correspondingLocalDateTime.- Parameters:
self- a Date- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
toZonedDateTime
public static ZonedDateTime toZonedDateTime(Calendar self)
Converts the Calendar to a corresponding
ZonedDateTime.Note that
GregorianCalendarhas aGregorianCalendar.toZonedDateTime()method, which is commonly the specific type of Calendar in use.- Parameters:
self- a Calendar- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toZonedDateTime
public static ZonedDateTime toZonedDateTime(Date self)
Converts the Date to a correspondingZonedDateTime.- Parameters:
self- a Date- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toOffsetDateTime
public static OffsetDateTime toOffsetDateTime(Calendar self)
Converts the Calendar to a correspondingOffsetDateTime.- Parameters:
self- a Calendar- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toOffsetDateTime
public static OffsetDateTime toOffsetDateTime(Date self)
Converts the Date to a correspondingOffsetDateTime.- Parameters:
self- a Date- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toOffsetTime
public static OffsetTime toOffsetTime(Calendar self)
Converts the Calendar to a correspondingOffsetTime.- Parameters:
self- a Calendar- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toOffsetTime
public static OffsetTime toOffsetTime(Date self)
Converts the Date to a correspondingOffsetTime.- Parameters:
self- a Date- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toInstant
public static Instant toInstant(Calendar self)
Convenience method for converting a Calendar to a correspondingInstant.- Parameters:
self- a Calendar- Returns:
- an Instant
- Since:
- 2.5.0
-
toZoneOffset
public static ZoneOffset toZoneOffset(TimeZone self)
Converts the TimeZone to a correspondingZoneOffset. The offset is determined using the current date/time.- Parameters:
self- a TimeZone- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
toZoneOffset
public static ZoneOffset toZoneOffset(TimeZone self, Instant instant)
Converts this TimeZone to a correspondingZoneOffset. The offset is determined using the date/time of specified Instant.- Parameters:
self- a TimeZone- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
-