@PublicApi @ExperimentalApi public interface

Encoder

com.atlassian.jira.render.Encoder
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).

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Encoder used to render content that has been provided by JIRA administrators. Depending on the security profile that is in use, this content may or may not be HTML-encoded when being displayed.

Summary

Public Methods
@Nonnull String encodeForHtml(Object input)
Renders input as HTML.

Public Methods

@Nonnull public String encodeForHtml (Object input)

Renders input as HTML. This method calls toString() on input in order to get its String representation. If input is null, this method returns "".

Parameters
input a String
Returns
  • a String that is encoded for HTML