com.jcabi.aspects.aj.QuietExceptionsLogger Maven / Gradle / Ivy
Show all versions of jcabi-aspects Show documentation
/*
* Copyright (c) 2012-2024, jcabi.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the jcabi.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jcabi.aspects.aj;
import com.jcabi.aspects.Immutable;
import com.jcabi.log.Logger;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
/**
* Logs all exceptions thrown out of a method and swallow exception.
*
* @since 0.1.10
* @see com.jcabi.aspects.LogExceptions
* @checkstyle IllegalThrows (100 lines)
* @checkstyle NonStaticMethodCheck (100 lines)
*/
@Aspect
@Immutable
public final class QuietExceptionsLogger {
/**
* Catch exception and log it, the exception will be swallowed.
*
* This aspect should be used only on void returning methods.
*
*
Try NOT to change the signature of this method, in order to keep
* it backward compatible.
*
* @param point Joint point
* @return The result of call
*/
@Around
(
// @checkstyle StringLiteralsConcatenation (2 lines)
"execution(* * (..))"
+ " && @annotation(com.jcabi.aspects.Quietly)"
)
@SuppressWarnings("PMD.AvoidCatchingThrowable")
public Object wrap(final ProceedingJoinPoint point) {
if (!((MethodSignature) point.getSignature()).getReturnType()
.equals(Void.TYPE)) {
throw new IllegalStateException(
String.format(
"%s: Return type is not void, cannot use @Quietly",
Mnemos.toText(point, true, true)
)
);
}
Object result = null;
try {
result = point.proceed();
// @checkstyle IllegalCatch (1 line)
} catch (final Throwable ex) {
Logger.warn(
new ImprovedJoinPoint(point).targetize(),
"%[exception]s",
ex
);
}
return result;
}
}