1 /* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package androidx.annotation; 17 18 import static java.lang.annotation.ElementType.METHOD; 19 import static java.lang.annotation.RetentionPolicy.CLASS; 20 21 import java.lang.annotation.Retention; 22 import java.lang.annotation.Target; 23 24 /** Stub only annotation. Do not use directly. */ 25 @Retention(CLASS) 26 @Target({METHOD}) 27 public @interface CheckResult { 28 /** 29 * Defines the name of the suggested method to use instead, if applicable (using the same 30 * signature format as javadoc.) If there is more than one possibility, list them all separated 31 * by commas. 32 * 33 * <p>For example, ProcessBuilder has a method named {@code redirectErrorStream()} which sounds 34 * like it might redirect the error stream. It does not. It's just a getter which returns 35 * whether the process builder will redirect the error stream, and to actually set it, you must 36 * call {@code redirectErrorStream(boolean)}. In that case, the method should be defined like 37 * this: 38 * 39 * <pre> 40 * @CheckResult(suggest="#redirectErrorStream(boolean)") 41 * public boolean redirectErrorStream() { ... } 42 * </pre> 43 */ suggest()44 String suggest() default ""; 45 } 46