tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/project/TraceProjectAPI.java
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
parent 41 tracefw/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/project/TraceProjectAPI.java@838cdffd57ce
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
41
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
* Interface to the properties of the trace API used by the currently open trace project
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
package com.nokia.tracecompiler.project;
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
import com.nokia.tracecompiler.model.Trace;
hgs
parents:
diff changeset
    22
import com.nokia.tracecompiler.model.TraceModelExtension;
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
/**
hgs
parents:
diff changeset
    25
 * Interface to the properties of the trace API used by the currently open trace
hgs
parents:
diff changeset
    26
 * project
hgs
parents:
diff changeset
    27
 * 
hgs
parents:
diff changeset
    28
 */
hgs
parents:
diff changeset
    29
public interface TraceProjectAPI extends TraceModelExtension {
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
	/**
hgs
parents:
diff changeset
    32
	 * Formatting flags for formatTraceForExport
hgs
parents:
diff changeset
    33
	 */
hgs
parents:
diff changeset
    34
	public class TraceFormatFlags {
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
		/**
hgs
parents:
diff changeset
    37
		 * Formatting characters supported flag
hgs
parents:
diff changeset
    38
		 */
hgs
parents:
diff changeset
    39
		public boolean isFormattingSupported;
hgs
parents:
diff changeset
    40
	}
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
	/**
hgs
parents:
diff changeset
    43
	 * Gets the name of this API
hgs
parents:
diff changeset
    44
	 * 
hgs
parents:
diff changeset
    45
	 * @return the name
hgs
parents:
diff changeset
    46
	 */
hgs
parents:
diff changeset
    47
	public String getName();
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
	/**
hgs
parents:
diff changeset
    50
	 * Formats a trace for into a string suitable for export
hgs
parents:
diff changeset
    51
	 * 
hgs
parents:
diff changeset
    52
	 * @param trace
hgs
parents:
diff changeset
    53
	 *            the trace to be formatted
hgs
parents:
diff changeset
    54
	 * @param flags
hgs
parents:
diff changeset
    55
	 *            the formatting flags
hgs
parents:
diff changeset
    56
	 * @return the formatted text
hgs
parents:
diff changeset
    57
	 */
hgs
parents:
diff changeset
    58
	public String formatTraceForExport(Trace trace, TraceFormatFlags flags);
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
}