@PublicApi public interface

Option

com.atlassian.jira.issue.fields.option.Option
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

An option class to wrap around other objects for display in select lists

Summary

Public Methods
List getChildOptions()
Returns a list of dependent child options.
String getCssClass()
String getDescription()
String getId()
String getImagePath()
String getImagePathHtml()
Returns the HTML-encoded image path for this Option.
String getName()

Public Methods

public List getChildOptions ()

Returns a list of dependent child options. Returns empty list if no children

Returns
  • List of Option objects. (empty list if no children)

public String getCssClass ()

public String getDescription ()

public String getId ()

public String getImagePath ()

public String getImagePathHtml ()

Returns the HTML-encoded image path for this Option.

Returns
  • an HTML-encoded image path
See Also

public String getName ()