1 /*******************************************************************************
2 * Copyright (c) 2009, 2015 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 * Francois Chouinard - Initial API and implementation
11 * Bernd Hufmann - Added APIs for composite event providers
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.core
.component
;
16 import java
.util
.List
;
18 import org
.eclipse
.jdt
.annotation
.NonNull
;
19 import org
.eclipse
.jdt
.annotation
.Nullable
;
20 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
21 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
;
22 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
25 * This is the interface of the data providers in TMF. Data providers have the
26 * capability of handling data requests.
28 * @author Francois Chouinard
30 * @see TmfEventProvider
32 public interface ITmfEventProvider
extends ITmfComponent
{
35 * Queue the request for processing.
37 * @param request The request to process
39 void sendRequest(ITmfEventRequest request
);
42 * Increments/decrements the pending requests counters and fires the request
43 * if necessary (counter == 0). Used for coalescing requests across multiple
47 * Should we increment (true) or decrement (false) the pending
50 void notifyPendingRequest(boolean isIncrement
);
53 * Return the next event based on the context supplied. The context
54 * will be updated for the subsequent read.
56 * @param context the trace read context (updated)
57 * @return the event referred to by context
59 ITmfEvent
getNext(ITmfContext context
);
62 * Gets the parent event provider.
64 * @return the parent event provider or null if no parent.
67 ITmfEventProvider
getParent();
70 * Sets the parent event provider.
75 void setParent(@Nullable ITmfEventProvider parent
);
78 * Adds a child event provider.
81 * a child to add, cannot be null.
83 void addChild(@NonNull ITmfEventProvider child
);
86 * Gets the children event providers.
88 * @return a list of children event providers or an empty list if no
89 * children (return value cannot be null).
92 List
<ITmfEventProvider
> getChildren();
95 * Returns the child event provider with given name.
98 * name of child to find.
99 * @return child event provider or null.
102 ITmfEventProvider
getChild(String name
);
105 * Returns the child event provider for a given index
108 * index of child to get. Prior calling this method the index has
109 * to be verified so that it is within the bounds.
110 * @return child event provider (cannot be null)
113 ITmfEventProvider
getChild(int index
);
116 * Gets children for given class type.
119 * a class type to get
120 * @return a list of children event providers matching a given class type or
121 * an empty list if no children (return value cannot be null).
124 <T
extends ITmfEventProvider
> List
<T
> getChildren(Class
<T
> clazz
);
127 * Gets the number of children
129 * @return number of children
This page took 0.034848 seconds and 5 git commands to generate.