core/api/src/main/java/org/onosproject/ui/UiTopoHighlighter.java

/*
 * Copyright 2021-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.ui;

import org.onosproject.ui.topo.Highlights;

/**
 * Abstraction of an entity capable of generating a set of topology highlights
 * for devices, hosts and links.
 */
public interface UiTopoHighlighter {

    /**
     * Returns the self-assigned name of the hilighter.
     *
     * @return highlighter name
     */
    String name();

    /**
     * Generate a set of highlights.
     *
     * @return topology highlights
     */
    Highlights createHighlights();

}