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;
    19
    20  import java.util.EventListener;
    21  import java.util.List;
    22
    23
    24  /**
    25   * Implementations of this interface like to be notified
    26   * of arriving batches of LoggingEvents, but may only
    27   * be interested in those coming from a particular source
    28   *
    29   * @author Paul Smith &lt;psmith@apache.org&gt;
    30   */
    31  public interface EventBatchListener extends EventListener {
    32      /**
    33       * Returns the string representing the identifier
    34       * that this instance is only interested in, or
    35       * null if this instance is interested in ALL events from
    36       * any identifier
    37       *
    38       * @return String identifier of the interested source
    39       */
    40      String getInterestedIdentifier();
    41
    42      /**
    43       * Implementations receive a list of LoggingEvent instances only if they are interested,
    44       * that is, if the source of the eventBatch matches this instances interested identifier
    45       *
    46       * @param events     List of LoggingEvent instances
    47       * @param identifier the identifier this list of LoggingEvents is associated with
    48       */
    49      void receiveEventBatch(String identifier, List<org.apache.log4j.spi.LoggingEvent> events);
    50  }