Class DateTimeStaticExtensions
- java.lang.Object
-
- org.apache.groovy.datetime.extensions.DateTimeStaticExtensions
-
public class DateTimeStaticExtensions extends Object
This class defines new static extension methods which appear on normal JDK Date/Time API (java.time) classes inside the Groovy environment.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Periodbetween(Period type, YearMonth startInclusive, YearMonth endExclusive)Obtains a Period consisting of the number of years and months between twoYearMonthinstances.static Periodbetween(Period type, Year startInclusive, Year endExclusive)Obtains a Period consisting of the number of years between twoYearinstances.static LocalDateparse(LocalDate type, CharSequence text, String pattern)Parse text into aLocalDateusing the provided pattern.static LocalDateTimeparse(LocalDateTime type, CharSequence text, String pattern)Parse text into aLocalDateTimeusing the provided pattern.static LocalTimeparse(LocalTime type, CharSequence text, String pattern)Parse text into aLocalTimeusing the provided pattern.static MonthDayparse(MonthDay type, CharSequence text, String pattern)Parse text into aMonthDayusing the provided pattern.static OffsetDateTimeparse(OffsetDateTime type, CharSequence text, String pattern)Parse text into anOffsetDateTimeusing the provided pattern.static OffsetTimeparse(OffsetTime type, CharSequence text, String pattern)Parse text into anOffsetTimeusing the provided pattern.static YearMonthparse(YearMonth type, CharSequence text, String pattern)Parse text into aYearMonthusing the provided pattern.static Yearparse(Year type, CharSequence text, String pattern)Parse text into aYearusing the provided pattern.static ZonedDateTimeparse(ZonedDateTime type, CharSequence text, String pattern)Parse text into aZonedDateTimeusing the provided pattern.static ZoneOffsetsystemDefault(ZoneOffset type)Returns theZoneOffsetcurrently associated with the system defaultZoneId.
-
-
-
Method Detail
-
parse
public static LocalDate parse(LocalDate type, CharSequence text, String pattern)
Parse text into aLocalDateusing the provided pattern. Note: the order of parameters differs from versions of this method for the legacy Date class.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a LocalDate representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,LocalDate.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static LocalDateTime parse(LocalDateTime type, CharSequence text, String pattern)
Parse text into aLocalDateTimeusing the provided pattern. Note: the order of parameters differs from versions of this method for the legacy Date class.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a LocalDateTime representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,LocalDateTime.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static LocalTime parse(LocalTime type, CharSequence text, String pattern)
Parse text into aLocalTimeusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a LocalTime representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,LocalTime.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static MonthDay parse(MonthDay type, CharSequence text, String pattern)
Parse text into aMonthDayusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a MonthDay representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,MonthDay.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static OffsetDateTime parse(OffsetDateTime type, CharSequence text, String pattern)
Parse text into anOffsetDateTimeusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- an OffsetDateTime representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,OffsetDateTime.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static OffsetTime parse(OffsetTime type, CharSequence text, String pattern)
Parse text into anOffsetTimeusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- an OffsetTime representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,OffsetTime.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static Year parse(Year type, CharSequence text, String pattern)
Parse text into aYearusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a Year representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,Year.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static YearMonth parse(YearMonth type, CharSequence text, String pattern)
Parse text into aYearMonthusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a YearMonth representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,YearMonth.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
parse
public static ZonedDateTime parse(ZonedDateTime type, CharSequence text, String pattern)
Parse text into aZonedDateTimeusing the provided pattern.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodstext- String to be parsed to create the date instancepattern- pattern used to parse the text- Returns:
- a ZonedDateTime representing the parsed text
- Throws:
IllegalArgumentException- if the pattern is invalidDateTimeParseException- if the text cannot be parsed- Since:
- 2.5.0
- See Also:
DateTimeFormatter,ZonedDateTime.parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)
-
systemDefault
public static ZoneOffset systemDefault(ZoneOffset type)
Returns theZoneOffsetcurrently associated with the system defaultZoneId.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methods- Returns:
- a ZoneOffset
- Since:
- 2.5.0
- See Also:
ZoneId.systemDefault()
-
between
public static Period between(Period type, Year startInclusive, Year endExclusive)
Obtains a Period consisting of the number of years between twoYearinstances. The months and days of the Period will be zero. The result of this method can be a negative period if the end is before the start.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodsstartInclusive- the startYear, inclusive, not nullendExclusive- the endYear, exclusive, not null- Returns:
- a Period between the years
- See Also:
Period.between(LocalDate, LocalDate)
-
between
public static Period between(Period type, YearMonth startInclusive, YearMonth endExclusive)
Obtains a Period consisting of the number of years and months between twoYearMonthinstances. The days of the Period will be zero. The result of this method can be a negative period if the end is before the start.- Parameters:
type- placeholder variable used by Groovy categories; ignored for default static methodsstartInclusive- the startYearMonth, inclusive, not nullendExclusive- the endYearMonth, exclusive, not null- Returns:
- a Period between the year/months
- See Also:
Period.between(LocalDate, LocalDate)
-
-