com.atlassian.jira.jql.values
Class LabelsClauseValuesGenerator

java.lang.Object
  extended by com.atlassian.jira.jql.values.LabelsClauseValuesGenerator
All Implemented Interfaces:
ClauseValuesGenerator

public class LabelsClauseValuesGenerator
extends java.lang.Object
implements ClauseValuesGenerator

Generates completions to be used in the JQL autocomplete. Possible values will be combined for all matching labels fields. (Custom fields with the same name)

Since:
v4.2

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.jira.jql.values.ClauseValuesGenerator
ClauseValuesGenerator.Result, ClauseValuesGenerator.Results
 
Constructor Summary
LabelsClauseValuesGenerator(LabelManager labelManager)
           
 
Method Summary
 ClauseValuesGenerator.Results getPossibleValues(com.opensymphony.user.User searcher, java.lang.String jqlClauseName, java.lang.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

LabelsClauseValuesGenerator

public LabelsClauseValuesGenerator(LabelManager labelManager)
Method Detail

getPossibleValues

public ClauseValuesGenerator.Results getPossibleValues(com.opensymphony.user.User searcher,
                                                       java.lang.String jqlClauseName,
                                                       java.lang.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
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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.