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 * <b><u>ITmfEventField</u></b>
18 * The TMF event payload structure. Each field can be either a terminal or
19 * further decomposed into subfields.
21 public interface ITmfEventField
extends Cloneable
{
23 // ------------------------------------------------------------------------
25 // ------------------------------------------------------------------------
28 * The root field id (the main container)
30 public static final String ROOT_FIELD_ID
= ":root:"; //$NON-NLS-1$
32 // ------------------------------------------------------------------------
34 // ------------------------------------------------------------------------
37 * @return the field name
39 public String
getName();
42 * @return the field value
44 public Object
getValue();
47 * @return the list of subfield names (empty if none)
49 public String
[] getFieldNames();
52 * @return the nth field name (null if absent or inexistent)
54 public String
getFieldName(int index
);
57 * @return the list of subfields (null if none)
59 public ITmfEventField
[] getFields();
62 * @return a specific subfield by name (null if absent or inexistent)
64 public ITmfEventField
getField(String name
);
67 * @return a specific subfield by index (null if absent or inexistent)
69 public ITmfEventField
getField(int index
);
71 // ------------------------------------------------------------------------
73 // ------------------------------------------------------------------------
76 * @return a clone of the event type
78 public ITmfEventField
clone();
This page took 0.031944 seconds and 5 git commands to generate.