Summary: Methods | [Expand All]
public interface

UserFormatModuleDescriptors

com.atlassian.jira.plugin.userformat.descriptors.UserFormatModuleDescriptors
Known Indirect Subclasses

Class Overview

Represents the enabled user format module descriptors in the plugins system.

Summary

Public Methods
UserFormatModuleDescriptor defaultFor(String type)
Gets the default user format module descriptors for the specified type.
Iterable<UserFormatModuleDescriptor> forType(String type)
Gets a snapshot of the configured user format module descriptors for a specific type from the plugins system.
Iterable<UserFormatModuleDescriptor> get()
Gets a snapshot of all the configured user format module descriptors from the plugins system.
UserFormatModuleDescriptor withKey(String completeKey)
Gets the user format module descriptor for the specified key.

Public Methods

public UserFormatModuleDescriptor defaultFor (String type)

Gets the default user format module descriptors for the specified type.

Parameters
type The type to find a default user format descriptor for.
Returns
  • A default user format module descriptor for the specified type or null if no default was found.

public Iterable<UserFormatModuleDescriptor> forType (String type)

Gets a snapshot of the configured user format module descriptors for a specific type from the plugins system.

Parameters
type The type of the user format module descriptors to find.
Returns
  • An Iterable of user format module descriptors for the specified type.

public Iterable<UserFormatModuleDescriptor> get ()

Gets a snapshot of all the configured user format module descriptors from the plugins system.

Returns
  • An Iterable of all user format module descriptors.

public UserFormatModuleDescriptor withKey (String completeKey)

Gets the user format module descriptor for the specified key.

Parameters
completeKey The complete key for the module descriptor to find.
Returns