Package com.atlassian.jira.render

Interface Encoder

All Known Implementing Classes:
NoOpEncoder, StrictEncoder, SwitchingEncoder
@PublicApi @ExperimentalApi public interface Encoder
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.
Since:
v5.0.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    encodeForHtml(Object input)
    Renders input as HTML.

  • Method Details

    • encodeForHtml

      @Nonnull String encodeForHtml(@Nullable 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