tmf: Update Javadoc throughout tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / signal / TmfTraceOpenedSignal.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 *\r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.signal;\r
\r
import org.eclipse.core.resources.IFile;\r
import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;\r
import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;\r
import org.eclipse.linuxtools.tmf.ui.viewers.events.ITmfEventsFilterProvider;\r
\r
/**\r
 * Signal indicating a trace has been opened.\r
 *\r
 * @version 1.0\r
 * @author Patrick Tasse\r
 */\r
public class TmfTraceOpenedSignal extends TmfSignal {\r
\r
    private final ITmfTrace<?> fTrace;\r
    private final IFile fBookmarksFile;\r
    private final ITmfEventsFilterProvider fEventsFilterProvider;\r
\r
    /**\r
     * Constructor for a new signal.\r
     *\r
     * @param source\r
     *            The object sending this signal\r
     * @param trace\r
     *            The trace that has been opened\r
     * @param bookmarksFile\r
     *            Pointer to the bookmark file\r
     * @param eventsFilterProvider\r
     *            Provider for the event filter in use\r
     */\r
    public TmfTraceOpenedSignal(Object source, ITmfTrace<?> trace,\r
            IFile bookmarksFile, ITmfEventsFilterProvider eventsFilterProvider) {\r
        super(source);\r
        fTrace = trace;\r
        fBookmarksFile = bookmarksFile;\r
        fEventsFilterProvider = eventsFilterProvider;\r
    }\r
\r
    /**\r
     * Get the trace object concerning this signal\r
     *\r
     * @return The trace\r
     */\r
    public ITmfTrace<?> getTrace() {\r
        return fTrace;\r
    }\r
\r
    /**\r
     * Get a pointer to the bookmark file of this trace\r
     *\r
     * @return The IFile object\r
     */\r
    public IFile getBookmarksFile() {\r
        return fBookmarksFile;\r
    }\r
\r
    /**\r
     * Get the events filter provider of this trace\r
     *\r
     * @return The EventsFilterProvider\r
     */\r
    public ITmfEventsFilterProvider getEventsFilterProvider() {\r
        return fEventsFilterProvider;\r
    }\r
\r
    @Override\r
    public String toString() {\r
        return "[TmfTraceOpenedSignal (" + fTrace.getName() + ")]"; //$NON-NLS-1$ //$NON-NLS-2$\r
    }\r
}\r