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

java.lang.Object
  extended by com.atlassian.confluence.search.v2.AbstractChainableSearchFilter
      extended by com.atlassian.confluence.search.v2.searchfilter.LabelsSearchFilter
All Implemented Interfaces:
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
LabelsSearchFilter(Set<String> labels)
           
 
Method Summary
 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


Copyright © 2003-2012 Atlassian. All Rights Reserved.