Class DateTimeExtensions
-
Method Summary
Modifier and TypeMethodDescriptionstatic LocalDateTime
clearTime
(LocalDateTime self) Returns aLocalDateTime
with the time portion cleared.static OffsetDateTime
clearTime
(OffsetDateTime self) Returns anOffsetDateTime
with the time portion cleared.static ZonedDateTime
clearTime
(ZonedDateTime self) Returns anZonedDateTime
with the time portion cleared.static Duration
Supports the division operator; equivalent to calling theDuration.dividedBy(long)
method.static void
Iterates from this to theto
Temporal
, inclusive, decrementing by one unit each iteration, calling the closure once per iteration.static void
downto
(Temporal from, Temporal to, TemporalUnit unit, Closure closure) Iterates from this to theto
Temporal
, inclusive, decrementing by oneunit
each iteration, calling the closure once per iteration.static String
Formats this date with the providedDateTimeFormatter
pattern.static String
format
(LocalDate self, FormatStyle dateStyle) Formats this date in the provided, localizedFormatStyle
.static String
format
(LocalDateTime self, String pattern) Formats this date/time with the providedDateTimeFormatter
pattern.static String
format
(LocalDateTime self, FormatStyle dateTimeStyle) Formats this date/time in the provided, localizedFormatStyle
.static String
Formats this time with the providedDateTimeFormatter
pattern.static String
format
(LocalTime self, FormatStyle timeStyle) Formats this time in the provided, localizedFormatStyle
.static String
format
(OffsetDateTime self, String pattern) Formats this date/time with the providedDateTimeFormatter
pattern.static String
format
(OffsetDateTime self, FormatStyle dateTimeStyle) Formats this date/time in the provided, localizedFormatStyle
.static String
format
(OffsetTime self, String pattern) Formats this time with the providedDateTimeFormatter
pattern.static String
format
(OffsetTime self, FormatStyle timeStyle) Formats this time in the provided, localizedFormatStyle
.static String
format
(ZonedDateTime self, String pattern) Formats this date/time with the providedDateTimeFormatter
pattern.static String
format
(ZonedDateTime self, FormatStyle dateTimeStyle) Formats this date/time in the provided, localizedFormatStyle
.getAt
(TemporalAccessor self, Iterable<TemporalField> fields) Supports the getAt operator for an iterable; equivalent to collecting theTemporalAccessor.getLong(java.time.temporal.TemporalField)
method for each field in the supplied iterable.static long
getAt
(TemporalAccessor self, TemporalField field) Supports the getAt operator; equivalent to calling theTemporalAccessor.getLong(java.time.temporal.TemporalField)
method.static long
getAt
(TemporalAmount self, TemporalUnit unit) Supports the getAt operator; equivalent to calling theTemporalAmount.get(TemporalUnit)
method.static long
getAt
(ZoneOffset self, TemporalField field) Supports the getAt operator; equivalent to calling theZoneOffset.getLong(java.time.temporal.TemporalField)
method.static String
getDateString
(LocalDate self) Formats this date with theDateTimeFormatter.ISO_LOCAL_DATE
formatter.static String
getDateString
(LocalDateTime self) Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE
formatter.static String
getDateString
(OffsetDateTime self) Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE
formatter.static String
getDateString
(ZonedDateTime self) Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE
formatter and appends the zone's short name, e.g.static String
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIME
formatter.static String
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE_TIME
formatter.static String
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIME
formatter and appends the zone's short name, e.g.static int
Equivalent to calling theYear.get(java.time.temporal.TemporalField)
method with aChronoField.ERA
argument.static String
getFullName
(ZoneId self) Returns the name of this zone formatted according to theTextStyle.FULL
text style.static String
getFullName
(ZoneId self, Locale locale) Returns the name of this zone formatted according to theTextStyle.FULL
text style for the providedLocale
.static int
getHours
(ZoneOffset self) Returns the hours component of this offset.static int
getMinutes
(ZoneOffset self) Returns the minutes component of this offset.static ZoneOffset
Returns aZoneOffset
for this zone as of now.static ZoneOffset
Returns aZoneOffset
for this zone as of the providedInstant
.static int
getSeconds
(ZoneOffset self) Returns the seconds component of this offset.static String
getShortName
(ZoneId self) Returns the name of this zone formatted according to theTextStyle.SHORT
text style.static String
getShortName
(ZoneId self, Locale locale) Returns the name of this zone formatted according to theTextStyle.SHORT
text style for the providedLocale
.static String
getTimeString
(LocalDateTime self) Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter.static String
getTimeString
(LocalTime self) Formats this time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter.static String
getTimeString
(OffsetDateTime self) Formats this date/time with theDateTimeFormatter.ISO_OFFSET_TIME
formatter.static String
getTimeString
(OffsetTime self) Formats this time with theDateTimeFormatter.ISO_OFFSET_TIME
formatter.static String
getTimeString
(ZonedDateTime self) Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter and appends the zone's short name, e.g.static int
getYearOfEra
(Year self) Equivalent to calling theYear.get(java.time.temporal.TemporalField)
method with aChronoField.YEAR_OF_ERA
argument.static ZoneId
Returns the Time Zone of the Calendar as a java.time.ZoneId.static ZoneId
Returns the Time Zone of the Date as aZoneId
.static ZoneOffset
getZoneOffset
(Calendar self) Returns the Time Zone offset of the Calendar as aZoneOffset
.static ZoneOffset
getZoneOffset
(Date self) Returns the Time Zone offset of the Date as aZoneOffset
, which will typically be system's default offset.static boolean
isNonnegative
(ChronoPeriod self) Returns true if this period is zero or positive.static boolean
isNonnegative
(Duration self) Returns true if this duration is zero or positive.static boolean
isNonpositive
(ChronoPeriod self) Returns true if this period is zero or negative.static boolean
isNonpositive
(Duration self) Returns true if this duration is zero or negative.static boolean
isPositive
(ChronoPeriod self) Returns true if this period is positive, excluding zero.static boolean
isPositive
(Duration self) Returns true if this duration is positive, excluding zero.static boolean
Returnstrue
if the DayOfWeek is a weekday.static boolean
Returnstrue
if this day of the week is a weekend day (Saturday or Sunday).static LocalDateTime
Returns aLocalDateTime
from this date and the providedLocalTime
.static OffsetDateTime
leftShift
(LocalDate self, OffsetTime time) Returns aOffsetDateTime
from this date and the providedOffsetTime
.static ZonedDateTime
leftShift
(LocalDateTime self, ZoneId zone) Returns aOffsetDateTime
of this date/time and the providedZoneId
.static OffsetDateTime
leftShift
(LocalDateTime self, ZoneOffset offset) Returns anOffsetDateTime
of this date/time and the providedZoneOffset
.static LocalDateTime
Returns aLocalDateTime
of this time and the providedLocalDate
.static OffsetTime
leftShift
(LocalTime self, ZoneOffset offset) Returns anOffsetTime
of this time and the providedZoneOffset
.static LocalDate
Returns aLocalDate
of this month/day and the provided year.static LocalDate
static MonthDay
Creates aMonthDay
at the provided day of the month.static YearMonth
static OffsetDateTime
leftShift
(OffsetTime self, LocalDate date) Returns anOffsetDateTime
of this time and the providedLocalDate
.static LocalDate
Returns aLocalDate
of this year/month and the given day of the month.static YearMonth
static LocalDate
static ZonedDateTime
leftShift
(ZoneId self, LocalDateTime dateTime) Returns aZonedDateTime
of this zone and the givenLocalDateTime
.static OffsetDateTime
leftShift
(ZoneOffset self, LocalDateTime dateTime) Returns anOffsetDateTime
of this offset and the providedLocalDateTime
.static OffsetTime
leftShift
(ZoneOffset self, LocalTime time) Returns anOffsetDateTime
of this offset and the providedLocalTime
.static DayOfWeek
Returns theDayOfWeek
that isdays
many days before this day of the week.static Duration
Returns aDuration
that isseconds
seconds shorter that this duration.static Instant
Returns anInstant
that isseconds
seconds before this instant.static LocalDate
Returns aLocalDate
that isdays
days before this date.static long
Calculates the number of days between two datesstatic LocalDateTime
minus
(LocalDateTime self, long seconds) Returns aLocalDateTime
that isseconds
seconds before this date/time.static LocalTime
Returns aLocalTime
that isseconds
seconds before this time.static Month
Returns theMonth
that ismonths
months before this month.static OffsetDateTime
minus
(OffsetDateTime self, long seconds) Returns anOffsetDateTime
that isseconds
seconds before this date/time.static OffsetTime
minus
(OffsetTime self, long seconds) Returns anOffsetTime
that isseconds
seconds before this time.static Period
Returns aPeriod
that isdays
days shorter than this period.static YearMonth
Returns aYearMonth
that ismonths
months before this year/month.static Year
Returns aYear
that isyears
years before this year.static ZonedDateTime
minus
(ZonedDateTime self, long seconds) Returns aZonedDateTime
that isseconds
seconds before this date/time.static Duration
Supports the multiplication operator; equivalent to calling theDuration.multipliedBy(long)
method.static Period
Supports the multiply operator; equivalent to calling thePeriod.multipliedBy(int)
method.static Duration
Supports the unary minus operator; equivalent to calling theDuration.negated()
method.static Period
Supports the unary minus operator; equivalent to calling thePeriod.negated()
method.static Duration
Returns aDuration
that is one second longer than this duration.static Instant
Returns anInstant
that is one second after this instant.static LocalDate
Returns aLocalDate
one day after this date.static LocalDateTime
next
(LocalDateTime self) Returns aLocalDateTime
that is one second after this date/time.static LocalTime
Returns aLocalTime
that is one second after this time.static OffsetDateTime
next
(OffsetDateTime self) Returns anOffsetDateTime
one second after this date/time.static OffsetTime
next
(OffsetTime self) Returns anOffsetTime
that is one second after this time.static Period
Returns aPeriod
that is one day longer than this period.static Year
Returns aYear
after this year.static YearMonth
Returns aYearMonth
that is the month after this year/month.static ZonedDateTime
next
(ZonedDateTime self) Returns aZonedDateTime
that is one second after this date/time.static DayOfWeek
Returns theDayOfWeek
that isdays
many days after this day of the week.static Duration
Returns aDuration
that isseconds
seconds longer than this duration.static Instant
Returns anInstant
that isseconds
seconds after this instant.static LocalDate
Returns aLocalDate
that isdays
days after this date.static LocalDateTime
plus
(LocalDateTime self, long seconds) Returns aLocalDateTime
that isseconds
seconds after this date/time.static LocalTime
Returns aLocalTime
that isseconds
seconds after this time.static Month
Returns theMonth
that ismonths
months after this month.static OffsetDateTime
plus
(OffsetDateTime self, long seconds) Returns anOffsetDateTime
that isseconds
seconds after this date/time.static OffsetTime
plus
(OffsetTime self, long seconds) Returns anOffsetTime
that isseconds
seconds after this time.static Period
Returns aPeriod
that isdays
days longer than this period.static YearMonth
Returns aYearMonth
that ismonths
months after this year/month.static Year
Returns aYear
that isyears
years after this year.static ZonedDateTime
plus
(ZonedDateTime self, long seconds) Returns aZonedDateTime
that isseconds
seconds after this date/time.static Duration
Supports the unary plus operator; equivalent to calling theDuration.abs()
method.static Period
Supports the unary plus operator; returns aPeriod
with all unit values positive.static Duration
Returns aDuration
that is one second shorter than this duration.static Instant
Returns anInstant
that one second before this instant.static LocalDate
Returns aLocalDate
one day before this date.static LocalDateTime
previous
(LocalDateTime self) Returns aLocalDateTime
that is one second before this date/time.static LocalTime
Returns aLocalTime
that is one second before this time.static OffsetDateTime
previous
(OffsetDateTime self) Returns anOffsetDateTime
one second before this date/time.static OffsetTime
previous
(OffsetTime self) Returns anOffsetTime
that is one second before this time.static Period
Returns aPeriod
that is one day shorter than this period.static Year
Returns aYear
before this year.static YearMonth
Returns aYearMonth
that is the month before this year/month.static ZonedDateTime
previous
(ZonedDateTime self) Returns aZonedDateTime
that is one second before this date/time.static Period
rightShift
(LocalDate self, LocalDate other) static TemporalAmount
rightShift
(Temporal self, Temporal other) static Period
rightShift
(YearMonth self, YearMonth other) static Period
rightShift
(Year self, Year year) static Calendar
toCalendar
(Instant self) Returns a generally equivalentCalendar
in the GMT time zone, truncated to milliseconds.static Calendar
toCalendar
(LocalDate self) Returns an equivalent instance ofCalendar
.static Calendar
toCalendar
(LocalDateTime self) Returns a generally equivalent instance ofCalendar
.static Calendar
toCalendar
(LocalTime self) Returns a generally equivalent instance ofCalendar
.static Calendar
toCalendar
(OffsetDateTime self) Returns a generally equivalent instance ofCalendar
.static Calendar
toCalendar
(OffsetTime self) Returns a generally equivalent instance ofCalendar
.static Calendar
toCalendar
(ZonedDateTime self) Returns a generally equivalent instance ofCalendar
.static Date
Returns a generally equivalentDate
according the number of milliseconds since the epoch, adjusted into the system default time zone.static Date
Returns an equivalent instance ofDate
.static Date
toDate
(LocalDateTime self) Returns a generally equivalent instance ofDate
.static Date
Returns a generally equivalent instance ofDate
.static Date
toDate
(OffsetDateTime self) Returns a generally equivalent instance ofDate
.static Date
toDate
(OffsetTime self) Returns a generally equivalent instance ofDate
.static Date
toDate
(ZonedDateTime self) Returns a generally equivalent instance ofDate
.static DayOfWeek
toDayOfWeek
(Calendar self) Converts the Calendar to a correspondingDayOfWeek
.static DayOfWeek
toDayOfWeek
(Date self) Converts the Date to a correspondingDayOfWeek
.static Instant
Convenience method for converting a Calendar to a correspondingInstant
.static LocalDate
toLocalDate
(Date self) Converts the Date to a correspondingLocalDate
.static LocalDateTime
toLocalDateTime
(Calendar self) Converts the Calendar to a correspondingLocalDateTime
.static LocalDateTime
toLocalDateTime
(Date self) Converts the Date to a correspondingLocalDateTime
.static LocalTime
toLocalTime
(Calendar self) Converts the Calendar to a correspondingLocalTime
.static LocalTime
toLocalTime
(Date self) Converts the Date to a correspondingLocalTime
.static Month
Converts the Calendar to a correspondingMonth
.static Month
Converts the Date to a correspondingMonth
.static MonthDay
toMonthDay
(Calendar self) Converts the Calendar to a correspondingMonthDay
.static MonthDay
toMonthDay
(Date self) Converts the Date to a correspondingMonthDay
.static OffsetDateTime
toOffsetDateTime
(Calendar self) Converts the Calendar to a correspondingOffsetDateTime
.static OffsetDateTime
toOffsetDateTime
(Date self) Converts the Date to a correspondingOffsetDateTime
.static OffsetTime
toOffsetTime
(Calendar self) Converts the Calendar to a correspondingOffsetTime
.static OffsetTime
toOffsetTime
(Date self) Converts the Date to a correspondingOffsetTime
.static TimeZone
toTimeZone
(ZoneId self) Returns aTimeZone
equivalent to this zone.static TimeZone
toTimeZone
(ZoneOffset self) Returns a generally equivalentTimeZone
.static Year
Converts the Calendar to a correspondingYear
.static Year
Converts the Date to a correspondingYear
.static YearMonth
toYearMonth
(Calendar self) Converts the Calendar to a correspondingYearMonth
.static YearMonth
toYearMonth
(Date self) Converts the Date to a correspondingYearMonth
.static ZonedDateTime
toZonedDateTime
(Calendar self) Converts the Calendar to a correspondingZonedDateTime
.static ZonedDateTime
toZonedDateTime
(Date self) Converts the Date to a correspondingZonedDateTime
.static ZoneOffset
toZoneOffset
(TimeZone self) Converts the TimeZone to a correspondingZoneOffset
.static ZoneOffset
toZoneOffset
(TimeZone self, Instant instant) Converts this TimeZone to a correspondingZoneOffset
.static void
Iterates from this to theto
Temporal
, inclusive, incrementing by one unit each iteration, calling the closure once per iteration.static void
upto
(Temporal from, Temporal to, TemporalUnit unit, Closure closure) Iterates from this to theto
Temporal
, inclusive, incrementing by oneunit
each iteration, calling the closure once per iteration.
-
Method Details
-
upto
Iterates from this to theto
Temporal
, inclusive, incrementing by one unit each iteration, calling the closure once per iteration. The closure may accept a singleTemporal
argument.The particular unit incremented by depends on the specific subtype of
Temporal
. Most subtypes use a unit ofChronoUnit.SECONDS
except forChronoLocalDate
and its sub-types useChronoUnit.DAYS
.YearMonth
usesChronoUnit.MONTHS
.Year
usesChronoUnit.YEARS
.
- Parameters:
from
- the starting Temporalto
- the ending Temporalclosure
- the zero or one-argument closure to call- Throws:
GroovyRuntimeException
- if this value is later thanto
GroovyRuntimeException
- ifto
is a different type than this- Since:
- 2.5.0
-
upto
Iterates from this to theto
Temporal
, inclusive, incrementing by oneunit
each iteration, calling the closure once per iteration. The closure may accept a singleTemporal
argument.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.DAYS
as 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 theto
value.- 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 thanto
GroovyRuntimeException
- ifto
is a different type than this- Since:
- 2.5.0
-
downto
Iterates from this to theto
Temporal
, inclusive, decrementing by one unit each iteration, calling the closure once per iteration. The closure may accept a singleTemporal
argument.The particular unit decremented by depends on the specific subtype of
Temporal
. Most subtypes use a unit ofChronoUnit.SECONDS
except forChronoLocalDate
and its sub-types useChronoUnit.DAYS
.YearMonth
usesChronoUnit.MONTHS
.Year
usesChronoUnit.YEARS
.
- Parameters:
from
- the starting Temporalto
- the ending Temporalclosure
- the zero or one-argument closure to call- Throws:
GroovyRuntimeException
- if this value is earlier thanto
GroovyRuntimeException
- ifto
is a different type than this- Since:
- 2.5.0
-
downto
Iterates from this to theto
Temporal
, inclusive, decrementing by oneunit
each iteration, calling the closure once per iteration. The closure may accept a singleTemporal
argument.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.DAYS
as 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 theto
value.- 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 thanto
GroovyRuntimeException
- ifto
is a different type than this- Since:
- 2.5.0
-
rightShift
Returns aDuration
orPeriod
between this (inclusive) and theother
Temporal
(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 generalChronoPeriod
will 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
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
Supports the getAt operator for an iterable; equivalent to collecting theTemporalAccessor.getLong(java.time.temporal.TemporalField)
method for each field in the supplied iterable.import static java.time.temporal.ChronoField.* import java.time.LocalTime def breakfast = LocalTime.of(8, 30, 0) def (h, m, s) = breakfast[HOUR_OF_DAY, MINUTE_OF_HOUR, SECOND_OF_MINUTE] assert "$h:$m:$s" == "8:30:0"
- Parameters:
self
- a TemporalAccessorfields
- an iterable of non-null TemporalField values- Returns:
- the list of values for the fields
- Throws:
DateTimeException
- if a value for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurs- Since:
- 4.0.6
-
getAt
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
Returns aDuration
that isseconds
seconds longer than this duration.- Parameters:
self
- a Durationseconds
- the number of seconds to add- Returns:
- a Duration
- Since:
- 2.5.0
-
minus
Returns aDuration
that isseconds
seconds shorter that this duration.- Parameters:
self
- a Durationseconds
- the number of seconds to subtract- Returns:
- a Duration
- Since:
- 2.5.0
-
next
Returns aDuration
that is one second longer than this duration.- Parameters:
self
- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
previous
Returns aDuration
that is one second shorter than this duration.- Parameters:
self
- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
negative
Supports the unary minus operator; equivalent to calling theDuration.negated()
method.- Parameters:
self
- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
positive
Supports the unary plus operator; equivalent to calling theDuration.abs()
method.- Parameters:
self
- a Duration- Returns:
- a Duration
- Since:
- 2.5.0
-
multiply
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
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
Returns true if this duration is positive, excluding zero.- Parameters:
self
- a Duration- Returns:
- true if positive
- Since:
- 2.5.0
-
isNonnegative
Returns true if this duration is zero or positive.- Parameters:
self
- a Duration- Returns:
- true if nonnegative
- Since:
- 2.5.0
-
isNonpositive
Returns true if this duration is zero or negative.- Parameters:
self
- a Duration- Returns:
- true if nonpositive
- Since:
- 2.5.0
-
plus
Returns anInstant
that isseconds
seconds after this instant.- Parameters:
self
- an Instantseconds
- the number of seconds to add- Returns:
- an Instant
- Since:
- 2.5.0
-
minus
Returns anInstant
that isseconds
seconds before this instant.- Parameters:
self
- an Instantseconds
- the number of seconds to subtract- Returns:
- an Instant
- Since:
- 2.5.0
-
next
Returns anInstant
that is one second after this instant.- Parameters:
self
- an Instant- Returns:
- an Instant one-second ahead
- Since:
- 2.5.0
-
previous
Returns anInstant
that one second before this instant.- Parameters:
self
- an Instant- Returns:
- an Instant one-second behind
- Since:
- 2.5.0
-
toDate
Returns a generally equivalentDate
according 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
Returns a generally equivalentCalendar
in the GMT time zone, truncated to milliseconds.- Parameters:
self
- an Instant- Returns:
- a Calendar
- Since:
- 2.5.0
-
format
Formats this date with the providedDateTimeFormatter
pattern.- Parameters:
self
- a LocalDatepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this date in the provided, localizedFormatStyle
.- Parameters:
self
- a LocalDatedateStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateString
Formats this date with theDateTimeFormatter.ISO_LOCAL_DATE
formatter.- Parameters:
self
- a LocalDate- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
plus
Returns aLocalDate
that isdays
days after this date.- Parameters:
self
- a LocalDatedays
- the number of days to add- Returns:
- a LocalDate
- Since:
- 2.5.0
-
minus
Returns aLocalDate
that isdays
days before this date.- Parameters:
self
- a LocalDatedays
- the number of days to subtract- Returns:
- a LocalDate
- Since:
- 2.5.0
-
minus
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
Returns aLocalDate
one day after this date.- Parameters:
self
- a LocalDate- Returns:
- the next day
- Since:
- 2.5.0
-
previous
Returns aLocalDate
one day before this date.- Parameters:
self
- a LocalDate- Returns:
- the previous day
- Since:
- 2.5.0
-
rightShift
Returns aPeriod
equivalent 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
Returns aLocalDateTime
from this date and the providedLocalTime
.- Parameters:
self
- a LocalDatetime
- a LocalTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
Returns aOffsetDateTime
from this date and the providedOffsetTime
.- Parameters:
self
- a LocalDatetime
- an OffsetTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
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
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
Formats this date/time with the providedDateTimeFormatter
pattern.- Parameters:
self
- a LocalDateTimepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this date/time in the provided, localizedFormatStyle
.- Parameters:
self
- a LocalDateTimedateTimeStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateTimeString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIME
formatter.- Parameters:
self
- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE
formatter.- Parameters:
self
- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getTimeString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter.- Parameters:
self
- a LocalDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
clearTime
Returns aLocalDateTime
with the time portion cleared.- Parameters:
self
- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
plus
Returns aLocalDateTime
that isseconds
seconds after this date/time.- Parameters:
self
- a LocalDateTimeseconds
- the number of seconds to add- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
minus
Returns aLocalDateTime
that isseconds
seconds before this date/time.- Parameters:
self
- a LocalDateTimeseconds
- the number of seconds to subtract- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
next
Returns aLocalDateTime
that is one second after this date/time.- Parameters:
self
- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
previous
Returns aLocalDateTime
that is one second before this date/time.- Parameters:
self
- a LocalDateTime- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
Returns anOffsetDateTime
of this date/time and the providedZoneOffset
.- Parameters:
self
- a LocalDateTimeoffset
- a ZoneOffset- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
leftShift
Returns aOffsetDateTime
of this date/time and the providedZoneId
.- Parameters:
self
- a LocalDateTimezone
- a ZoneId- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toDate
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
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
Formats this time with the providedDateTimeFormatter
pattern.- Parameters:
self
- a LocalDateTimepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this time in the provided, localizedFormatStyle
.- Parameters:
self
- a LocalTimetimeStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getTimeString
Formats this time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter.- Parameters:
self
- a LocalTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
plus
Returns aLocalTime
that isseconds
seconds after this time.- Parameters:
self
- a LocalTimeseconds
- the number of seconds to add- Returns:
- a LocalTime
- Since:
- 2.5.0
-
minus
Returns aLocalTime
that isseconds
seconds before this time.- Parameters:
self
- a LocalTimeseconds
- the number of seconds to subtract- Returns:
- a LocalTime
- Since:
- 2.5.0
-
next
Returns aLocalTime
that is one second after this time.- Parameters:
self
- a LocalTime- Returns:
- a LocalTime
- Since:
- 2.5.0
-
previous
Returns aLocalTime
that is one second before this time.- Parameters:
self
- a LocalTime- Returns:
- a LocalTime
- Since:
- 2.5.0
-
leftShift
Returns aLocalDateTime
of this time and the providedLocalDate
.- Parameters:
self
- a LocalTimedate
- a LocalDate- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
leftShift
Returns anOffsetTime
of this time and the providedZoneOffset
.- Parameters:
self
- a LocalTimeoffset
- a ZoneOffset- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toDate
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
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
Returns aLocalDate
of this month/day and the provided year.- Parameters:
self
- a MonthDayyear
- a year- Returns:
- a LocalDate
- Since:
- 2.5.0
-
leftShift
- Parameters:
self
- a MonthDayyear
- a Year- Returns:
- a LocalDate
- Since:
- 2.5.0
-
format
Formats this date/time with the providedDateTimeFormatter
pattern.- Parameters:
self
- an OffsetDateTimepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this date/time in the provided, localizedFormatStyle
.- Parameters:
self
- an OffsetDateTimedateTimeStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateTimeString
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE_TIME
formatter.- Parameters:
self
- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateString
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_DATE
formatter.- Parameters:
self
- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getTimeString
Formats this date/time with theDateTimeFormatter.ISO_OFFSET_TIME
formatter.- Parameters:
self
- an OffsetDateTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
clearTime
Returns anOffsetDateTime
with the time portion cleared.- Parameters:
self
- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
plus
Returns anOffsetDateTime
that isseconds
seconds after this date/time.- Parameters:
self
- an OffsetDateTimeseconds
- the number of seconds to add- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
minus
Returns anOffsetDateTime
that isseconds
seconds before this date/time.- Parameters:
self
- an OffsetDateTimeseconds
- the number of seconds to subtract- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
next
Returns anOffsetDateTime
one second after this date/time.- Parameters:
self
- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
previous
Returns anOffsetDateTime
one second before this date/time.- Parameters:
self
- an OffsetDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
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
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
Formats this time with the providedDateTimeFormatter
pattern.- Parameters:
self
- an OffsetTimepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this time in the provided, localizedFormatStyle
.- Parameters:
self
- an OffsetTimetimeStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getTimeString
Formats this time with theDateTimeFormatter.ISO_OFFSET_TIME
formatter.- Parameters:
self
- an OffsetTime- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
plus
Returns anOffsetTime
that isseconds
seconds after this time.- Parameters:
self
- an OffsetTimeseconds
- the number of seconds to add- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
minus
Returns anOffsetTime
that isseconds
seconds before this time.- Parameters:
self
- an OffsetTimeseconds
- the number of seconds to subtract- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
next
Returns anOffsetTime
that is one second after this time.- Parameters:
self
- an OffsetTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
previous
Returns anOffsetTime
that is one second before this time.- Parameters:
self
- an OffsetTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
leftShift
Returns anOffsetDateTime
of this time and the providedLocalDate
.- Parameters:
self
- an OffsetTimedate
- a LocalDate- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toDate
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
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
Returns aPeriod
that isdays
days 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
Returns aPeriod
that isdays
days 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
Returns aPeriod
that 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
Returns aPeriod
that 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
Supports the unary minus operator; equivalent to calling thePeriod.negated()
method.- Parameters:
self
- a Period- Returns:
- a negated Period
- Since:
- 2.5.0
-
positive
Supports the unary plus operator; returns aPeriod
with 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
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
Returns true if this period is positive, excluding zero.- Parameters:
self
- a ChronoPeriod- Returns:
- true if positive
- Since:
- 2.5.0
-
isNonnegative
Returns true if this period is zero or positive.- Parameters:
self
- a ChronoPeriod- Returns:
- true if nonnegative
- Since:
- 2.5.0
-
isNonpositive
Returns true if this period is zero or negative.- Parameters:
self
- a ChronoPeriod- Returns:
- true if nonpositive
- Since:
- 2.5.0
-
plus
Returns aYear
that isyears
years after this year.- Parameters:
self
- a Yearyears
- the number of years to add- Returns:
- a Year
- Since:
- 2.5.0
-
minus
Returns aYear
that isyears
years before this year.- Parameters:
self
- a Yearyears
- the number of years to subtract- Returns:
- a Year
- Since:
- 2.5.0
-
next
Returns aYear
after this year.- Parameters:
self
- a Year- Returns:
- the next Year
- Since:
- 2.5.0
-
previous
Returns aYear
before this year.- Parameters:
self
- a Year- Returns:
- the previous Year
- Since:
- 2.5.0
-
rightShift
Returns aPeriod
between 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
- Parameters:
self
- a Yearmonth
- a Month- Returns:
- a YearMonth
- Since:
- 2.5.0
-
leftShift
- Parameters:
self
- a YearmonthDay
- a MonthDay- Returns:
- a LocalDate
- Since:
- 2.5.0
-
getEra
Equivalent to calling theYear.get(java.time.temporal.TemporalField)
method with aChronoField.ERA
argument.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
Equivalent to calling theYear.get(java.time.temporal.TemporalField)
method with aChronoField.YEAR_OF_ERA
argument.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
Returns aYearMonth
that ismonths
months after this year/month.- Parameters:
self
- a YearMonthmonths
- the number of months to add- Returns:
- a Year
- Since:
- 2.5.0
-
minus
Returns aYearMonth
that ismonths
months before this year/month.- Parameters:
self
- a YearMonthmonths
- the number of months to subtract- Returns:
- a Year
- Since:
- 2.5.0
-
next
Returns aYearMonth
that is the month after this year/month.- Parameters:
self
- a YearMonth- Returns:
- the next YearMonth
- Since:
- 2.5.0
-
previous
Returns aYearMonth
that is the month before this year/month.- Parameters:
self
- a YearMonth- Returns:
- the previous YearMonth
- Since:
- 2.5.0
-
leftShift
Returns aLocalDate
of 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
Returns aPeriod
of 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
Formats this date/time with the providedDateTimeFormatter
pattern.- Parameters:
self
- a ZonedDateTimepattern
- the formatting pattern- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
format
Formats this date/time in the provided, localizedFormatStyle
.- Parameters:
self
- a ZonedDateTimedateTimeStyle
- the FormatStyle- Returns:
- a formatted String
- Since:
- 2.5.0
- See Also:
-
getDateTimeString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE_TIME
formatter 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:
-
getDateString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_DATE
formatter 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:
-
getTimeString
Formats this date/time with theDateTimeFormatter.ISO_LOCAL_TIME
formatter 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:
-
clearTime
Returns anZonedDateTime
with the time portion cleared.- Parameters:
self
- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
plus
Returns aZonedDateTime
that isseconds
seconds after this date/time.- Parameters:
self
- an ZonedDateTimeseconds
- the number of seconds to add- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
minus
Returns aZonedDateTime
that isseconds
seconds before this date/time.- Parameters:
self
- a ZonedDateTimeseconds
- the number of seconds to subtract- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
next
Returns aZonedDateTime
that is one second after this date/time.- Parameters:
self
- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
previous
Returns aZonedDateTime
that is one second before this date/time.- Parameters:
self
- a ZonedDateTime- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toDate
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
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
Returns aTimeZone
equivalent to this zone.- Parameters:
self
- a ZoneId- Returns:
- a TimeZone
- Since:
- 2.5.0
-
getFullName
Returns the name of this zone formatted according to theTextStyle.FULL
text style.- Parameters:
self
- a ZoneId- Returns:
- the full display name of the ZoneId
- Since:
- 2.5.0
-
getFullName
Returns the name of this zone formatted according to theTextStyle.FULL
text style for the providedLocale
.- Parameters:
self
- a ZoneIdlocale
- a Locale- Returns:
- the full display name of the ZoneId
- Since:
- 2.5.0
-
getShortName
Returns the name of this zone formatted according to theTextStyle.SHORT
text style.- Parameters:
self
- a ZoneId- Returns:
- the short display name of the ZoneId
- Since:
- 2.5.0
-
getShortName
Returns the name of this zone formatted according to theTextStyle.SHORT
text style for the providedLocale
.- Parameters:
self
- a ZoneIdlocale
- a Locale- Returns:
- the short display name of the ZoneId
- Since:
- 2.5.0
-
getOffset
Returns aZoneOffset
for this zone as of now.- Parameters:
self
- a ZoneId- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
getOffset
Returns aZoneOffset
for this zone as of the providedInstant
.- Parameters:
self
- a ZoneIdinstant
- an Instant- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
leftShift
Returns aZonedDateTime
of this zone and the givenLocalDateTime
.- Parameters:
self
- a ZoneId- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toTimeZone
Returns a generally equivalentTimeZone
. The offset will be truncated to minutes.- Parameters:
self
- a ZoneOffset- Returns:
- a TimeZone
- Since:
- 2.5.0
-
getHours
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
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
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 == 61
If 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
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
Returns anOffsetDateTime
of this offset and the providedLocalDateTime
.- Parameters:
self
- a ZoneOffsetdateTime
- a LocalDateTime- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
leftShift
Returns anOffsetDateTime
of this offset and the providedLocalTime
.- Parameters:
self
- a ZoneOffsettime
- a LocalTime- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
plus
Returns theDayOfWeek
that isdays
many 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
Returns theDayOfWeek
that isdays
many 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
Returnstrue
if 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
Returnstrue
if the DayOfWeek is a weekday.- Returns:
- true if this DayOfWeek is Monday through Friday
- Since:
- 2.5.0
-
plus
Returns theMonth
that ismonths
months after this month.- Parameters:
self
- a Monthmonths
- the number of months move forward- Returns:
- the Month
- Since:
- 2.5.0
-
minus
Returns theMonth
that ismonths
months before this month.- Parameters:
self
- a Monthmonths
- the number of months to move back- Returns:
- the Month
- Since:
- 2.5.0
-
leftShift
Creates aMonthDay
at the provided day of the month.- Parameters:
self
- a MonthdayOfMonth
- a day of the month- Returns:
- a MonthDay
- Since:
- 2.5.0
-
leftShift
- Parameters:
self
- a Monthyear
- a Year- Returns:
- a YearMonth
- Since:
- 2.5.0
-
getZoneOffset
Returns the Time Zone offset of the Calendar as aZoneOffset
.- Parameters:
self
- a Calendar- Returns:
- a ZoneOffset
- Since:
- 2.5.0
-
getZoneOffset
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
Returns the Time Zone of the Calendar as a java.time.ZoneId.- Parameters:
self
- a Calendar- Returns:
- a ZoneId
- Since:
- 2.5.0
-
getZoneId
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
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
Converts the Date to a correspondingYear
.- Parameters:
self
- a Date- Returns:
- a Year
- Since:
- 2.5.0
-
toMonth
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
Converts the Date to a correspondingMonth
.- Parameters:
self
- a Date- Returns:
- a Month
- Since:
- 2.5.0
-
toMonthDay
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
Converts the Date to a correspondingMonthDay
.- Parameters:
self
- a Date- Returns:
- a MonthDay
- Since:
- 2.5.0
-
toYearMonth
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
Converts the Date to a correspondingYearMonth
.- Parameters:
self
- a Date- Returns:
- a YearMonth
- Since:
- 2.5.0
-
toDayOfWeek
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
Converts the Date to a correspondingDayOfWeek
.- Parameters:
self
- a Date- Returns:
- a DayOfWeek
- Since:
- 2.5.0
-
toLocalDate
Converts the Date to a correspondingLocalDate
.- Parameters:
self
- a Date- Returns:
- a LocalDate
- Since:
- 2.5.0
-
toLocalTime
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
Converts the Date to a correspondingLocalTime
.- Parameters:
self
- a Date- Returns:
- a LocalTime
- Since:
- 2.5.0
-
toLocalDateTime
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
Converts the Date to a correspondingLocalDateTime
.- Parameters:
self
- a Date- Returns:
- a LocalDateTime
- Since:
- 2.5.0
-
toZonedDateTime
Converts the Calendar to a corresponding
ZonedDateTime
.Note that
GregorianCalendar
has 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
Converts the Date to a correspondingZonedDateTime
.- Parameters:
self
- a Date- Returns:
- a ZonedDateTime
- Since:
- 2.5.0
-
toOffsetDateTime
Converts the Calendar to a correspondingOffsetDateTime
.- Parameters:
self
- a Calendar- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toOffsetDateTime
Converts the Date to a correspondingOffsetDateTime
.- Parameters:
self
- a Date- Returns:
- an OffsetDateTime
- Since:
- 2.5.0
-
toOffsetTime
Converts the Calendar to a correspondingOffsetTime
.- Parameters:
self
- a Calendar- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toOffsetTime
Converts the Date to a correspondingOffsetTime
.- Parameters:
self
- a Date- Returns:
- an OffsetTime
- Since:
- 2.5.0
-
toInstant
Convenience method for converting a Calendar to a correspondingInstant
.- Parameters:
self
- a Calendar- Returns:
- an Instant
- Since:
- 2.5.0
-
toZoneOffset
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
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
-