org.apache.log.format.Formatter 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 org.apache.log.LogEvent;

/** This defines the interface for components that wish to serialize
 * LogEvents into Strings.
 *
 * @author Peter Donald
 */
public interface Formatter
{
    /**
     * Serialize log event into string.
     *
     * @param event the event
     * @return the formatted string
     */
    String format( LogEvent event );
}