Build.java revision f6f9f2d0256930ce0bb4913b2260b8480914edc2 
1/*
2 * Copyright (C) 2007 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 android.os;
18
19/**
20 * Information about the current build, extracted from system properties.
21 */
22public class Build {
23    /** Value used for when a build property is unknown. */
24    private static final String UNKNOWN = "unknown";
25
26    /** Either a changelist number, or a label like "M4-rc20". */
27    public static final String ID = getString("ro.build.id");
28
29    /** A build ID string meant for displaying to the user */
30    public static final String DISPLAY = getString("ro.build.display.id");
31
32    /** The name of the overall product. */
33    public static final String PRODUCT = getString("ro.product.name");
34
35    /** The name of the industrial design. */
36    public static final String DEVICE = getString("ro.product.device");
37
38    /** The name of the underlying board, like "goldfish". */
39    public static final String BOARD = getString("ro.product.board");
40
41    /** The name of the instruction set (CPU type + ABI convention) of native code. */
42    public static final String CPU_ABI = getString("ro.product.cpu.abi");
43
44    /** The manufacturer of the product/hardware. */
45    public static final String MANUFACTURER = getString("ro.product.manufacturer");
46
47    /** The brand (e.g., carrier) the software is customized for, if any. */
48    public static final String BRAND = getString("ro.product.brand");
49
50    /** The end-user-visible name for the end product. */
51    public static final String MODEL = getString("ro.product.model");
52
53    /** Various version strings. */
54    public static class VERSION {
55        /**
56         * The internal value used by the underlying source control to
57         * represent this build.  E.g., a perforce changelist number
58         * or a git hash.
59         */
60        public static final String INCREMENTAL = getString("ro.build.version.incremental");
61
62        /**
63         * The user-visible version string.  E.g., "1.0" or "3.4b5".
64         */
65        public static final String RELEASE = getString("ro.build.version.release");
66
67        /**
68         * The user-visible SDK version of the framework in its raw String
69         * representation; use {@link #SDK_INT} instead.
70         *
71         * @deprecated Use {@link #SDK_INT} to easily get this as an integer.
72         */
73        public static final String SDK = getString("ro.build.version.sdk");
74
75        /**
76         * The user-visible SDK version of the framework; its possible
77         * values are defined in {@link Build.VERSION_CODES}.
78         */
79        public static final int SDK_INT = SystemProperties.getInt(
80                "ro.build.version.sdk", 0);
81
82        /**
83         * The current development codename, or the string "REL" if this is
84         * a release build.
85         */
86        public static final String CODENAME = getString("ro.build.version.codename");
87    }
88
89    /**
90     * Enumeration of the currently known SDK version codes.  These are the
91     * values that can be found in {@link VERSION#SDK}.  Version numbers
92     * increment monotonically with each official platform release.
93     */
94    public static class VERSION_CODES {
95        /**
96         * Magic version number for a current development build, which has
97         * not yet turned into an official release.
98         */
99        public static final int CUR_DEVELOPMENT = 10000;
100
101        /**
102         * October 2008: The original, first, version of Android.  Yay!
103         */
104        public static final int BASE = 1;
105        /**
106         * February 2009: First Android update, officially called 1.1.
107         */
108        public static final int BASE_1_1 = 2;
109        /**
110         * May 2009: Android 1.5.
111         */
112        public static final int CUPCAKE = 3;
113        /**
114         * Current work on "Donut" development branch.
115         *
116         * <p>Applications targeting this or a later release will get these
117         * new changes in behavior:</p>
118         * <ul>
119         * <li> They must explicitly request the
120         * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission to be
121         * able to modify the contents of the SD card.  (Apps targeting
122         * earlier versions will always request the permission.)
123         * <li> They must explicitly request the
124         * {@link android.Manifest.permission#READ_PHONE_STATE} permission to be
125         * able to be able to retrieve phone state info.  (Apps targeting
126         * earlier versions will always request the permission.)
127         * <li> They are assumed to support different screen densities and
128         * sizes.  (Apps targeting earlier versions are assumed to only support
129         * medium density normal size screens unless otherwise indicated).
130         * They can still explicitly specify screen support either way with the
131         * supports-screens manifest tag.
132         * </ul>
133         */
134        public static final int DONUT = 4;
135        /**
136         * Current work on "Eclair" development branch.
137         *
138         * <p>Applications targeting this or a later release will get these
139         * new changes in behavior:</p>
140         * <ul>
141         * <li> The {@link android.app.Service#onStartCommand
142         * Service.onStartCommand} function will return the new
143         * {@link android.app.Service#START_STICKY} behavior instead of the
144         * old compatibility {@link android.app.Service#START_STICKY_COMPATIBILITY}.
145         * </ul>
146         */
147        public static final int ECLAIR = CUR_DEVELOPMENT;
148    }
149
150    /** The type of build, like "user" or "eng". */
151    public static final String TYPE = getString("ro.build.type");
152
153    /** Comma-separated tags describing the build, like "unsigned,debug". */
154    public static final String TAGS = getString("ro.build.tags");
155
156    /** A string that uniquely identifies this build.  Do not attempt to parse this value. */
157    public static final String FINGERPRINT = getString("ro.build.fingerprint");
158
159    // The following properties only make sense for internal engineering builds.
160    public static final long TIME = getLong("ro.build.date.utc") * 1000;
161    public static final String USER = getString("ro.build.user");
162    public static final String HOST = getString("ro.build.host");
163
164    private static String getString(String property) {
165        return SystemProperties.get(property, UNKNOWN);
166    }
167
168    private static long getLong(String property) {
169        try {
170            return Long.parseLong(SystemProperties.get(property));
171        } catch (NumberFormatException e) {
172            return -1;
173        }
174    }
175}
176