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

ShareTypeFactory

com.atlassian.jira.sharing.type.ShareTypeFactory
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

Factory that supplies all ShareTypes that are available in the system.

Summary

Public Methods
Collection<ShareType> getAllShareTypes()
Returns a Collection of all ShareType instnaces available.
Comparator<SharePermission> getPermissionComparator()
Return a comparator that can order SharePermissions for display.
ShareType getShareType(ShareType.Name type)
Returns a ShareType based on a given key.

Public Methods

public Collection<ShareType> getAllShareTypes ()

Returns a Collection of all ShareType instnaces available.

Returns
  • a Collection of all ShareType instnaces available.

public Comparator<SharePermission> getPermissionComparator ()

Return a comparator that can order SharePermissions for display.

Returns
  • a comparator for permission ordering.

public ShareType getShareType (ShareType.Name type)

Returns a ShareType based on a given key.

Parameters
type a string representing type of ShareType
Returns