org.slf4j.plus.ExceptionLogger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of slf4j-plus Show documentation

SLF4J extended implementation

There is a newer version: 1.7.25.0

/*
 * Copyright 2015-2016 the original author or authors.
 *
 * 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.slf4j.plus;

import org.slf4j.Logger;
import org.slf4j.plus.util.Throwables;

import lombok.NonNull;

/**
 * {@link Logger} for known {@link Exception}
 */
public class ExceptionLogger {
	
	/**
	 * {@link Logger}
	 */
	private Logger delegate;
	
	/**
	 * The max frame length
	 */
	private int maxFrameLength;
	
	/**
	 * Constructor
	 * 
	 * @param delegate {@link Logger}
	 * @param maxFrameLength the max frame length
	 */
	protected ExceptionLogger(@NonNull Logger delegate, int maxFrameLength) {
		
		this.delegate = delegate;
		this.maxFrameLength = maxFrameLength;
	}
	
	/**
	 * Get the log name.
	 * 
	 * @return the log name
	 */
	public String getName() {
		
		return this.delegate.getName();
	}
	
	/**
	 * ERROR
	 * 
	 * @param cause {@link Throwable}
	 */
	public void error(Throwable cause) {
		
		this.delegate.error(this.convert(cause));
	}
	
	/**
	 * WARN
	 * 
	 * @param cause {@link Throwable}
	 */
	public void warn(Throwable cause) {
		
		this.delegate.warn(this.convert(cause));
	}
	
	/**
	 * INFO
	 * 
	 * @param cause {@link Throwable}
	 */
	public void info(Throwable cause) {
		
		this.delegate.info(this.convert(cause));
	}
	
	/**
	 * DEBUG
	 * 
	 * @param cause {@link Throwable}
	 */
	public void debug(Throwable cause) {
		
		this.delegate.debug(this.convert(cause));
	}
	
	/**
	 * TRACE
	 * 
	 * @param cause {@link Throwable}
	 */
	public void trace(Throwable cause) {
		
		this.delegate.trace(this.convert(cause));
	}
	
	/**
	 * Convert {@link Throwable} to the message.
	 * 
	 * @param cause {@link Throwable}
	 * @return the converted message
	 */
	protected String convert(Throwable cause) {
		
		return Log.of("Known exception").value(Throwables.getStackTraceString(cause, this.maxFrameLength));
	}
}