[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core / src / org / eclipse / tracecompass / tmf / core / trace / ITmfTraceProperties.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:
 *   Alexandre Montplaisir - Initial API and implementation
 *******************************************************************************/

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

import java.util.Map;

/**
 * Interface for trace types to implement when they can provide additional
 * trace-wide properties.
 *
 * This information will be displayed in the trace's Properties View, among
 * other things.
 *
 * @author Alexandre Montplaisir
 */
public interface ITmfTraceProperties {

    /**
     * Get the properties related to this trace.
     *
     * @return The map of properties, <name, value>
     */
    public Map<String, String> getTraceProperties();
}
Commit	Line	Data
22307af3	1	/*******************************************************************************
ed902a2b	2	* Copyright (c) 2013, 2014 Ericsson
22307af3 AM	3	*
	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
	8	*
	9	* Contributors:
	10	* Alexandre Montplaisir - Initial API and implementation
	11	*******************************************************************************/
	12
2bdf0193	13	package org.eclipse.tracecompass.tmf.core.trace;
22307af3 AM	14
	15	import java.util.Map;
	16
	17	/**
	18	* Interface for trace types to implement when they can provide additional
	19	* trace-wide properties.
	20	*
	21	* This information will be displayed in the trace's Properties View, among
	22	* other things.
	23	*
	24	* @author Alexandre Montplaisir
22307af3 AM	25	*/
	26	public interface ITmfTraceProperties {
	27
	28	/**
	29	* Get the properties related to this trace.
	30	*
	31	* @return The map of properties, <name, value>
	32	*/
	33	public Map<String, String> getTraceProperties();
	34	}