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

Class MacroUsageQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.MacroUsageQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class MacroUsageQuery
extends Object
implements SearchQuery

A search query that finds usages of a macro in a content entity object by the macro name.

Field Summary

Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
MacroUsageQuery(String macroName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
String	getKey()
String	getMacroName()
List<String>	getParameters()	List of parameters as Strings or SearchQuerys.
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 Details

MacroUsageQuery

public MacroUsageQuery(String macroName)

Method Details

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.

getMacroName

public String getMacroName()

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object