public interface

JqlLocalDateSupport

com.atlassian.jira.jql.util.JqlLocalDateSupport
Known Indirect Subclasses

Class Overview

Interface that helps with LocalDate parsing and validation in JQL.

See Also

Summary

Public Methods
Date convertToDate(LocalDate date)
Converts a LocalDate to a Date using the systems time zone.
LocalDate convertToLocalDate(String dateString)
Try to parse the passed date string using the formats that JQL understands.
LocalDate convertToLocalDate(Long dateLong)
Try to parse the passed date long.
String getIndexedValue(LocalDate date)
Converts a date into the index-friendly format.
String getLocalDateString(LocalDate date)
Return a string representation of the passed date.
boolean validate(String dateString)
Check to see if the passed string is a valid date according to JQL.

Public Methods

public Date convertToDate (LocalDate date)

Converts a LocalDate to a Date using the systems time zone.

Parameters
date the date to convert. Cannot be null.
Returns
  • return the Date for the local date.
Throws
IllegalArgumentException if the passed date is null.

public LocalDate convertToLocalDate (String dateString)

Try to parse the passed date string using the formats that JQL understands. It will consider the user's time zone when parsing the date string.

Parameters
dateString the string to parse. Cannot be empty or null.
Returns
  • the parsed date.
Throws
IllegalArgumentException if the passed dateString is blank or null.

public LocalDate convertToLocalDate (Long dateLong)

Try to parse the passed date long.

Parameters
dateLong the string to parse. Cannot be empty or null.
Returns
  • the parsed date.
Throws
IllegalArgumentException if the passed dateString is blank or null.

public String getIndexedValue (LocalDate date)

Converts a date into the index-friendly format.

Parameters
date the date
Returns
  • a string representing the date, ready for comparison to indexed values.

public String getLocalDateString (LocalDate date)

Return a string representation of the passed date. This method should just convert the date into its parseable String representation.

Parameters
date the date to convert. Cannot be null.
Returns
  • return the passed date as a string.
Throws
IllegalArgumentException if the passed date is null.

public boolean validate (String dateString)

Check to see if the passed string is a valid date according to JQL.

Parameters
dateString the string to check cannot be null.
Returns
  • true if the date is valid; false otherwise.
Throws
IllegalArgumentException if the passed dateString is blank or null