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 * Trace API parser plug-in

    17 *

    18 */

    19 package com.nokia.tracecompiler.plugin;

    20 

    21 import com.nokia.tracecompiler.engine.TraceLocation;

    22 import com.nokia.tracecompiler.engine.TraceCompilerEngineErrorCodes.TraceCompilerErrorCode;

    23 

    24 /**

    25  * Trace API parser plug-in

    26  * 

    27  */

    28 public interface TraceAPIParser {

    29 

    30 	/**

    31 	 * Gets the tag to be located from source

    32 	 * 

    33 	 * @return the tag

    34 	 */

    35 	public String getSourceTag();

    36 

    37 	/**

    38 	 * Gets the list of suffixes that are allowed with the source tag

    39 	 * 

    40 	 * @return the suffixes

    41 	 */

    42 	public String[] getTagSuffixes();

    43 

    44 	/**

    45 	 * Verifies the validity of given location

    46 	 * 

    47 	 * @param location

    48 	 *            the location to be checked

    49 	 * @return error code from TraceCompilerErrorCodes

    50 	 */

    51 	public TraceCompilerErrorCode checkLocationValidity(TraceLocation location);

    52 

    53 	/**

    54 	 * Gets the name of the group where locations created by this parser belong

    55 	 * 

    56 	 * @return the location group

    57 	 */

    58 	public String getLocationGroup();

    59 

    60 }