org.jboss.logging.annotations.Suppressed Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
*
* Copyright 2023 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.logging.annotations;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.CLASS;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Indicates the parameter should be added as a {@linkplain Throwable#addSuppressed(Throwable) suppressed} exception to
* the returned exception.
*
* The annotated parameter can be a single {@linkplain Throwable throwable type}, an array of
* {@linkplain Throwable throwable types} or a {@linkplain java.util.Collection collection} of
* {@linkplain Throwable throwable types}. Note this is only allowed on message bundle methods that return a
* {@linkplain Throwable throwable type}.
*
*
* @author James R. Perkins
*/
@Retention(CLASS)
@Target(PARAMETER)
@Documented
public @interface Suppressed {
}