Package com.almworks.jira.structure.api.query

Interface StructureQueryParser

@PublicApi
public interface StructureQueryParser

Parses a structure query expressed in the Structured JQL language. The syntax of the language is the same as of the corresponding argument of the structure() JQL function bundled with the Structure plugin. See plugin documentation for more details on the syntax.

Method Summary

Modifier and Type	Method	Description
StructureQuery	parse(String query)	Parses query and returns the corresponding StructureQuery.

Method Details

parse

@NotNull
StructureQuery parse(@NotNull
 String query)
              throws StructureException

Parses query and returns the corresponding StructureQuery. The returned object will yield query when StructureQuery.getQueryString() is called.

Throws:

NullPointerException - if query is null

StructureException - if the query is not well-formed; call StructureException.getLocalizedMessage() or StructureException.getLocalizedMessage() to get a human-readable parse error message.