org.apache.log.format.XMLFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avalon-logkit Show documentation
Excalibur's Logkit package
The newest version!
/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed  under the  License is distributed on an "AS IS" BASIS,
 * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
 * implied.
 * 
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.log.format;

import java.util.Date;
import org.apache.log.LogEvent;

/**
 * Basic XML formatter that writes out a basic XML-ified log event.
 *
 * Note that this formatter assumes that the category and context
 * values will produce strings that do not need to be escaped in XML.
 *
 * @author Peter Donald
 */
public class XMLFormatter
    implements Formatter
{
    private static final String EOL = System.getProperty( "line.separator", "\n" );

    //Booleans indicating whether or not we
    //print out a particular field
    private boolean m_printTime = true;
    private boolean m_printRelativeTime = false;
    private boolean m_printPriority = true;
    private boolean m_printCategory = true;
    
    // This can't be changed to 'true' until the Testcases have been fixed
    // 
    private boolean m_printContext = false;
    
    
    private boolean m_printMessage = true;
    private boolean m_printException = true;

    private boolean m_printNumericTime = true;

    /**
     * Print out time field to log.
     *
     * @param printTime true to print time, false otherwise
     */
    public void setPrintTime( final boolean printTime )
    {
        m_printTime = printTime;
    }

    /**
     * Print out relativeTime field to log.
     *
     * @param printRelativeTime true to print relativeTime, false otherwise
     */
    public void setPrintRelativeTime( final boolean printRelativeTime )
    {
        m_printRelativeTime = printRelativeTime;
    }

    /**
     * Print out priority field to log.
     *
     * @param printPriority true to print priority, false otherwise
     */
    public void setPrintPriority( final boolean printPriority )
    {
        m_printPriority = printPriority;
    }

    /**
     * Print out category field to log.
     *
     * @param printCategory true to print category, false otherwise
     */
    public void setPrintCategory( final boolean printCategory )
    {
        m_printCategory = printCategory;
    }

    /**
     * Print out context field to log.
     *
     * @param printContext true to print context, false otherwise
     */
    public void setPrintContext( final boolean printContext )
    {
        m_printContext = printContext;
    }

    /**
     * Print out message field to log.
     *
     * @param printMessage true to print message, false otherwise
     */
    public void setPrintMessage( final boolean printMessage )
    {
        m_printMessage = printMessage;
    }

    /**
     * Print out exception field to log.
     *
     * @param printException true to print exception, false otherwise
     */
    public void setPrintException( final boolean printException )
    {
        m_printException = printException;
    }

    /**
     * Format log event into string.
     *
     * @param event the event
     * @return the formatted string
     */
    public String format( final LogEvent event )
    {
        final StringBuffer sb = new StringBuffer( 400 );

        sb.append( "" );
        sb.append( EOL );

        if( m_printTime )
        {
            sb.append( "  " );

            if( m_printNumericTime )
            {
                sb.append( event.getTime() );
            }
            else
            {
                sb.append( new Date( event.getTime() ) );
            }

            sb.append( "" );
            sb.append( EOL );
        }

        if( m_printRelativeTime )
        {
            sb.append( "  " );
            sb.append( event.getRelativeTime() );
            sb.append( "" );
            sb.append( EOL );
        }

        if( m_printPriority )
        {
            sb.append( "  " );
            sb.append( event.getPriority().getName() );
            sb.append( "" );
            sb.append( EOL );
        }

        if( m_printCategory )
        {
            sb.append( "  " );
            sb.append( event.getCategory() );
            sb.append( "" );
            sb.append( EOL );
        }

        if( m_printContext && null != event.getContextMap() )
        {
            sb.append( "  " );
            sb.append( event.getContextMap() );
            sb.append( "" );
            sb.append( EOL );
        }

        if( m_printMessage && null != event.getMessage() )
        {
            sb.append( "  " );
            sb.append( EOL );
        }

        if( m_printException && null != event.getThrowable() )
        {
            sb.append( "  " );
            sb.append( EOL );
        }

        sb.append( "" );
        sb.append( EOL );

        return sb.toString();
    }
}