@PublicApi public class

OrderByRequests

extends Object
java.lang.Object
   ↳ com.atlassian.jira.util.OrderByRequests

@PublicApi

This class 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

Class containing useful methods for sorting in accordance with OrderByRequests.

Summary

Nested Classes
interface OrderByRequests.ExtractableField<T> A field implementing this interface provides a method for extracting the field's value from an entity of type T
Public Constructors
OrderByRequests()
Public Methods
static <T, F extends ExtractableField<T>> Ordering<T> toOrdering(OrderByRequest<F> orderByRequest)
Given an order query defined for fields implementing the OrderByRequests.ExtractableField interface, creates an com.google.common.collect.Ordering that can sort according to the orderByRequest.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public OrderByRequests ()

Public Methods

public static Ordering<T> toOrdering (OrderByRequest<F> orderByRequest)

Given an order query defined for fields implementing the OrderByRequests.ExtractableField interface, creates an com.google.common.collect.Ordering that can sort according to the orderByRequest.

Parameters
orderByRequest order query to to create ordering from
Returns
  • an ordering that can sort T-s according to the orderByRequest