@PublicApi public interface

HeaderSeparatorService

com.atlassian.jira.image.separator.HeaderSeparatorService
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

A service for creating a colourful header separators. These are not cached so the client shoud do its own caching.

Summary

Public Methods
byte[] getSeparator(String colorHex, String backgroundColorHex)
Get the bytes for a separator image for the given colours.

Public Methods

public byte[] getSeparator (String colorHex, String backgroundColorHex)

Get the bytes for a separator image for the given colours. Allows for easy streaming.

Input strings can ontain a leading hash (#) and can be a 3 char or 6 char hex string. See any web tutorial for what colour the string represents. If hex colors are wrong, default colours are returned. Black arrow and a transparent white background.

Parameters
colorHex The main color of the separator
backgroundColorHex The background colour of the separator. This will also be transparent. Useful for IE6
Returns
  • An array of bytes representing an image.