com.atlassian.confluence.search.v2.searchfilter

Class ArchivedSpacesSearchFilter

java.lang.Object

com.atlassian.confluence.search.v2.AbstractChainableSearchFilter

com.atlassian.confluence.search.v2.searchfilter.ArchivedSpacesSearchFilter

All Implemented Interfaces:

Expandable<SearchFilter>, SearchFilter

public class ArchivedSpacesSearchFilter
extends AbstractChainableSearchFilter

Filters archived spaces (and their contents) out of search results. Can be inverted to only include archived spaces.

Constructor Summary

Constructors

Constructor and Description
ArchivedSpacesSearchFilter(boolean inverse) Deprecated. Since 5.9 Use ArchivedSpacesSearchFilter(boolean, SpaceManager)
ArchivedSpacesSearchFilter(boolean inverse, SpaceManager spaceManager) Construct the filter

Method Summary

Modifier and Type	Method and Description
SearchFilter	expand() Expands this filter into a composite filter (that composes other filters).
String	getKey()
boolean	isInverse()

Methods inherited from class com.atlassian.confluence.search.v2.AbstractChainableSearchFilter

and, or

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchivedSpacesSearchFilter

public ArchivedSpacesSearchFilter(boolean inverse,
                                  SpaceManager spaceManager)

Construct the filter

Parameters:

inverse - the filter should filter out non-archived spaces instead of archived spaces

spaceManager - used to expand this filter into primitives filter

ArchivedSpacesSearchFilter

@Deprecated
public ArchivedSpacesSearchFilter(boolean inverse)

Deprecated. Since 5.9 Use ArchivedSpacesSearchFilter(boolean, SpaceManager)

Construct the filter

Parameters:

inverse - the filter should filter out non-archived spaces instead of archived spaces

Method Detail

getKey

public String getKey()

Returns:

the plugin key

isInverse

public boolean isInverse()

expand

public SearchFilter expand()

Description copied from interface: SearchFilter

Expands this filter into a composite filter (that composes other filters). By overriding this method, one can specify a new filter that is composition of the behaviour of the composed filters.

Returns:

a filter