ClauseValuesGenerator

com.atlassian.jira.jql.values.ClauseValuesGenerator

Known Indirect Subclasses

AbstractIssueConstantValuesGenerator, ComponentClauseValuesGenerator, CustomFieldOptionsClauseValuesGenerator, GroupValuesGenerator, IssuePropertyClauseValueGenerator, IssueTypeClauseValuesGenerator, LabelsClauseValuesGenerator, PriorityClauseValuesGenerator, ProjectCategoryClauseValuesGenerator, ProjectClauseValuesGenerator, ResolutionClauseValuesGenerator, SavedFilterValuesGenerator, SecurityLevelClauseValuesGenerator, StatusCategoryClauseValuesGenerator, StatusClauseValuesGenerator, UserClauseValuesGenerator, VersionClauseValuesGenerator

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Generates the possible values for a field.

Summary

Nested Classes
class	ClauseValuesGenerator.Result
class	ClauseValuesGenerator.Results

Public Methods
ClauseValuesGenerator.Results	getPossibleValues(ApplicationUser searcher, String jqlClauseName, String valuePrefix, int maxNumResults) Will return a string representation of only the possible values that match the value prefix for this clause.

Public Methods

public ClauseValuesGenerator.Results getPossibleValues (ApplicationUser searcher, String jqlClauseName, String valuePrefix, int maxNumResults)

Will return a string representation of only the possible values that match the value prefix for this clause. This should not return more results than specified in maxNumResults. If it is possible this should use the maxNumResults to efficiently generate the results.

The contract of this method is that if the valuePrefix exactly (minus case) matches the suggestion then we suggest it. This will allow users to verify in their own minds that even though they have typed the full value, it is still valid.

Parameters

searcher	the user preforming the search.
jqlClauseName	the jql clause name that was entered by the user, represents the identifier that was used to find this values generator. Note: for custom fields this can be used to identify the custom field we are dealing with.
valuePrefix	the portion of the value that has already been provided by the user.
maxNumResults	the maximun number of results to return.

Returns

a string value of the clause values that match the provided value prefix, empty list if none match.

Interfaces

Classes