Commit | Line | Data |
---|---|---|
d90ae2a5 RK |
1 | /******************************************************************************* |
2 | * Copyright (c) 2016 Movidius Inc. and others | |
3 | * | |
4 | * All rights reserved. This program and the accompanying materials | |
5 | * are made available under the terms of the Eclipse Public License v1.0 | |
6 | * which accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | *******************************************************************************/ | |
10 | ||
11 | package org.eclipse.tracecompass.tmf.ui.symbols; | |
12 | ||
13 | import org.eclipse.jdt.annotation.NonNull; | |
cb2b5e56 | 14 | import org.eclipse.jdt.annotation.Nullable; |
d90ae2a5 RK |
15 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
16 | ||
17 | /** | |
18 | * Instance of this interface can be contributed using the | |
19 | * <code>org.eclipse.tracecompass.tmf.ui.symbolProvider</code> extension and is | |
20 | * used to create instances of {@link ISymbolProvider} | |
21 | * | |
22 | * @author Robert Kiss | |
23 | * | |
24 | * @since 2.0 | |
25 | */ | |
26 | public interface ISymbolProviderFactory { | |
27 | ||
28 | /** | |
29 | * Create a provider for the given trace. If this factory does not know how | |
30 | * to handle the given trace it will return null; | |
31 | * | |
32 | * @param trace | |
33 | * A non-null trace | |
34 | * @return A newly created provider that can resolve symbols from the given | |
35 | * trace or null if no such provider can be created by this factory | |
36 | */ | |
cb2b5e56 | 37 | @Nullable ISymbolProvider createProvider(@NonNull ITmfTrace trace); |
d90ae2a5 RK |
38 | |
39 | } |