com.atlassian.confluence.search.v2.searchfilter

Class LabelsSearchFilter

java.lang.Object

com.atlassian.confluence.search.v2.AbstractChainableSearchFilter

com.atlassian.confluence.search.v2.searchfilter.LabelsSearchFilter

All Implemented Interfaces:

Expandable<SearchFilter>, SearchFilter

@Immutable
public class LabelsSearchFilter
extends AbstractChainableSearchFilter

Allows filtering by multiple labels. Results returned must match at least one of the specified labels.

Constructor Summary

Constructors

Constructor and Description
LabelsSearchFilter(Set<String> labels)

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>	getLabels()

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

LabelsSearchFilter

public LabelsSearchFilter(Set<String> labels)

Parameters:

labels - a set of labels. Namespaced labels such as "my:foo" are permitted. Required.

Throws:

IllegalArgumentException - if labels is null

Method Detail

getLabels

public Set<String> getLabels()

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