1/*
2 * Copyright (C) 2010 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.resources;
18
19/**
20 * Keyboard state enum.
21 * <p/>This is used in the manifest in the uses-configuration node and in the resource folder names.
22 */
23public enum KeyboardState implements ResourceEnum {
24    EXPOSED("keysexposed", "Exposed", "Exposed keyboard"), //$NON-NLS-1$
25    HIDDEN("keyshidden", "Hidden", "Hidden keyboard"),    //$NON-NLS-1$
26    SOFT("keyssoft", "Soft", "Soft keyboard");          //$NON-NLS-1$
27
28    private final String mValue;
29    private final String mShortDisplayValue;
30    private final String mLongDisplayValue;
31
32    private KeyboardState(String value, String shortDisplayValue, String longDisplayValue) {
33        mValue = value;
34        mShortDisplayValue = shortDisplayValue;
35        mLongDisplayValue = longDisplayValue;
36    }
37
38    /**
39     * Returns the enum for matching the provided qualifier value.
40     * @param value The qualifier value.
41     * @return the enum for the qualifier value or null if no matching was found.
42     */
43    public static KeyboardState getEnum(String value) {
44        for (KeyboardState state : values()) {
45            if (state.mValue.equals(value)) {
46                return state;
47            }
48        }
49
50        return null;
51    }
52
53    @Override
54    public String getResourceValue() {
55        return mValue;
56    }
57
58    @Override
59    public String getShortDisplayValue() {
60        return mShortDisplayValue;
61    }
62
63    @Override
64    public String getLongDisplayValue() {
65        return mLongDisplayValue;
66    }
67
68    public static int getIndex(KeyboardState value) {
69        int i = 0;
70        for (KeyboardState input : values()) {
71            if (value == input) {
72                return i;
73            }
74
75            i++;
76        }
77
78        return -1;
79    }
80
81    public static KeyboardState getByIndex(int index) {
82        int i = 0;
83        for (KeyboardState value : values()) {
84            if (i == index) {
85                return value;
86            }
87            i++;
88        }
89        return null;
90    }
91
92    @Override
93    public boolean isFakeValue() {
94        return false;
95    }
96
97    @Override
98    public boolean isValidValueForDevice() {
99        return true;
100    }
101
102}
103