001/* 002 * Copyright 2017 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.RetentionPolicy.SOURCE; 021 022import java.lang.annotation.Retention; 023import java.lang.annotation.Target; 024 025/** 026 * The method to which this annotation is applied cannot be called. 027 * 028 * <p>The annotation is applied to methods that are required to satisfy the contract of an 029 * interface, but that are not supported. One example is the implementation of {@link 030 * java.util.Collection#add} in an immutable collection implementation. 031 * 032 * <p>Marking methods annotated with {@code @DoNotCall} as {@code @Deprecated} is recommended, since 033 * it provides IDE users with more immediate feedback. 034 */ 035@Retention(SOURCE) 036@Target(METHOD) 037public @interface DoNotCall { 038 039 /** An optional explanation of why the method should not be called. */ 040 String value() default ""; 041}