Package org.teamapps.icons.spi

Interface IconDecoder<ICON extends Icon<ICON,​STYLE>,​STYLE>

Type Parameters:
ICON - The icon class this provider will return.
STYLE - The style class these icons support.
All Known Implementing Classes:
CompositeIconDecoder
public interface IconDecoder<ICON extends Icon<ICON,​STYLE>,​STYLE>
Decodes icons from an encoded icon Strings such as they are produced by the IconEncoder.

Implementations MUST provide a default constructor!

  • Method Summary

    Modifier and Type Method Description
    Icon<ICON,​STYLE> decodeIcon​(java.lang.String encodedIconString, IconDecoderContext context)
    Decodes an icon from an encoded icon String.

  • Method Details

    • decodeIcon

      Icon<ICON,​STYLE> decodeIcon​(java.lang.String encodedIconString, IconDecoderContext context)
      Decodes an icon from an encoded icon String.

      Implementations MUST return an icon, even if the requested size is not available. In this case, a larger or smaller icon should be returned. The resizing will be done elsewhere.

      Implementations MUST support unstyled icons.

      Parameters:
      encodedIconString - The encoded icon String as produced by the corresponding IconEncoder.
      Returns:
      The icon.