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

Class UserTextQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.UserTextQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class UserTextQuery
extends Object
implements SearchQuery

Searches for text within common user-related text fields: full name, email address and username

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

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

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
UserTextQuery(String queryString)	Construct a new query for a given file extension

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	getParameters()	List of parameters as Strings or SearchQuerys.
String	getQueryString()
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 Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

UserTextQuery

public UserTextQuery(String queryString)

Construct a new query for a given file extension

Parameters:

queryString - the extension (without a period)

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.

getQueryString

public String getQueryString()

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