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 * Rule interface for parameters

    17 *

    18 */

    19 package com.nokia.tracecompiler.engine.source;

    20 

    21 import com.nokia.tracecompiler.model.TraceObjectRule;

    22 

    23 /**

    24  * Rule interface for parameters. Each parameter may provide replacement text

    25  * for the %EXT% formatting.

    26  * 

    27  */

    28 public interface TraceParameterFormattingRule extends TraceObjectRule {

    29 

    30 	/**

    31 	 * Determines if this object should be shown in source

    32 	 * 

    33 	 * @return true if shown in source, false otherwise

    34 	 */

    35 	public boolean isShownInSource();

    36 

    37 	/**

    38 	 * Maps parameter name to name shown in source. Note that the original name

    39 	 * passed to this function is not necessarily the name returned by

    40 	 * getOwner().getName()

    41 	 * 

    42 	 * @param originalName

    43 	 *            the original name to be inserted to source

    44 	 * @return the name shown in source

    45 	 */

    46 	public String mapNameToSource(String originalName);

    47 

    48 }