Package com.atlassian.jira.jql.parser

Interface JqlQueryParser

All Known Implementing Classes:
DefaultJqlQueryParser
public interface JqlQueryParser
Used to parse some JQL into its Query representation.
Since:
v4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isValidFieldName(String fieldName)
    Determines whether or not the passed string is a valid JQL field name.
    boolean
    isValidFunctionArgument(String argument)
    Determines whether or not the passed string is a valid JQL function argument.
    boolean
    isValidFunctionName(String functionName)
    Determines whether or not the passed string is a valid JQL function name.
    boolean
    isValidValue(String value)
    Determines whether or not the passed string is a valid JQL value.
    Query
    parseQuery(String jqlQuery)
    Parse the passed JQL string into its SearchQuery representation.

  • Method Details

    • parseQuery

      Query parseQuery(String jqlQuery) throws JqlParseException
      Parse the passed JQL string into its SearchQuery representation.
      Parameters:
      jqlQuery - the JQL string to parse. Must not be null or blank.
      Returns:
      the Query representation of the passed jql string. Never null.
      Throws:
      JqlParseException - if an error occurs while parsing the query.
      IllegalArgumentException - if jqlQuery is null or blank.

    • isValidFieldName

      boolean isValidFieldName(String fieldName)
      Determines whether or not the passed string is a valid JQL field name.
      Parameters:
      fieldName - the field name to check.
      Returns:
      true if the passed string is a valid field name or false otherwise.

    • isValidFunctionArgument

      boolean isValidFunctionArgument(String argument)
      Determines whether or not the passed string is a valid JQL function argument.
      Parameters:
      argument - the function argument to check.
      Returns:
      true if the passed function argument is valid or false otherwise.

    • isValidFunctionName

      boolean isValidFunctionName(String functionName)
      Determines whether or not the passed string is a valid JQL function name.
      Parameters:
      functionName - the function name to check.
      Returns:
      true if the passed function name is valid or false otherwise.

    • isValidValue

      boolean isValidValue(String value)
      Determines whether or not the passed string is a valid JQL value.
      Parameters:
      value - the value to check.
      Returns:
      true if the passed value is valid or false otherwise.