tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/ITmfPinnable.java

/*******************************************************************************
 * Copyright (c) 2016, 2017 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.ui.views;

import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;

/**
 * An interface that adds the pin feature to a view.
 *
 * @since 3.2
 */
public interface ITmfPinnable {

    /**
     * Set the pin state.
     *
     * @param trace
     *            The trace that the view should be pinned to, or null to unpin
     */
    void setPinned(@Nullable ITmfTrace trace);

    /**
     * Gets the trace displayed in the view.
     *
     * @return the trace
     */
    ITmfTrace getTrace();
}