1 /*******************************************************************************
2 * Copyright (c) 2009, 2014 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
33 public interface ITmfEventProvider
extends ITmfComponent
{
36 * Queue the request for processing.
38 * @param request The request to process
40 void sendRequest(ITmfEventRequest request
);
43 * Increments/decrements the pending requests counters and fires the request
44 * if necessary (counter == 0). Used for coalescing requests across multiple
48 * Should we increment (true) or decrement (false) the pending
51 void notifyPendingRequest(boolean isIncrement
);
54 * Return the next event based on the context supplied. The context
55 * will be updated for the subsequent read.
57 * @param context the trace read context (updated)
58 * @return the event referred to by context
60 ITmfEvent
getNext(ITmfContext context
);
63 * Gets the parent event provider.
65 * @return the parent event provider or null if no parent.
68 ITmfEventProvider
getParent();
71 * Sets the parent event provider.
76 void setParent(@Nullable ITmfEventProvider parent
);
79 * Adds a child event provider.
82 * a child to add, cannot be null.
84 void addChild(@NonNull ITmfEventProvider child
);
87 * Gets the children event providers.
89 * @return a list of children event providers or an empty list if no
90 * children (return value cannot be null).
93 List
<ITmfEventProvider
> getChildren();
96 * Returns the child event provider with given name.
99 * name of child to find.
100 * @return child event provider or null.
103 ITmfEventProvider
getChild(String name
);
106 * Returns the child event provider for a given index
109 * index of child to get. Prior calling this method the index has
110 * to be verified so that it is within the bounds.
111 * @return child event provider (cannot be null)
114 ITmfEventProvider
getChild(int index
);
117 * Gets children for given class type.
120 * a class type to get
121 * @return a list of children event providers matching a given class type or
122 * an empty list if no children (return value cannot be null).
125 <T
extends ITmfEventProvider
> List
<T
> getChildren(Class
<T
> clazz
);
128 * Gets the number of children
130 * @return number of children
This page took 0.051809 seconds and 6 git commands to generate.