Package org.teamapps.icons.composite

Class CompositeIconEncoder

java.lang.Object
org.teamapps.icons.composite.CompositeIconEncoder
All Implemented Interfaces:
IconEncoder<CompositeIcon,​java.lang.Void>
public class CompositeIconEncoder
extends java.lang.Object
implements IconEncoder<CompositeIcon,​java.lang.Void>

  • Constructor Summary

    Constructors 
    Constructor Description
    CompositeIconEncoder()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String encodeIcon​(CompositeIcon icon, IconEncoderContext context)
    Creates a string representation of the provided icon.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • encodeIcon

      public java.lang.String encodeIcon​(CompositeIcon icon, IconEncoderContext context)
      Description copied from interface: IconEncoder
      Creates a string representation of the provided icon.

      The string representation may be an arbitrary string, as long as it is an allowed string for URL path segments. It should be safe to use a-z A-Z 0-9 . - _ ~ ! $ ' ( ) * + , ; = : @. If the String contains parenthesis ("(" or ")"), it must make sure to close any opening one of them.

      Note that this method MUST support encoding unstyled icons, i.e. icons that have no style set (null).

      Specified by:
      encodeIcon in interface IconEncoder<CompositeIcon,​java.lang.Void>
      Parameters:
      icon - The icon to encode.
      Returns:
      The encoded icon