Class AbstractIssueConstantValuesGenerator

  extended by com.atlassian.jira.jql.values.AbstractIssueConstantValuesGenerator
All Implemented Interfaces:
Direct Known Subclasses:
IssueTypeClauseValuesGenerator, PriorityClauseValuesGenerator, ResolutionClauseValuesGenerator, StatusClauseValuesGenerator

public abstract class AbstractIssueConstantValuesGenerator
extends Object
implements ClauseValuesGenerator

Generates autocomplete values for IssueConstants.


Nested Class Summary
Nested classes/interfaces inherited from interface com.atlassian.jira.jql.values.ClauseValuesGenerator
ClauseValuesGenerator.Result, ClauseValuesGenerator.Results
Constructor Summary
Method Summary
protected  List<String> getAllConstantNames()
protected abstract  List<IssueConstant> getAllConstants()
 ClauseValuesGenerator.Results getPossibleValues(com.atlassian.crowd.embedded.api.User 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.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public AbstractIssueConstantValuesGenerator()
Method Detail


public ClauseValuesGenerator.Results getPossibleValues(com.atlassian.crowd.embedded.api.User searcher,
                                                       String jqlClauseName,
                                                       String valuePrefix,
                                                       int maxNumResults)
Description copied from interface: ClauseValuesGenerator
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.

Specified by:
getPossibleValues in interface ClauseValuesGenerator
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.
a string value of the clause values that match the provided value prefix, empty list if none match.


protected abstract List<IssueConstant> getAllConstants()
a modifiable list of all the constants


protected List<String> getAllConstantNames()
a modifiable list of all the constant names

Copyright © 2002-2012 Atlassian. All Rights Reserved.