Interface IconEncoder<ICON extends Icon<ICON,?>>
-
- Type Parameters:
ICON- The icon class this encoder can handle.
- All Known Implementing Classes:
CompositeIconEncoder
public interface IconEncoder<ICON extends Icon<ICON,?>>Responsible for creatingStringrepresentations for icons. These strings will get parsed by the correspondingIconDecoder.A 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.Implementations MUST be able to encode unstyled icons, i.e. icons that have no style set (null).
Implementations MUST provide a default constructor!
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringencodeIcon(ICON icon, IconEncoderContext context)Creates a string representation of the provided icon.
-
-
-
Method Detail
-
encodeIcon
java.lang.String encodeIcon(ICON icon, IconEncoderContext context)
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).
- Parameters:
icon- The icon to encode.context-- Returns:
- The encoded icon
-
-