001/* 002 * Copyright 2015 The Error Prone Authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package com.google.errorprone.annotations; 018 019import static java.lang.annotation.ElementType.METHOD; 020import static java.lang.annotation.ElementType.TYPE; 021import static java.lang.annotation.RetentionPolicy.SOURCE; 022 023import java.lang.annotation.Documented; 024import java.lang.annotation.Retention; 025import java.lang.annotation.Target; 026 027/** 028 * Indicates that the return value of the annotated method can be safely ignored. 029 * 030 * <p>This is the opposite of {@link CheckReturnValue}. It can be used inside classes or packages 031 * annotated with {@code @CheckReturnValue} to exempt specific methods from the default. 032 */ 033@Documented 034@Target({METHOD, TYPE}) 035@Retention(SOURCE) 036public @interface CanIgnoreReturnValue {}