org.apache.rocketmq.shade.org.slf4j.helpers.CheckReturnValue Maven / Gradle / Ivy

package org.apache.rocketmq.shade.org.slf4j.helpers;


import org.apache.rocketmq.shade.org.slf4j.Marker;

import java.lang.annotation.*;

/**
 * Used to annotate methods in the {@link org.apache.rocketmq.shade.org.slf4j.spi.LoggingEventBuilder} interface
 * which return an instance of LoggingEventBuilder (usually as this). Such
 * methods should be followed by one of the terminating log() methods returning
 * void.
 * 
 * IntelliJ IDEA supports a check for annotations named as CheckReturnValue
 * regardless of the containing package. For more information on this feature in IntelliJ IDEA,
 * select File → Setting → Editor → Inspections and then Java → Probable Bugs →
 * Result of method call ignored. 
 * 
 *
 * As for Eclipse, this feature has been requested in
 * bug 572496
 *
 * @author Ceki Gülcü
 * @since 2.0.0-beta1
 */
@Documented
@Target( { ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckReturnValue {
}