org.jboss.logmanager.log4j.handlers.FormatterLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-logmanager-log4j
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.logmanager.log4j.handlers;

import org.jboss.logmanager.log4j.ConvertedLoggingEvent;

import java.util.logging.Formatter;
import org.apache.log4j.Layout;
import org.apache.log4j.spi.LoggingEvent;

/**
 * An emulator for log4j {@code Layout}s.
 *
 * @author David M. Lloyd
 */
public final class FormatterLayout extends Layout {
    private final Formatter formatter;

    /**
     * Construct a new instance.
     *
     * @param formatter the formatter to delegate to
     */
    public FormatterLayout(final Formatter formatter) {
        this.formatter = formatter;
    }

    /** {@inheritDoc} */
    public String format(final LoggingEvent event) {
        return formatter.format(ConvertedLoggingEvent.getLogRecordFor(event));
    }

    /** {@inheritDoc} */
    public boolean ignoresThrowable() {
        // just be safe
        return false;
    }

    /** {@inheritDoc} */
    public void activateOptions() {
        // options are always activated already
    }
}