Commit | Line | Data |
---|---|---|
6151d86c | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2012, 2014 Ericsson |
6151d86c PT |
3 | * |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Patrick Tasse - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.signal; |
6151d86c | 14 | |
62f62b14 | 15 | import org.eclipse.jdt.annotation.NonNullByDefault; |
2bdf0193 | 16 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
6151d86c PT |
17 | |
18 | /** | |
faa38350 PT |
19 | * Signal indicating a trace is being closed. |
20 | * | |
21 | * Receivers should cancel any jobs, threads or requests for the specified trace | |
22 | * and clear any user interface component related to it as soon as possible. | |
23 | * The trace will be disposed after the signal has been processed. | |
6151d86c | 24 | * |
6151d86c PT |
25 | * @author Patrick Tasse |
26 | */ | |
62f62b14 | 27 | @NonNullByDefault |
6151d86c PT |
28 | public class TmfTraceClosedSignal extends TmfSignal { |
29 | ||
30 | private final ITmfTrace fTrace; | |
31 | ||
32 | /** | |
33 | * Constructor for a new signal | |
34 | * | |
35 | * @param source | |
36 | * The object sending this signal | |
37 | * @param trace | |
38 | * The trace being closed | |
39 | */ | |
40 | public TmfTraceClosedSignal(Object source, ITmfTrace trace) { | |
41 | super(source); | |
42 | fTrace = trace; | |
43 | } | |
44 | ||
45 | /** | |
46 | * Get a reference to the trace being closed | |
47 | * | |
48 | * @return The trace object | |
49 | */ | |
50 | public ITmfTrace getTrace() { | |
51 | return fTrace; | |
52 | } | |
53 | ||
54 | @Override | |
55 | public String toString() { | |
56 | return "[TmfTraceClosedSignal (" + fTrace.getName() + ")]"; //$NON-NLS-1$ //$NON-NLS-2$ | |
57 | } | |
58 | } |