Package com.atlassian.confluence.search.v2.query

Class CustomContentTypeQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.CustomContentTypeQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class CustomContentTypeQuery
extends Object
implements SearchQuery

This V2 query is used for filtering custom contents based on their types.

Constructor Summary

Constructors

Constructor	Description
CustomContentTypeQuery(String... pluginKeys)	Search for a particular type of content
CustomContentTypeQuery(Collection<String> pluginKeys)	Search for content that is one of the provided types

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
String	getKey()
List<String>	getParameters()	List of parameters as Strings or SearchQuerys.
Set<String>	getPluginKeys()	Get the plugin keys being searched for, as strings.
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

Constructor Detail

CustomContentTypeQuery

public CustomContentTypeQuery(String... pluginKeys)

Search for a particular type of content

Parameters:

pluginKeys - the plugin keys of the content to be searched for

CustomContentTypeQuery

public CustomContentTypeQuery(Collection<String> pluginKeys)

Search for content that is one of the provided types

Parameters:

pluginKeys - a collection of the plugin keys of the content to be searched for

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List<String> getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

getPluginKeys

public Set<String> getPluginKeys()

Get the plugin keys being searched for, as strings.

Really does the same as getParameters() but has a more apt name.

Returns:

a list of the content types being searched for, as strings

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.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object