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

Class InheritedLabelQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.InheritedLabelQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class InheritedLabelQuery
extends Object
implements SearchQuery

Query for matching a single Label that was inherited from a piece of parent content, for example, searching for comments attached to pages with a certain label

Field Summary

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

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
InheritedLabelQuery(Label label)	Construct a LabelQuery directly from the Label instance to be searched for
InheritedLabelQuery(String label)	Construct a LabelQuery from a string representation of a label.

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	getLabelAsString()
List	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 Detail

InheritedLabelQuery

public InheritedLabelQuery(String label)

Construct a LabelQuery from a string representation of a label.

Parameters:

label - a representations of a label. Can be namespaced.

See Also:

LabelParser

InheritedLabelQuery

public InheritedLabelQuery(Label label)

Construct a LabelQuery directly from the Label instance to be searched for

Parameters:

label - the label to search for

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

getLabelAsString

public String getLabelAsString()

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 obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object