@PublicSpi public interface


Known Indirect Subclasses


This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

This interface indicates the values stored in the Lucene index for this searcher are naturally ordered and as a result natural Lucene sorting can be used allowing for best sort performance.


Public Methods
String getSortField(CustomField customField)
Retrun the name of the Lucene field to use for ordering.

Public Methods

public String getSortField (CustomField customField)

Retrun the name of the Lucene field to use for ordering. This will normally be just the field, .i.e customField.getId() but some searchers, e.g. TextSearcher, store additional fields to support sorting.

customField The custom field to be searched
  • The Lucene field name to use for orderring.