Package com.atlassian.jira.plugin.customfield

Interface CustomFieldTypeModuleDescriptors

All Known Implementing Classes:
CustomFieldTypeModuleDescriptorsImpl
@PublicApi public interface CustomFieldTypeModuleDescriptors
Provides different methods to access the CustomFieldTypes registered in the system.

  • Method Details

    • getCustomFieldTypes

      @Nonnull @Deprecated List<CustomFieldType<?,?>> getCustomFieldTypes()
      Deprecated.
      since 8.10 use getUnorderedCustomFieldTypes() and sort only when needed
      Retrieve all CustomFieldTypes registered in the system and sorted by name.
      Returns:
      a list of CustomFieldTypes

    • getUnorderedCustomFieldTypes

      @Nonnull default List<CustomFieldType<?,?>> getUnorderedCustomFieldTypes()
      Retrieve all CustomFieldTypes registered in the system.
      Returns:
      a list of CustomFieldTypes

    • getCustomFieldType

      io.atlassian.fugue.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:
      An Option with the CustomFieldType for the given key