DateUtilStaticExtensions (Groovy 5.0.6)
Description: declaration: package: org.apache.groovy.dateutil.extensions, class: DateUtilStaticExtensions

Package org.apache.groovy.dateutil.extensions

# Class DateUtilStaticExtensions

java.lang.Object
org.apache.groovy.dateutil.extensions.DateUtilStaticExtensions

public class DateUtilStaticExtensions extends Object
This class defines new groovy static methods which appear on normal JDK Date and Calendar classes inside the Groovy environment.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DateUtilStaticExtensions()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static Date`
  `parse(Date self, String format, String input)`
  Parse a String into a Date instance using the given pattern.
  `static Date`
  `parse(Date self, String format, String input, TimeZone zone)`
  Parse a String into a Date instance using the given pattern and TimeZone.
  `static Date`
  `parseToStringDate(Date self, String dateToString)`
  Parse a String matching the pattern EEE MMM dd HH:mm:ss zzz yyyy containing US-locale-constants only (e.g.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### DateUtilStaticExtensions

    public DateUtilStaticExtensions()

- ## Method Details

  - ### parse

    public static Date parse(Date self, String format, String input) throws ParseException
    Parse a String into a Date instance using the given pattern. This convenience method acts as a wrapper for `SimpleDateFormat`.

    Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety).

    Parameters:
      `self` - placeholder variable used by Groovy categories; ignored for default static methods
      `format` - pattern used to parse the input string.
      `input` - String to be parsed to create the date instance
    Returns:
      a new Date instance representing the parsed input string
    Throws:
      `ParseException` - if there is a parse error
    Since:
      1.5.7
    See Also:
      - `DateFormat.parse(java.lang.String)`

  - ### parse

    public static Date parse(Date self, String format, String input, TimeZone zone) throws ParseException
    Parse a String into a Date instance using the given pattern and TimeZone. This convenience method acts as a wrapper for `SimpleDateFormat`.

    Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety).

    Parameters:
      `self` - placeholder variable used by Groovy categories; ignored for default static methods
      `format` - pattern used to parse the input string.
      `input` - String to be parsed to create the date instance
      `zone` - TimeZone to use when parsing
    Returns:
      a new Date instance representing the parsed input string
    Throws:
      `ParseException` - if there is a parse error
    Since:
      2.4.1
    See Also:
      - `DateFormat.parse(java.lang.String)`

  - ### parseToStringDate

    public static Date parseToStringDate(Date self, String dateToString) throws ParseException
    Parse a String matching the pattern EEE MMM dd HH:mm:ss zzz yyyy containing US-locale-constants only (e.g. Sat for Saturdays). Such a string is generated by the toString method of `Date`

    Note that a new SimpleDateFormat instance is created for every invocation of this method (for thread safety).

    Parameters:
      `self` - placeholder variable used by Groovy categories; ignored for default static methods
      `dateToString` - String to be parsed to create the date instance. Must match the pattern EEE MMM dd HH:mm:ss zzz yyyy with US-locale symbols
    Returns:
      a new Date instance representing the parsed input string
    Throws:
      `ParseException` - if there is a parse error
    Since:
      1.8.4