1 /* 2 * Copyright 1999-2004 The Apache Software Foundation 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 12 * implied. 13 * 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.log.format; 18 19 import org.apache.log.LogEvent; 20 21 /** This defines the interface for components that wish to serialize 22 * LogEvents into Strings. 23 * 24 * @author Peter Donald 25 */ 26 public interface Formatter 27 { 28 /** 29 * Serialize log event into string. 30 * 31 * @param event the event 32 * @return the formatted string 33 */ 34 String format( LogEvent event ); 35 } 36