1/*
2 * Copyright (C) 2011 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
17package com.android.inputmethod.compat;
18
19import android.view.textservice.SuggestionsInfo;
20
21import java.lang.reflect.Field;
22
23public final class SuggestionsInfoCompatUtils {
24    // Note that SuggestionsInfo.RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS has been introduced
25    // in API level 15 (Build.VERSION_CODES.ICE_CREAM_SANDWICH_MR1).
26    private static final Field FIELD_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS =
27            CompatUtils.getField(SuggestionsInfo.class, "RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS");
28    private static final Integer OBJ_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS =
29            (Integer) CompatUtils.getFieldValue(null /* receiver */, null /* defaultValue */,
30                    FIELD_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS);
31    private static final int RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS =
32            OBJ_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS != null
33                    ? OBJ_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS : 0;
34
35    private SuggestionsInfoCompatUtils() {
36        // This utility class is not publicly instantiable.
37    }
38
39    /**
40     * Returns the flag value of the attributes of the suggestions that can be obtained by
41     * {@link SuggestionsInfo#getSuggestionsAttributes()}: this tells that the text service thinks
42     * the result suggestions include highly recommended ones.
43     */
44    public static int getValueOf_RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS() {
45        return RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS;
46    }
47}
48