//----------------------------------------------------------------------
//  LogFormatter.java
//
//  Copyright (c) 2004, 2005 Actuate Corporation.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
//  Actuate Corporation  - initial API and implementation
//
//  LogFormatter is an abstract class from which all formatter classes 
//  should implement.  Formatters format the LogRecords based on 
//  rules that are implemented in format().
//----------------------------------------------------------------------

package org.eclipse.birt.data.oda.util.logging;

/**
 *	<code>LogFormatter</code> is an abstract class from which all 
 *	formatter classes should implement.  It converts <code>LogRecords</code> 
 * 	into formatted strings based on <code>format()</code> rules.
 *  @deprecated	As of BIRT 2.0, replaced by
 * 		{@link org.eclipse.datatools.connectivity.oda.util.logging.LogFormatter} .
 * 		<br>The BIRT ODA run-time framework has been migrated to the 
 * 		Eclipse Data Tools Platform (DTP) project.
 */
public abstract class LogFormatter
{
	/**
	 * Creates a <code>LogFormatter</code> instance.
	 */
    protected LogFormatter()
    {
    }

    /**
     * Format the specified <code>LogRecord</code> into a string.
     * @param record	the log record to format.
     * @return			the formatted string.
     */
    public abstract String format( LogRecord record );
}
