1 /*******************************************************************************
2 * Copyright (c) 2014 École Polytechnique de Montréal, Ericsson
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
10 * Geneviève Bastien - Initial API and implementation
11 * Matthew Khouzam - Initial API and implementation
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.core
.trace
;
18 import org
.eclipse
.jdt
.annotation
.NonNull
;
19 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventType
;
22 * This interface should be implemented by all trace classes who have a way to
23 * know in advance what events it may contain. It allows analyses and other
24 * external components to ask the list of events for the trace might contain.
26 * The methods from this interface will typically be called to determine whether
27 * or not it is worth reading a trace. If we can know in advance that a trace
28 * does not contain the events required by an analysis, then the analysis will
29 * not be run. So the response should not involve having to actually read the
32 * @author Geneviève Bastien
33 * @author Matthew Khouzam
35 public interface ITmfTraceWithPreDefinedEvents
{
38 * Return a set of event types declared in the trace, without actually
39 * reading the trace. This method can be called before reading a trace but
40 * after it is initialized, in order to compare this set with a set of
41 * events that a request handles, to determine whether or not it is worth
44 * Some trace types have ways to determine the events that were traced
45 * without having to read the whole trace and this is what this method will
46 * query. The presence of an event in the returned set does not guarantee
47 * that an event with this name actually happened during this trace, only
48 * that it can be there.
50 * The set should be immutable. Destructive set operations should be
51 * performed on a copy of this set.A helper class
52 * {@link TmfEventTypeCollectionHelper} will provide ways of working with
53 * this data structure.
55 * @return The set of events that might be present in the trace
57 @NonNull Set
<@NonNull ?
extends ITmfEventType
> getContainedEventTypes();