@InjectableComponent @PublicApi public interface

OrderByRequestParser

com.atlassian.jira.util.OrderByRequestParser
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A component that can parse raw strings into OrderByRequest objects.

Summary

Public Methods
<T extends Enum<T>> Either<ErrorCollectionOrderByRequest<T>> parse(String orderByValue, Class<T> fields)
Parses a string representing an order by request into the OrderByRequest object.

Public Methods

public Either<ErrorCollectionOrderByRequest<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