stub-annotations/src/main/java/androidx/annotation/CheckResult.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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 androidx.annotation;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.CLASS;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/** Stub only annotation. Do not use directly. */
@Retention(CLASS)
@Target({METHOD})
public @interface CheckResult {
    /**
     * Defines the name of the suggested method to use instead, if applicable (using the same
     * signature format as javadoc.) If there is more than one possibility, list them all separated
     * by commas.
     *
     * <p>For example, ProcessBuilder has a method named {@code redirectErrorStream()} which sounds
     * like it might redirect the error stream. It does not. It's just a getter which returns
     * whether the process builder will redirect the error stream, and to actually set it, you must
     * call {@code redirectErrorStream(boolean)}. In that case, the method should be defined like
     * this:
     *
     * <pre>
     *  &#64;CheckResult(suggest="#redirectErrorStream(boolean)")
     *  public boolean redirectErrorStream() { ... }
     * </pre>
     */
    String suggest() default "";
}