org.jboss.logmanager.ExtFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-logmanager Show documentation
An implementation of java.util.logging.LogManager
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 *
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.jboss.logmanager;

import java.text.MessageFormat;
import java.util.MissingResourceException;
import java.util.Objects;
import java.util.ResourceBundle;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.LogRecord;

/**
 * A formatter which handles {@link org.jboss.logmanager.ExtLogRecord ExtLogRecord} instances.
 */
public abstract class ExtFormatter extends Formatter {
    /**
     * Construct a new instance.
     */
    public ExtFormatter() {
    }

    /**
     * Wrap an existing formatter with an {@link ExtFormatter}, optionally replacing message formatting with
     * the default extended message formatting capability.
     *
     * @param formatter      the formatter to wrap (must not be {@code null})
     * @param formatMessages {@code true} to replace message formatting, {@code false} to let the original formatter do it
     * @return the extended formatter (not {@code null})
     */
    public static ExtFormatter wrap(Formatter formatter, boolean formatMessages) {
        if (formatter instanceof ExtFormatter && !formatMessages) {
            return (ExtFormatter) formatter;
        } else {
            return new WrappedFormatter(formatter, formatMessages);
        }
    }

    /** {@inheritDoc} */
    public final String format(final LogRecord record) {
        return format(ExtLogRecord.wrap(record));
    }

    /**
     * Format a message using an extended log record.
     *
     * @param record the log record
     * @return the formatted message
     */
    public abstract String format(ExtLogRecord record);

    @Override
    public String formatMessage(LogRecord record) {
        final ResourceBundle bundle = record.getResourceBundle();
        String msg = record.getMessage();
        if (msg == null) {
            return null;
        }
        if (bundle != null) {
            try {
                msg = bundle.getString(msg);
            } catch (MissingResourceException ex) {
                // ignore
            }
        }
        final Object[] parameters = record.getParameters();
        if (parameters == null || parameters.length == 0) {
            return formatMessageNone(record);
        }
        if (record instanceof ExtLogRecord) {
            final ExtLogRecord extLogRecord = (ExtLogRecord) record;
            final ExtLogRecord.FormatStyle formatStyle = extLogRecord.getFormatStyle();
            if (formatStyle == ExtLogRecord.FormatStyle.PRINTF) {
                return formatMessagePrintf(record);
            } else if (formatStyle == ExtLogRecord.FormatStyle.NO_FORMAT) {
                return formatMessageNone(record);
            }
        }
        return msg.indexOf('{') >= 0 ? formatMessageLegacy(record) : formatMessageNone(record);
    }

    /**
     * Determines whether or not this formatter will require caller, source level, information when a log record is
     * formatted.
     *
     * @return {@code true} if the formatter will need caller information, otherwise {@code false}
     *
     * @see LogRecord#getSourceClassName()
     * @see ExtLogRecord#getSourceFileName()
     * @see ExtLogRecord#getSourceLineNumber()
     * @see LogRecord#getSourceMethodName()
     */
    public boolean isCallerCalculationRequired() {
        return true;
    }

    /**
     * Format the message text as if there are no parameters. The default implementation delegates to
     * {@link LogRecord#getMessage() record.getMessage()}.
     *
     * @param record the record to format
     * @return the formatted string
     */
    protected String formatMessageNone(LogRecord record) {
        return record.getMessage();
    }

    /**
     * Format the message text as if there are no parameters. The default implementation delegates to
     * {@link MessageFormat#format(String, Object[]) MessageFormat.format(record.getMessage(),record.getParameters())}.
     *
     * @param record the record to format
     * @return the formatted string
     */
    protected String formatMessageLegacy(LogRecord record) {
        return MessageFormat.format(record.getMessage(), record.getParameters());
    }

    /**
     * Format the message text as if there are no parameters. The default implementation delegates to
     * {@link String#format(String, Object[]) String.format(record.getMessage(),record.getParameters())}.
     *
     * @param record the record to format
     * @return the formatted string
     */
    protected String formatMessagePrintf(LogRecord record) {
        return String.format(record.getMessage(), record.getParameters());
    }

    static class WrappedFormatter extends ExtFormatter {
        private final Formatter formatter;
        private final boolean formatMessages;

        WrappedFormatter(Formatter formatter, boolean formatMessages) {
            this.formatter = formatter;
            this.formatMessages = formatMessages;
        }

        @Override
        public String format(ExtLogRecord record) {
            return formatter.format(record);
        }

        @Override
        public String formatMessage(LogRecord record) {
            return formatMessages ? super.formatMessage(record) : formatter.formatMessage(record);
        }

        @Override
        public String getHead(Handler h) {
            return formatter.getHead(h);
        }

        @Override
        public String getTail(Handler h) {
            return formatter.getTail(h);
        }
    }

    /**
     * A base class for formatters which wrap other formatters.
     */
    public abstract static class Delegating extends ExtFormatter {
        /**
         * The delegate formatter.
         */
        protected final ExtFormatter delegate;

        /**
         * Construct a new instance.
         *
         * @param delegate the delegate formatter (must not be {@code null})
         */
        public Delegating(final ExtFormatter delegate) {
            this.delegate = Objects.requireNonNull(delegate, "delegate");
        }

        public String format(final ExtLogRecord record) {
            return delegate.format(record);
        }

        public String formatMessage(final LogRecord record) {
            return delegate.formatMessage(record);
        }

        public boolean isCallerCalculationRequired() {
            return delegate.isCallerCalculationRequired();
        }

        public String getHead(final Handler h) {
            return delegate.getHead(h);
        }

        public String getTail(final Handler h) {
            return delegate.getTail(h);
        }
    }
}