1 /*******************************************************************************
2 * Copyright (c) 2012 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 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.event
;
16 * The generic event payload in TMF. Each field can be either a terminal or
17 * further decomposed into subfields.
20 * @author Francois Chouinard
25 public interface ITmfEventField
{
27 // ------------------------------------------------------------------------
29 // ------------------------------------------------------------------------
32 * The root field id (the main container)
34 public static final String ROOT_FIELD_ID
= ":root:"; //$NON-NLS-1$
36 // ------------------------------------------------------------------------
38 // ------------------------------------------------------------------------
41 * @return the field name
43 public String
getName();
46 * @return the field value
48 public Object
getValue();
51 * @return the list of subfield names (empty array if none)
53 public String
[] getFieldNames();
56 * @param index The index of the field
57 * @return the nth field name (null if absent or inexistent)
59 public String
getFieldName(int index
);
62 * @return the list of subfields (empty array if none)
64 public ITmfEventField
[] getFields();
67 * @param name The name of the field
68 * @return a specific subfield by name (null if absent or inexistent)
70 public ITmfEventField
getField(String name
);
73 * @param index The index of the field to return
74 * @return a specific subfield by index (null if absent or inexistent)
76 public ITmfEventField
getField(int index
);
79 * @return a clone of the event field
81 public ITmfEventField
clone();
This page took 0.035708 seconds and 5 git commands to generate.