com.atlassian.configurable

Interface ValuesGenerator<K>

All Known Implementing Classes:

ColumnNamesValuesGenerator, DateFieldValuesGenerator, FilterStatisticsCascadingSelectValuesGenerator, FilterStatisticsValuesGenerator, FilterValuesGenerator, MailServersValuesGenerator, SearchRequestValuesGenerator, SortingValuesGenerator, SubTaskIncludeValuesGenerator, UserSubTaskIncludeValuesGenerator, VersionOptionalValuesGenerator

@PublicSpi
public interface ValuesGenerator<K>

Interface to implement when you want to retrieve a list of choices for a ConfigurationProperty.

Field Summary

Fields

Modifier and Type	Field and Description
static ValuesGenerator	NONE Implementation that returns no values at all.

Method Summary

Methods

Modifier and Type	Method and Description
Map<K,String>	getValues(Map userParams) Map of choices to use

Field Detail

NONE

static final ValuesGenerator NONE

Implementation that returns no values at all.

Since:

28 Aug 2007 for JIRA v3.11

Method Detail

getValues

Map<K,String> getValues(Map userParams)

Map of choices to use

Parameters:

userParams - Used to generate a relevant list of choices. e.g. may have some permissions in it

Returns:

Map which contains a list of choices as key value pairs. Can be null.