com.atlassian.jira.plugin.userformat.descriptors

Class DefaultUserFormatModuleDescriptors

java.lang.Object

com.atlassian.jira.plugin.userformat.descriptors.DefaultUserFormatModuleDescriptors

All Implemented Interfaces:

UserFormatModuleDescriptors

public class DefaultUserFormatModuleDescriptors
extends Object
implements UserFormatModuleDescriptors

Since:

v4.4

Constructor Summary

Constructors

Constructor and Description
DefaultUserFormatModuleDescriptors(com.atlassian.plugin.PluginAccessor pluginAccessor, ModuleDescriptors.Orderings moduleDescriptorOrderings)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUserFormatModuleDescriptors

public DefaultUserFormatModuleDescriptors(com.atlassian.plugin.PluginAccessor pluginAccessor,
                                          ModuleDescriptors.Orderings moduleDescriptorOrderings)

Method Detail

forType

public Iterable<UserFormatModuleDescriptor> forType(String type)

Description copied from interface: UserFormatModuleDescriptors

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

Specified by:

forType in interface UserFormatModuleDescriptors

Parameters:

type - The type of the user format module descriptors to find.

Returns:

An Iterable of user format module descriptors for the specified type.

withKey

public UserFormatModuleDescriptor withKey(String completeKey)

Description copied from interface: UserFormatModuleDescriptors

Gets the user format module descriptor for the specified key.

Specified by:

withKey in interface UserFormatModuleDescriptors

Parameters:

completeKey - The complete key for the module descriptor to find.

Returns:

A user format module descriptor for the specified key or null if no module descriptor could be found for that key.

get

public Iterable<UserFormatModuleDescriptor> get()

Description copied from interface: UserFormatModuleDescriptors

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

Specified by:

get in interface UserFormatModuleDescriptors

Returns:

An Iterable of all user format module descriptors.

defaultFor

public UserFormatModuleDescriptor defaultFor(String type)

Description copied from interface: UserFormatModuleDescriptors

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

Specified by:

defaultFor in interface UserFormatModuleDescriptors

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.