Index (groovy-datetime 2.5.13 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

B

between(Period, YearMonth, YearMonth) - Method in DateTimeStaticExtensions: Obtains a Period consisting of the number of years and months between two YearMonth instances.

C

clearTime(ZonedDateTime) - Method in DateTimeExtensions: Returns an ZonedDateTime with the time portion cleared.

D

DateTimeExtensions - Class in org.apache.groovy.datetime.extensions: This class defines new Groovy methods which appear on normal JDK Date/Time API (java.time) classes inside the Groovy environment.
DateTimeStaticExtensions - Class in org.apache.groovy.datetime.extensions: This class defines new static extension methods which appear on normal JDK Date/Time API (java.time) classes inside the Groovy environment.
div(Duration, long) - Method in DateTimeExtensions: Supports the division operator; equivalent to calling the Duration.dividedBy method.
downto(Temporal, Temporal, TemporalUnit, Closure) - Method in DateTimeExtensions: Iterates from this to the to Temporal, inclusive, decrementing by one unit each iteration, calling the closure once per iteration.

E

F

format(ZonedDateTime, FormatStyle) - Method in DateTimeExtensions: Formats this date/time in the provided, localized FormatStyle.

G

getAt(ZoneOffset, TemporalField) - Method in DateTimeExtensions: Supports the getAt operator; equivalent to calling the ZoneOffset.getLong method.
getDateString(ZonedDateTime) - Method in DateTimeExtensions: Formats this date/time with the DateTimeFormatter.ISO_LOCAL_DATE formatter and appends the zone's short name, e.g.
getDateTimeString(ZonedDateTime) - Method in DateTimeExtensions: Formats this date/time with the DateTimeFormatter.ISO_LOCAL_DATE_TIME formatter and appends the zone's short name, e.g.
getEra(Year) - Method in DateTimeExtensions: Equivalent to calling the Year.get method with a ChronoField.ERA argument.
getFullName(ZoneId, Locale) - Method in DateTimeExtensions: Returns the name of this zone formatted according to the TextStyle.FULL text style for the provided Locale.
getHours(ZoneOffset) - Method in DateTimeExtensions: Returns the hours component of this offset.
getMinutes(ZoneOffset) - Method in DateTimeExtensions: Returns the minutes component of this offset.
getOffset(ZoneId, Instant) - Method in DateTimeExtensions: Returns a ZoneOffset for this zone as of the provided Instant.
getSeconds(ZoneOffset) - Method in DateTimeExtensions: Returns the seconds component of this offset.
getShortName(ZoneId, Locale) - Method in DateTimeExtensions: Returns the name of this zone formatted according to the TextStyle.SHORT text style for the provided Locale.
getTimeString(ZonedDateTime) - Method in DateTimeExtensions: Formats this date/time with the DateTimeFormatter.ISO_LOCAL_TIME formatter and appends the zone's short name, e.g.
getYearOfEra(Year) - Method in DateTimeExtensions: Equivalent to calling the Year.get method with a ChronoField.YEAR_OF_ERA argument.
getZoneId(Date) - Method in DateTimeExtensions: Returns the Time Zone of the Date as a ZoneId.
getZoneOffset(Date) - Method in DateTimeExtensions: Returns the Time Zone offset of the Date as a ZoneOffset, which will typically be system's default offset.

H

I

isNonnegative(ChronoPeriod) - Method in DateTimeExtensions: Returns true if this period is zero or positive.
isNonpositive(ChronoPeriod) - Method in DateTimeExtensions: Returns true if this period is zero or negative.
isPositive(ChronoPeriod) - Method in DateTimeExtensions: Returns true if this period is positive, excluding zero.
isWeekday(DayOfWeek) - Method in DateTimeExtensions: Returns true if the DayOfWeek is a weekday.
isWeekend(DayOfWeek) - Method in DateTimeExtensions: Returns true if this day of the week is a weekend day (Saturday or Sunday).

J

K

L

leftShift(Month, Year) - Method in DateTimeExtensions: Creates a YearMonth at the provided Year.

M

minus(Month, int) - Method in DateTimeExtensions: Returns the Month that is months months before this month.
multiply(Period, int) - Method in DateTimeExtensions: Supports the multiply operator; equivalent to calling the Period.multipliedBy method.

N

negative(Period) - Method in DateTimeExtensions: Supports the unary minus operator; equivalent to calling the Period.negated method.
next(ZonedDateTime) - Method in DateTimeExtensions: Returns a ZonedDateTime that is one second after this date/time.

O

P

parse(ZonedDateTime, CharSequence, String) - Method in DateTimeStaticExtensions: Parse text into a ZonedDateTime using the provided pattern.
plus(Month, int) - Method in DateTimeExtensions: Returns the Month that is months months after this month.
positive(Period) - Method in DateTimeExtensions: Supports the unary plus operator; returns a Period with all unit values positive.
previous(ZonedDateTime) - Method in DateTimeExtensions: Returns a ZonedDateTime that is one second before this date/time.

Q

R

rightShift(YearMonth, YearMonth) - Method in DateTimeExtensions: Returns a Period of time between the first day of this year/month (inclusive) and the given YearMonth (exclusive).

S

systemDefault(ZoneOffset) - Method in DateTimeStaticExtensions: Returns the ZoneOffset currently associated with the system default ZoneId.

T

toCalendar(ZonedDateTime) - Method in DateTimeExtensions: Returns a generally equivalent instance of Calendar.
toDate(ZonedDateTime) - Method in DateTimeExtensions: Returns a generally equivalent instance of Date.
toDayOfWeek(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding DayOfWeek.
toInstant(Calendar) - Method in DateTimeExtensions: Convenience method for converting a Calendar to a corresponding Instant.
toLocalDate(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding LocalDate.
toLocalDateTime(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding LocalDateTime.
toLocalTime(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding LocalTime.
toMonth(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding Month.
toMonthDay(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding MonthDay.
toOffsetDateTime(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding OffsetDateTime.
toOffsetTime(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding OffsetTime.
toTimeZone(ZoneOffset) - Method in DateTimeExtensions: Returns a generally equivalent TimeZone.
toYear(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding Year.
toYearMonth(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding YearMonth.
toZonedDateTime(Date) - Method in DateTimeExtensions: Converts the Date to a corresponding ZonedDateTime.
toZoneOffset(TimeZone, Instant) - Method in DateTimeExtensions: Converts this TimeZone to a corresponding ZoneOffset.

U

upto(Temporal, Temporal, TemporalUnit, Closure) - Method in DateTimeExtensions: Iterates from this to the to Temporal, inclusive, incrementing by one unit each iteration, calling the closure once per iteration.