[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core / src / org / eclipse / tracecompass / tmf / core / event / ITmfCustomAttributes.java

/*******************************************************************************
 * Copyright (c) 2013, 2014 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Simon Delisle - Initial API and implementation
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.core.event;

import java.util.Set;

/**
 * Interface for events to implement to provide information about custom
 * attributes.
 *
 * @author Simon Delisle
 */
public interface ITmfCustomAttributes {

    /**
     * List the custom attributes of this event.
     *
     * @return The list of custom attribute names. Should not be null, but could
     *         be empty.
     */
    Set<String> listCustomAttributes();

    /**
     * Get the value of a custom attribute.
     *
     * @param name
     *            Name of the the custom attribute
     * @return Value of this attribute, or null if there is no attribute with
     *         that name
     */
    String getCustomAttribute(String name);
}
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
	17	/**
	18	* Interface for events to implement to provide information about custom
	19	* attributes.
	20	*
	21	* @author Simon Delisle
860b76d4 SD	22	*/
	23	public interface ITmfCustomAttributes {
	24
	25	/**
	26	* List the custom attributes of this event.
	27	*
	28	* @return The list of custom attribute names. Should not be null, but could
	29	* be empty.
	30	*/
57a2a5ca	31	Set<String> listCustomAttributes();
860b76d4 SD	32
	33	/**
	34	* Get the value of a custom attribute.
	35	*
	36	* @param name
	37	* Name of the the custom attribute
	38	* @return Value of this attribute, or null if there is no attribute with
	39	* that name
	40	*/
57a2a5ca	41	String getCustomAttribute(String name);
860b76d4	42	}