com.atlassian.confluence.search.v2.searchfilter

Class InSpaceSearchFilter

java.lang.Object

com.atlassian.confluence.search.v2.AbstractChainableSearchFilter

com.atlassian.confluence.search.v2.searchfilter.InSpaceSearchFilter

All Implemented Interfaces:

Expandable<SearchFilter>, SearchFilter

@Immutable
public class InSpaceSearchFilter
extends AbstractChainableSearchFilter

Filters for documents that belong to spaces with the specified space keys. Also returns documents that don't belong to any spaces (such as personal information/profile documents)

Constructor Summary

Constructors

Constructor and Description
InSpaceSearchFilter(Set<String> spaceKeys)

Method Summary

Modifier and Type	Method and Description
SearchFilter	expand() Expands this filter into a composite filter (that composes other filters).
String	getKey()
Set<String>	getSpaceKeys()

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

InSpaceSearchFilter

public InSpaceSearchFilter(@Nonnull
                           Set<String> spaceKeys)

Method Detail

getSpaceKeys

public Set<String> getSpaceKeys()

getKey

public String getKey()

Returns:

the plugin key

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