tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/engine/source/TraceFormattingRule.java
/*
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
*
* Formatting rules are provided by Trace objects
*
*/
package com.nokia.tracecompiler.engine.source;
import com.nokia.tracecompiler.model.Trace;
import com.nokia.tracecompiler.model.TraceObjectRule;
import com.nokia.tracecompiler.plugin.TraceAPIFormatter.TraceFormatType;
/**
* Formatting rules are stored into traces as extension. When inserting a trace
* to source the formatting rules are used to convert the trace into source file
* representation.
*
*/
public interface TraceFormattingRule extends TraceObjectRule {
/**
* Gets the format for given trace
*
* @param trace
* the trace
* @param formatType
* the type of the format requested
* @return the format
*/
public String getFormat(Trace trace, TraceFormatType formatType);
/**
* Maps the trace name to name shown in source
*
* @param trace
* the trace to be mapped
* @return the name shown in source
*/
public String mapNameToSource(Trace trace);
/**
* Maps the parameter count to source.
*
* @param trace
* the trace
* @param count
* the parameter count
* @return mapped parameter count
*/
public String mapParameterCountToSource(Trace trace, int count);
}