Class CompositeIconEncoder

java.lang.Object

org.teamapps.icons.composite.CompositeIconEncoder

All Implemented Interfaces:

IconEncoder<CompositeIcon>

public class CompositeIconEncoder
extends Object
implements IconEncoder<CompositeIcon>

Constructor Summary

Constructors

Constructor	Description
CompositeIconEncoder()

Method Summary

Modifier and Type	Method	Description
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

CompositeIconEncoder

public CompositeIconEncoder()

Method Details

encodeIcon

public 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>

Parameters:

icon - The icon to encode.

context -

Returns:

The encoded icon