Package org.opennms.features.topology.api.support

Class DefaultIconRepository

java.lang.Object

org.opennms.features.topology.api.support.DefaultIconRepository

All Implemented Interfaces:

ConfigurableIconRepository, IconRepository, org.osgi.service.cm.ManagedService

public class DefaultIconRepository
extends java.lang.Object
implements ConfigurableIconRepository, org.osgi.service.cm.ManagedService

Constructor Summary

Constructors

Constructor	Description
DefaultIconRepository()

Method Summary

Modifier and Type	Method	Description
void	addIconMapping(java.lang.String iconKey, java.lang.String iconId)	Adds a custom icon mapping.
boolean	contains(java.lang.String iconKey)	Verifies if a mapping for the provided icon Key is defined.
java.lang.String	getSVGIconId(java.lang.String iconKey)	Maps the provided iconKey to an SVG id element.
void	removeIconMapping(java.lang.String iconKey)	Removes the given iconKey from this IconRepository.
void	save()	Persists this IconRepository.
void	updated(java.util.Dictionary<java.lang.String,?> properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIconRepository

public DefaultIconRepository()

Method Detail

contains

public boolean contains(java.lang.String iconKey)

Description copied from interface: IconRepository

Verifies if a mapping for the provided icon Key is defined.

Specified by:

contains in interface IconRepository

Parameters:

iconKey - the icon key

Returns:

true if a mapping is defined, false otherwise.

getSVGIconId

public java.lang.String getSVGIconId(java.lang.String iconKey)

Description copied from interface: IconRepository

Maps the provided iconKey to an SVG id element. If no mapping is defined, null is returned.

Specified by:

getSVGIconId in interface IconRepository

Parameters:

iconKey - The icon key to look up

Returns:

The icon id, or null if no mapping is defined.

addIconMapping

public void addIconMapping(java.lang.String iconKey,
                           java.lang.String iconId)

Description copied from interface: ConfigurableIconRepository

Adds a custom icon mapping. The iconKey must be unique in this IconRepository.

Specified by:

addIconMapping in interface ConfigurableIconRepository

Parameters:

iconKey - The icon key

iconId - The icon id for the icon key

removeIconMapping

public void removeIconMapping(java.lang.String iconKey)

Description copied from interface: ConfigurableIconRepository

Removes the given iconKey from this IconRepository.

Specified by:

removeIconMapping in interface ConfigurableIconRepository

Parameters:

iconKey - The icon key to remove

save

public void save()

Description copied from interface: ConfigurableIconRepository

Persists this IconRepository. Should be invoked if changes to this IconRepository should be persisted permanently (e.g. on disk)

Specified by:

save in interface ConfigurableIconRepository

updated

public void updated(java.util.Dictionary<java.lang.String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException