src/main/java/org/apache/log4j/chainsaw/color/Colorizer.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.log4j.chainsaw.color;

import java.awt.Color;
import org.apache.log4j.chainsaw.logevents.ChainsawLoggingEvent;

/**
 * Given a LoggingEvent, can determine an appropriate
 * Color to use based on whatever this implementation
 * has been coded.
 *
 * @author Paul Smith <psmith@apache.org>
 * @author Scott Deboy <sdeboy@apache.org>
 */
public interface Colorizer {
    /**
     * Given a LoggingEvent, returns a Color to use for background,
     * or null if this instance cannot determine one, or that
     * the standard color should be used.
     *
     * @param event the ChainsawLoggingEvent
     * @return background color or null
     */
    Color getBackgroundColor(ChainsawLoggingEvent event);

    Color getForegroundColor(ChainsawLoggingEvent event);
}