Commit | Line | Data |
---|---|---|
5179fc01 FC |
1 | /******************************************************************************* |
2 | * Copyright (c) 2012 Ericsson | |
063f0d27 | 3 | * |
5179fc01 FC |
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 | |
063f0d27 | 8 | * |
5179fc01 FC |
9 | * Contributors: |
10 | * Francois Chouinard - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.core.event; | |
14 | ||
15 | /** | |
f7703ed6 | 16 | * The generic event payload in TMF. Each field can be either a terminal or |
4c564a2d | 17 | * further decomposed into subfields. |
063f0d27 | 18 | * |
b9e37ffd FC |
19 | * @version 1.0 |
20 | * @author Francois Chouinard | |
21 | * | |
b9e37ffd | 22 | * @see ITmfEvent |
2848c377 | 23 | * @see ITmfEventType |
5179fc01 | 24 | */ |
0316808c | 25 | public interface ITmfEventField { |
5179fc01 | 26 | |
a4115405 FC |
27 | // ------------------------------------------------------------------------ |
28 | // Constants | |
29 | // ------------------------------------------------------------------------ | |
30 | ||
4c564a2d FC |
31 | /** |
32 | * The root field id (the main container) | |
33 | */ | |
a4115405 | 34 | public static final String ROOT_FIELD_ID = ":root:"; //$NON-NLS-1$ |
085d898f | 35 | |
a4115405 FC |
36 | // ------------------------------------------------------------------------ |
37 | // Getters | |
38 | // ------------------------------------------------------------------------ | |
39 | ||
5179fc01 | 40 | /** |
d7dbf09a | 41 | * @return the field name |
5179fc01 | 42 | */ |
4c564a2d | 43 | public String getName(); |
5179fc01 FC |
44 | |
45 | /** | |
46 | * @return the field value | |
47 | */ | |
48 | public Object getValue(); | |
49 | ||
50 | /** | |
f7703ed6 | 51 | * @return the list of subfield names (empty array if none) |
4c564a2d FC |
52 | */ |
53 | public String[] getFieldNames(); | |
54 | ||
55 | /** | |
063f0d27 | 56 | * @param index The index of the field |
4c564a2d FC |
57 | * @return the nth field name (null if absent or inexistent) |
58 | */ | |
59 | public String getFieldName(int index); | |
60 | ||
61 | /** | |
f7703ed6 | 62 | * @return the list of subfields (empty array if none) |
4c564a2d FC |
63 | */ |
64 | public ITmfEventField[] getFields(); | |
65 | ||
66 | /** | |
063f0d27 | 67 | * @param name The name of the field |
4c564a2d FC |
68 | * @return a specific subfield by name (null if absent or inexistent) |
69 | */ | |
70 | public ITmfEventField getField(String name); | |
71 | ||
72 | /** | |
063f0d27 | 73 | * @param index The index of the field to return |
4c564a2d | 74 | * @return a specific subfield by index (null if absent or inexistent) |
5179fc01 | 75 | */ |
4c564a2d | 76 | public ITmfEventField getField(int index); |
5179fc01 | 77 | |
7636a88e | 78 | /** |
f7703ed6 | 79 | * @return a clone of the event field |
7636a88e | 80 | */ |
cbbcc354 | 81 | public ITmfEventField clone(); |
7636a88e | 82 | |
5179fc01 | 83 | } |