1 /*******************************************************************************
2 * Copyright (c) 2012, 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 * Alexandre Montplaisir - Removed arrays from the API
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.core
.event
;
16 import java
.util
.Collection
;
18 import org
.eclipse
.jdt
.annotation
.NonNull
;
21 * The generic event payload in TMF. Each field can be either a terminal or
22 * further decomposed into subfields.
25 * @author Francois Chouinard
30 public interface ITmfEventField
{
32 // ------------------------------------------------------------------------
34 // ------------------------------------------------------------------------
37 * The root field id (the main container)
39 public static final @NonNull String ROOT_FIELD_ID
= ":root:"; //$NON-NLS-1$
41 // ------------------------------------------------------------------------
43 // ------------------------------------------------------------------------
46 * @return the field name
51 * @return the field value
56 * @return the value formatted as string
59 String
getFormattedValue();
62 * Return the subfield names. The iteration order is the same as
63 * {@link #getFields()}. The returned Collection is immutable.
65 * @return The subfield names (empty Collection if none)
68 Collection
<String
> getFieldNames();
71 * Return the subfield. The iteration order is the same as
72 * {@link #getFieldNames()}. The returned Collection is immutable.
74 * @return The subfields (empty Collection if none)
77 Collection
<?
extends ITmfEventField
> getFields();
80 * @param name The name of the field
81 * @return a specific subfield by name (null if absent or inexistent)
83 ITmfEventField
getField(String name
);
86 * Gets the a sub-field of this field, which may be multiple levels down.
89 * Array of field names to recursively go through
90 * @return The field at the end, or null if a field in the path cannot be
94 ITmfEventField
getSubField(String
... path
);
This page took 0.032747 seconds and 5 git commands to generate.