audit/src/main/java/org/apache/karaf/audit/EventLayout.java

/*
 * 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.karaf.audit;

import java.io.IOException;
import java.nio.CharBuffer;

public interface EventLayout {

    /**
     * Format the log event directly into the given <code>Appendable</code>.
     */
    void format(Event event, Appendable to) throws IOException;

    /**
     * Format the log event and return a CharBuffer.  The buffer is only valid
     * until the next call to {@link #format(Event)} or {@link #format(Event, Appendable)}.
     */
    CharBuffer format(Event event) throws IOException;

}