public abstract class

AbstractSort

extends Object
implements SearchSort
java.lang.Object
   ↳ com.atlassian.confluence.search.v2.sort.AbstractSort
Known Direct Subclasses

Class Overview

Abstract superclass for simple sort types that just sort in a particular direction on some field.

Summary

Protected Constructors
AbstractSort(String key, SearchSort.Order order)
Constructs a sort.
Public Methods
boolean equals(Object o)
String getKey()
Gets the key that uniquely identifies this sort method.
SearchSort.Order getOrder()
Returns the order (whether ASCENDING or DESCENDING) of the sort.
int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.v2.SearchSort

Protected Constructors

protected AbstractSort (String key, SearchSort.Order order)

Constructs a sort.

Parameters
key a unique key to identify this sort
order (required) the order of the sort (SearchSort.Order). Implementations should define what ascending and descending means in regards to their custom sort type.

Public Methods

public boolean equals (Object o)

public String getKey ()

Gets the key that uniquely identifies this sort method.

Returns
  • the sort key

public SearchSort.Order getOrder ()

Returns the order (whether ASCENDING or DESCENDING) of the sort.

Returns

public int hashCode ()