public class

OrderByRequestParserImpl

extends Object
implements OrderByRequestParser
java.lang.Object
   ↳ com.atlassian.jira.util.OrderByRequestParserImpl

Summary

Public Constructors
OrderByRequestParserImpl(I18nHelper i18n)
Public Methods
<T extends Enum<T>> Either<ErrorCollection, OrderByRequest<T>> parse(String orderByValue, Class<T> fields)
Parses a string representing an order by request into the OrderByRequest object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.util.OrderByRequestParser

Public Constructors

public OrderByRequestParserImpl (I18nHelper i18n)

Public Methods

public Either<ErrorCollection, OrderByRequest<T>> parse (String orderByValue, Class<T> fields)

Parses a string representing an order by request into the OrderByRequest object. Works only if field type of the expected order by request is an enum. Expected representation is as follows:

name
order by name ascending
+name
order by name ascending
-name
order by name ascending

Parsing is case insensitive so the above example will succeed if there is a NAME value in the supplied enum type.

Parameters
orderByValue value to parse
fields all available fields declared in an enum
Returns
  • parsed query or an error collection with a proper message