Summary: Methods | [Expand All]
@PublicApi public interface

CustomFieldTypeModuleDescriptors

com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptors
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Provides different methods to access the CustomFieldTypes registered in the system.

Summary

Public Methods
Option<CustomFieldType> getCustomFieldType(String completeModuleKey)
Retrieve a custom field type by its type key.
@Nonnull List<CustomFieldType<?, ?>> getCustomFieldTypes()
Retrieve all CustomFieldTypes registered in the system.

Public Methods

public Option<CustomFieldType> getCustomFieldType (String completeModuleKey)

Retrieve a custom field type by its type key. The key is the "full plugin module key". That is, the plugin key for the plugin it comes from, a colon separator, and then the module key.

Parameters
completeModuleKey Type identifier constructed from plugin XML.
Returns

@Nonnull public List<CustomFieldType<?, ?>> getCustomFieldTypes ()

Retrieve all CustomFieldTypes registered in the system.

Returns