Package io.jenkins.plugins.fontawesome

Class FontAwesomeIcons

java.lang.Object

io.jenkins.plugins.fontawesome.FontAwesomeIcons

public final class FontAwesomeIcons
extends Object

Utility to work with icons provided by the font-awesome-api-plugin.

Author:

strangelookingnerd

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	getAvailableIcons()	Get all available icons provided by the font-awesome-api-plugin.
static Map<String,String>	getAvailableIcons(SvgTag.FontAwesomeStyle filter)	Get all available icons provided by the font-awesome-api-plugin filtered by their style.
static String	getIconClassName(String icon)	Takes an icon name and generates an icon class name from it.

Methods inherited from class java.lang.Object

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

Method Details

getIconClassName

public static String getIconClassName(String icon)

Takes an icon name and generates an icon class name from it.

Parameters:

icon - the icon name

Returns:

the icon class name

getAvailableIcons

public static Map<String,String> getAvailableIcons()

Get all available icons provided by the font-awesome-api-plugin.

Returns:

a sorted map of available icons with icon name as key and the icon class name as value.

getAvailableIcons

public static Map<String,String> getAvailableIcons(@CheckForNull
 SvgTag.FontAwesomeStyle filter)

Get all available icons provided by the font-awesome-api-plugin filtered by their style.

Parameters:

filter - the style to filter

Returns:

a sorted map of available icons with icon name as key and the icon class name as value filtered by the given style.