Package com.atlassian.jira.jql

Class DefaultClauseHandler

java.lang.Object

com.atlassian.jira.jql.DefaultClauseHandler

All Implemented Interfaces:

ClauseHandler

public final class DefaultClauseHandler
extends Object
implements ClauseHandler

A container for all the objects needed to process a Jql clause.

Since:

v4.0

Constructor Summary

Constructors

Constructor	Description
DefaultClauseHandler(ClauseInformation information, ClauseQueryFactory factory, ClauseValidator validator, ClausePermissionHandler permissionHandler, ClauseContextFactory contextFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.4.
DefaultClauseHandler(ClauseInformation information, ClauseQueryMapper mapper, ClauseQueryFactory factory, ClauseValidator validator, ClausePermissionHandler permissionHandler, ClauseContextFactory contextFactory)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.4.
DefaultClauseHandler(ClauseInformation information, ClauseQueryMapper clauseQueryMapper, ClauseValidator validator, ClausePermissionHandler permissionHandler, ClauseContextFactory contextFactory)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ClauseContextFactory	getClauseContextFactory()
ClauseQueryFactory	getFactory()
ClauseInformation	getInformation()
ClauseQueryMapper	getMapper()	Get a mapper that can create a search query for the clause.
ClausePermissionHandler	getPermissionHandler()
ClauseValidator	getValidator()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultClauseHandler

@Deprecated(since="10.4",
            forRemoval=true)
public DefaultClauseHandler(ClauseInformation information,
 ClauseQueryFactory factory,
 ClauseValidator validator,
 ClausePermissionHandler permissionHandler,
 ClauseContextFactory contextFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4. Use DefaultClauseHandler(ClauseInformation, ClauseQueryMapper, ClauseValidator, ClausePermissionHandler, ClauseContextFactory) instead.

DefaultClauseHandler

@Deprecated(since="10.4",
            forRemoval=true)
public DefaultClauseHandler(ClauseInformation information,
 ClauseQueryMapper mapper,
 ClauseQueryFactory factory,
 ClauseValidator validator,
 ClausePermissionHandler permissionHandler,
 ClauseContextFactory contextFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4. Use DefaultClauseHandler(ClauseInformation, ClauseQueryMapper, ClauseValidator, ClausePermissionHandler, ClauseContextFactory) instead.

This constructor can be used when both clauseQueryFactory and clauseQueryMapper are used for fallback purposes.

DefaultClauseHandler

public DefaultClauseHandler(ClauseInformation information,
 ClauseQueryMapper clauseQueryMapper,
 ClauseValidator validator,
 ClausePermissionHandler permissionHandler,
 ClauseContextFactory contextFactory)

Method Details

getInformation

public ClauseInformation getInformation()

Specified by:

getInformation in interface ClauseHandler

Returns:

an object that contains some static naming information (clause names, field id, index id) about the clause handler and its associations.

getFactory

public ClauseQueryFactory getFactory()

Specified by:

getFactory in interface ClauseHandler

Returns:

a mapper that can create a search query for the clause.

getMapper

public ClauseQueryMapper getMapper()

Description copied from interface: ClauseHandler

Get a mapper that can create a search query for the clause. To replace the deprecated ClauseHandler.getFactory() method.

Specified by:

getMapper in interface ClauseHandler

Returns:

getValidator

public ClauseValidator getValidator()

Specified by:

getValidator in interface ClauseHandler

Returns:

a validator that will inspect the clause and return any validation errors it encounters.

getPermissionHandler

public ClausePermissionHandler getPermissionHandler()

Specified by:

getPermissionHandler in interface ClauseHandler

Returns:

a permission handler that will check the users who is executing the queries permission to include the clause.

getClauseContextFactory

public ClauseContextFactory getClauseContextFactory()

Specified by:

getClauseContextFactory in interface ClauseHandler

Returns:

a clause context factory that will be able to generate the clause context

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object