com.atlassian.confluence.search.v2.query

Class AbstractUserQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.AbstractUserQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

Direct Known Subclasses:

ContributorQuery, CreatorQuery

public abstract class AbstractUserQuery
extends Object
implements SearchQuery

Constructor Summary

Constructors

Constructor and Description
AbstractUserQuery(String username) Deprecated.
AbstractUserQuery(com.atlassian.sal.api.user.UserKey userKey)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SearchQuery	expand() Expands this query into a composite query (that composes other queries).
protected abstract String	getField()
List	getParameters() Deprecated.
com.atlassian.fugue.Option<com.atlassian.sal.api.user.UserKey>	getUserkey()
com.atlassian.fugue.Option<String>	getUsername() Deprecated.
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

getKey

Constructor Detail

AbstractUserQuery

@Deprecated
public AbstractUserQuery(String username)

Deprecated.

Deprecated. Use the constructor with the userKey provided instead

Parameters:

username - that will be translated into a userkey. If the username is not found, a blank userkey will be used instead which is return no results

AbstractUserQuery

public AbstractUserQuery(@Nonnull
                         com.atlassian.sal.api.user.UserKey userKey)

Method Detail

getUsername

@Deprecated
public com.atlassian.fugue.Option<String> getUsername()

Deprecated.

Deprecated. Use getUserkey instead

getUserkey

public com.atlassian.fugue.Option<com.atlassian.sal.api.user.UserKey> getUserkey()

getField

protected abstract String getField()

getParameters

@Deprecated
public List getParameters()

Deprecated.

Deprecated. Rely on the userkey instead

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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