Class InSpaceQuery
- java.lang.Object
-
- com.atlassian.confluence.search.v2.query.AbstractParameterListQuery<String>
-
- com.atlassian.confluence.search.v2.query.InSpaceQuery
-
- All Implemented Interfaces:
Expandable<SearchQuery>
,SearchQuery
public class InSpaceQuery extends AbstractParameterListQuery<String>
Search using a set of space keys for content that occurs within some set of spaces. This query will not contribute to relevancy of search results.
-
-
Field Summary
-
Fields inherited from class com.atlassian.confluence.search.v2.query.AbstractParameterListQuery
parameters
-
-
Constructor Summary
Constructors Constructor Description InSpaceQuery(String spaceKey)
Search for content within a single space with the given keyInSpaceQuery(Set<String> spaceKeys)
Search for content within any of a collection of spaces with given keys
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchQuery
expand()
Expands this query into a composite query (that composes other queries).String
getKey()
-
Methods inherited from class com.atlassian.confluence.search.v2.query.AbstractParameterListQuery
equals, getParameters, 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
-
-
-
-
Constructor Detail
-
InSpaceQuery
public InSpaceQuery(String spaceKey)
Search for content within a single space with the given key- Parameters:
spaceKey
- the key of the space to search within
-
-
Method Detail
-
getKey
public String getKey()
- Returns:
- the plugin key
-
expand
public SearchQuery 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.- Returns:
- a query
-
-