1 /*

     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 * Interface to the properties of the trace API used by the currently open trace project

    17 *

    18 */

    19 package com.nokia.tracebuilder.project;

    20 

    21 import com.nokia.tracebuilder.model.Trace;

    22 import com.nokia.tracebuilder.model.TraceModelExtension;

    23 

    24 /**

    25  * Interface to the properties of the trace API used by the currently open trace

    26  * project

    27  * 

    28  */

    29 public interface TraceProjectAPI extends TraceModelExtension {

    30 

    31 	/**

    32 	 * Formatting flags for formatTraceForExport

    33 	 * 

    34 	 */

    35 	public class TraceFormatFlags {

    36 

    37 		/**

    38 		 * Formatting characters supported flag

    39 		 */

    40 		public boolean isFormattingSupported;

    41 	}

    42 

    43 	/**

    44 	 * Gets the name of this API

    45 	 * 

    46 	 * @return the name

    47 	 */

    48 	public String getName();

    49 

    50 	/**

    51 	 * Gets the title that is shown in the API selection preferences dialog

    52 	 * 

    53 	 * @return the title

    54 	 */

    55 	public String getTitle();

    56 

    57 	/**

    58 	 * Flag which determines if this API is shown in the TraceBuilder

    59 	 * configuration

    60 	 * 

    61 	 * @return the flag

    62 	 */

    63 	public boolean isVisibleInConfiguration();

    64 

    65 	/**

    66 	 * Formats a trace for into a string suitable for export

    67 	 * 

    68 	 * @param trace

    69 	 *            the trace to be formatted

    70 	 * @param flags

    71 	 *            the formatting flags

    72 	 * @return the formatted text

    73 	 */

    74 	public String formatTraceForExport(Trace trace, TraceFormatFlags flags);

    75 

    76 }