View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.log4j.chainsaw.color;
    19
    20  import org.apache.log4j.spi.LoggingEvent;
    21
    22  import java.awt.Color;
    23
    24
    25  /**
    26   * Given a LoggingEvent, can determine an appropriate
    27   * Color to use based on whatever this implementation
    28   * has been coded.
    29   *
    30   * @author Paul Smith &lt;psmith@apache.org&gt;
    31   * @author Scott Deboy &lt;sdeboy@apache.org&gt;
    32   */
    33  public interface Colorizer {
    34    /**
    35     * Given a LoggingEvent, returns a Color to use for background,
    36     * or null if this instance cannot determine one, or that
    37     * the stanard color should be used.
    38     * @param event
    39     * @return background color
    40     */
    41    public Color getBackgroundColor(LoggingEvent event);
    42
    43    public Color getForegroundColor(LoggingEvent event);
    44  }