public interface

SearchFilter

com.atlassian.confluence.search.v2.SearchFilter
Known Indirect Subclasses

Class Overview

A filter to be performed against the search index during search time (not post results). Implementations should be immutable.

Search filters consist of a key (a unique string, usually a plugin module complete key, to identify the type of search filter being performed).

Summary

Public Methods
SearchFilter and(SearchFilter other)
Combines this filter with the one specified, returning a new filter.
String getKey()
SearchFilter or(SearchFilter other)
Combines this filter with the one specified, returning a new filter.

Public Methods

public SearchFilter and (SearchFilter other)

Combines this filter with the one specified, returning a new filter. To pass the new filter, matches to both the original filters are required.

Parameters
other the other filter.
Returns
  • a new filter

public String getKey ()

Returns
  • the plugin key

public SearchFilter or (SearchFilter other)

Combines this filter with the one specified, returning a new filter. To pass the new filter, there must be a match in at least one of the original filters.

Parameters
other the other filter
Returns
  • a new filter