Commit | Line | Data |
---|---|---|
860b76d4 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2013, 2014 Ericsson |
860b76d4 SD |
3 | * |
4 | * All rights reserved. This program and the accompanying materials are made | |
5 | * 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 | |
8 | * | |
9 | * Contributors: | |
10 | * Simon Delisle - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.event; |
860b76d4 SD |
14 | |
15 | import java.util.Set; | |
16 | ||
4c4e2816 AM |
17 | import org.eclipse.jdt.annotation.NonNullByDefault; |
18 | import org.eclipse.jdt.annotation.Nullable; | |
19 | ||
860b76d4 SD |
20 | /** |
21 | * Interface for events to implement to provide information about custom | |
22 | * attributes. | |
23 | * | |
24 | * @author Simon Delisle | |
860b76d4 | 25 | */ |
4c4e2816 | 26 | @NonNullByDefault |
860b76d4 SD |
27 | public interface ITmfCustomAttributes { |
28 | ||
29 | /** | |
30 | * List the custom attributes of this event. | |
31 | * | |
32 | * @return The list of custom attribute names. Should not be null, but could | |
33 | * be empty. | |
34 | */ | |
57a2a5ca | 35 | Set<String> listCustomAttributes(); |
860b76d4 SD |
36 | |
37 | /** | |
38 | * Get the value of a custom attribute. | |
39 | * | |
40 | * @param name | |
41 | * Name of the the custom attribute | |
42 | * @return Value of this attribute, or null if there is no attribute with | |
43 | * that name | |
44 | */ | |
4c4e2816 | 45 | @Nullable String getCustomAttribute(String name); |
860b76d4 | 46 | } |