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

import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.spi.LoggingEvent;

import javax.swing.*;


/**
 * A very basic appender that takes the events and stores them in to a
 * ListModel for late retrieval.
 *
 * @author Paul Smith (psmith@apache.org)
 */
public final class ListModelAppender extends AppenderSkeleton {
    /**
     * Default list model.
     */
    private final DefaultListModel<LoggingEvent> model = new DefaultListModel<>();

    /**
     * Constructs a ListModelAppender.
     */
    public ListModelAppender() {
        super(true);
    }

    /**
     * Returns a reference to the ListModel that contains all the LoggingEvents
     * that have been appended to this class.
     *
     * @return the list model
     */
    public ListModel<LoggingEvent> getModel() {
        return model;
    }

    /**
     * {@inheritDoc}
     */
    protected void append(final LoggingEvent event) {
        model.addElement(event);
    }

    /**
     * {@inheritDoc}
     */
    public void close() {
        clearModel();
    }

    /**
     * Removes all the Events from the model.
     */
    public void clearModel() {
        model.clear();
    }

    /**
     * {@inheritDoc}
     */
    public boolean requiresLayout() {
        return false;
    }

}
