/*
 * Copyright 2012-2014 Red Hat, Inc.
 * 
 * This file is part of Thermostat.
 * 
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 * 
 * Thermostat 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
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 * 
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 * 
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.client.ui;

import com.redhat.thermostat.annotations.ExtensionPoint;
import com.redhat.thermostat.storage.core.HostRef;
import com.redhat.thermostat.storage.core.Ref;

/**
 * Implementations of this interface have the ability to decorate the specific
 * targets by changing or replacing the target {@link String}. The {@link Ref}
 * is passed to which the label belongs so that implementations can filter or
 * change their behavior according to the reference being passed or its status.
 * 
 * <br /><br />
 * 
 * For example, a decorator may decide to only decorate some specific type of
 * {@link Ref}, like {@link HostRef} that currently don't have an agent
 * connected. The code would then check for the actual type of the reference
 * and check the state before passing on the updated {@link String}.
 */
@ExtensionPoint
public interface ReferenceFieldLabelDecorator extends Decorator {

    /**
     * The passed label my be null, indicating no plugin has set the label so
     * far.
     */
    String getLabel(String originalLabel, Ref reference);
}