/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2016 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2016 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.features.topology.api;

import java.util.List;

import org.opennms.features.topology.api.topo.Vertex;

public interface IconManager {

    IconRepository findRepositoryByIconKey(String iconKey);

    /**
     * Returns the list of available svg-files, e.g. 'theme://svg/file.svg'
     * @return the list of available svg-files, e.g. 'theme://svg/file.svg'
     */
    List<String> getSVGIconFiles();

    String getSVGIconId(String iconKey);

    String getSVGIconId(Vertex vertex);

    String setIconMapping(Vertex vertex, String newIconId);

    boolean removeIconMapping(Vertex vertex);
}

@@ -1350,16 +1350,411 @@
 ager %7B%0A%0A
+    /**%0A     * Returns the first %7B@link IconRepository%7D which has the provided %3Ccode%3EiconKey%3C/code%3E mapping defined.%0A     *%0A     * @param iconKey the %3Ccode%3EiconKey%3C/code%3E to look up%0A     * @return the first %7B@link IconRepository%7D which has the provided %3Ccode%3EiconKey%3C/code%3E mapping defined, or %3Ccode%3Enull%3C/code%3E if no %7B@link IconRepository%7D exists with the provided %3Ccode%3EiconKey%3C/code%3E%0A     */%0A
     Icon
@@ -1885,24 +1885,32 @@
 vg/file.svg'
+.%0A     *
 %0A     * @ret
@@ -2027,147 +2027,1245 @@
     
-String getSVGIconId(String iconKey);%0A%0A    String getSVGIconId(Vertex vertex);%0A%0A    String setIconMapping(Vertex vertex, String newIconId);%0A
+/**%0A     * Returns the icon id assigned to the provided %3Ccode%3EiconKey%3C/code%3E.%0A     *%0A     * @param iconKey the %3Ccode%3EiconKey%3C/code%3E to look up%0A     * @return the icon id assigned to the provided %3Ccode%3EiconKey%3C/code%3E%0A     */%0A    String getSVGIconId(String iconKey);%0A%0A    /**%0A     * Returns the icon id assigned to the provided %7B@link Vertex%7D.%0A     *%0A     * @param vertex the vertex to get the icon id for%0A     * @return the icon id assigned to the provided %7B@link Vertex%7D%0A     */%0A    String getSVGIconId(Vertex vertex);%0A%0A    /**%0A     * Sets a new icon mapping from the %7B@link Vertex%7D to the %3Ccode%3EnewIconId%3C/code%3E.%0A     *%0A     * @param vertex the vertex to map%0A     * @param newIconId the icon id to map the vertex to%0A     * @return the icon key of the vertex if this %7B@link IconManager%7D was able to save the mapping, null otherwise%0A     */%0A    String setIconMapping(Vertex vertex, String newIconId);%0A%0A    /**%0A     * Removes the icon mapping for the %7B@link Vertex%7D if defined.%0A     *%0A     * @param vertex the %7B@link Vertex%7D to remove the icon mapping for%0A     * @return %3Ccode%3Etrue%3C/code%3E if the mapping was removed, %3Ccode%3Efalse%3C/code%3E if no icon mapping was found for the provided %7B@link Vertex%7D and therefore could not be removed%0A     */
 %0A   

Update javadoc for the IconManager