@PublicSpi public interface

ValuesGenerator

com.atlassian.configurable.ValuesGenerator<K>
Known Indirect Subclasses

@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

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

Summary

Fields
public static final ValuesGenerator NONE Implementation that returns no values at all.
Public Methods
Map<K, String> getValues(Map userParams)
Map of choices to use

Fields

public static final ValuesGenerator NONE

Implementation that returns no values at all.

Public Methods

public 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.