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