public class

SearchSort

extends Object
implements Serializable
java.lang.Object
   ↳ com.atlassian.query.order.SearchSort

Class Overview

A simple data bean representing a portion of the sort order (related to a clause) for a search query. Together via the OrderBy these will determine the sorting order of the results returned by a Query.

Summary

Public Constructors
SearchSort(String field)
SearchSort(String field, SortOrder order)
Used to construct a search sort for a field with a direction.
SearchSort(String order, String field)
This constructor is deprecated. use SearchSort(String, SortOrder) instead.
SearchSort(SearchSort copy)
Public Methods
boolean equals(Object o)
String getField()
String getOrder()
SortOrder getSortOrder()
int hashCode()
boolean isReverse()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SearchSort (String field)

public SearchSort (String field, SortOrder order)

Used to construct a search sort for a field with a direction.

Parameters
field to sort by.
order direction to sort by, if null the default order for the field will be used.

public SearchSort (String order, String field)

This constructor is deprecated.
use SearchSort(String, SortOrder) instead.

Used to construct a search sort for a field with a direction. NOTE: it would be better if the order of these parameters was reversed but we are leaving it for backward compatibility.

Parameters
order the order of the sort, if null, will be the default order for the system, if not one of ASC or DESC it will default to ASC.
field to sort by.

public SearchSort (SearchSort copy)

Public Methods

public boolean equals (Object o)

public String getField ()

public String getOrder ()

public SortOrder getSortOrder ()

public int hashCode ()

public boolean isReverse ()

public String toString ()