Class LabelsQuery
java.lang.Object
com.atlassian.confluence.search.v2.query.LabelsQuery
- All Implemented Interfaces:
Expandable<SearchQuery>
,SearchQuery
Allows querying by multiple labels. Results returned must match at least one of the specified labels.
Although user labels is deprecated, each of them will be included as a
PrefixQuery
in the should clause of
the final BooleanQuery
and all other global labels will be ignored if they are ever included in the input
collection. If none of the user labels is found, each global label (if specified) will be included as a TermQuery
in the final BooleanQuery
.- Since:
- 7.20
-
Field Summary
Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery
DEFAULT_BOOST
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
expand()
Expands this query into a composite query (that composes other queries).getKey()
List of parameters asString
s orSearchQuery
s.int
hashCode()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery
getBoost, getSubClauses
-
Field Details
-
KEY
- See Also:
-
-
Constructor Details
-
LabelsQuery
- Parameters:
labels
- a set of labels. Namespaced labels such as "my:foo" are permitted. Required.- Throws:
IllegalArgumentException
- if labels is null
-
-
Method Details
-
getKey
- Specified by:
getKey
in interfaceSearchQuery
- Returns:
- the plugin key
-
getParameters
Description copied from interface:SearchQuery
List of parameters asString
s orSearchQuery
s.- Specified by:
getParameters
in interfaceSearchQuery
- Returns:
String
s orSearchQuery
s.
-
getLabels
-
expand
Description copied from interface:SearchQuery
Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.- Specified by:
expand
in interfaceExpandable<SearchQuery>
- Specified by:
expand
in interfaceSearchQuery
- Returns:
- a query
-
equals
-
hashCode
public int hashCode()
-