GraphMLIconRepository (OpenNMS 29.0.8 API)

java.lang.Object
- org.opennms.features.topology.plugins.topo.graphml.internal.GraphMLIconRepository

All Implemented Interfaces:

IconRepository
```
public class GraphMLIconRepository
extends Object
implements IconRepository
```
Simple IconRepository for the GraphMLMetaTopologyProvider. It should contain the Set of iconIds defined by all GraphMLTopologyProviders. This enables users to define custom icons (or using already existing icons) by simply defining them in the GraphML file itself. Please note that multiple GraphMLMetaTopologyProvider could define identical GraphMLIconRepositorys. For now this is not relevant. However if the icons should be configurable from the Icon Selection Dialog in the UI, this issue must be addressed.

Author:

mvrueden

Constructor Summary

Constructors
Constructor Description

GraphMLIconRepository(Set<String> knownIconKeys)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`contains(String iconKey)`	Verifies if a mapping for the provided icon Key is defined.
`String`	`getSVGIconId(String iconKey)`	Maps the provided `iconKey` to an SVG id element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphMLIconRepository
```
public GraphMLIconRepository(Set<String> knownIconKeys)
```
- Method Detail
  - contains
```
public boolean contains(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 String getSVGIconId(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.