com.anrisoftware.globalpom.log.AbstractLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalpom-log Show documentation
Logger factory to inject a logger for a class.
The newest version!
/*
 * Copyright 2011-2025 Erwin Müller 
 *
 * 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 com.anrisoftware.globalpom.log;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Base class for a {@link Logger}.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public abstract class AbstractLogger implements Externalizable {

    protected transient Logger log;

    private Class contextClass;

    /**
     * For serialization.
     */
    public AbstractLogger() {
    }

    /**
     * Creates a new {@link Logger} for the given context {@link Class}.
     */
    protected AbstractLogger(@SuppressWarnings("rawtypes") Class contextClass) {
        this.log = LoggerFactory.getLogger(contextClass);
        this.contextClass = contextClass;
    }

    /**
     * Log the specified exception.
     *
     * @param ex      the {@link Throwable}.
     *
     * @param message the message of the exception.
     *
     * @param args    optional arguments for the message.
     *
     * @param          the exception type.
     *
     * @return the {@link Throwable}.
     *
     * @since 1.12
     */
    protected  T logException(T ex, String message, Object... args) {
        if (log.isDebugEnabled()) {
            log.error(ex.getMessage(), ex);
        } else {
            log.error(message, args);
        }
        return ex;
    }

    /**
     * @see #logException(Throwable, String, Object...)
     *
     * @since 1.13.1
     */
    protected  T logException(T ex, Object message, Object... args) {
        return logException(ex, message.toString(), args);
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException {
        out.writeObject(contextClass);
        out.flush();
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
        contextClass = (Class) in.readObject();
        log = LoggerFactory.getLogger(contextClass);
    }

    /**
     * Returns the parent logger.
     *
     * @return the {@link Logger}.
     *
     * @since 1.19
     */
    public Logger getLog() {
        return log;
    }

    /**
     * @see Logger#isTraceEnabled()
     *
     * @since 1.14
     */
    public boolean isTraceEnabled() {
        return log.isTraceEnabled();
    }

    /**
     * @see Logger#trace(String, Object...)
     *
     * @since 1.14
     */
    public void trace(Object format, Object... arguments) {
        if (log.isTraceEnabled()) {
            log.trace(format.toString(), arguments);
        }
    }

    /**
     * @see Logger#isDebugEnabled()
     *
     * @since 1.14
     */
    public boolean isDebugEnabled() {
        return log.isDebugEnabled();
    }

    /**
     * @see Logger#debug(String, Object...)
     *
     * @since 1.14
     */
    public void debug(Object format, Object... arguments) {
        if (log.isDebugEnabled()) {
            log.debug(format.toString(), arguments);
        }
    }

    /**
     * @see Logger#isInfoEnabled()
     *
     * @since 1.14
     */
    public boolean isInfoEnabled() {
        return log.isInfoEnabled();
    }

    /**
     * @see Logger#info(String, Object...)
     *
     * @since 1.14
     */
    public void info(Object format, Object... arguments) {
        if (log.isInfoEnabled()) {
            log.info(format.toString(), arguments);
        }
    }

    /**
     * @see Logger#isWarnEnabled()
     *
     * @since 1.14
     */
    public boolean isWarnEnabled() {
        return log.isWarnEnabled();
    }

    /**
     * @see Logger#warn(String, Object...)
     *
     * @since 1.14
     */
    public void warn(Object format, Object... arguments) {
        if (log.isWarnEnabled()) {
            log.warn(format.toString(), arguments);
        }
    }

    /**
     * @see Logger#isErrorEnabled()
     *
     * @since 1.14
     */
    public boolean isErrorEnabled() {
        return log.isErrorEnabled();
    }

    /**
     * @see Logger#error(String, Object...)
     *
     * @since 1.14
     */
    public void error(Object format, Object... arguments) {
        if (log.isErrorEnabled()) {
            log.error(format.toString(), arguments);
        }
    }

}