Build.java revision d62ad4f120e92fd597f44caf125ac853ac0ea11c 
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 manufacturer of the product/hardware. */
42    public static final String MANUFACTURER = getString("ro.product.manufacturer");
43
44    /** The brand (e.g., carrier) the software is customized for, if any. */
45    public static final String BRAND = getString("ro.product.brand");
46
47    /** The end-user-visible name for the end product. */
48    public static final String MODEL = getString("ro.product.model");
49
50    /** Various version strings. */
51    public static class VERSION {
52        /**
53         * The internal value used by the underlying source control to
54         * represent this build.  E.g., a perforce changelist number
55         * or a git hash.
56         */
57        public static final String INCREMENTAL = getString("ro.build.version.incremental");
58
59        /**
60         * The user-visible version string.  E.g., "1.0" or "3.4b5".
61         */
62        public static final String RELEASE = getString("ro.build.version.release");
63
64        /**
65         * The user-visible SDK version of the framework in its raw String
66         * representation; use {@link #SDK_INT} instead.
67         *
68         * @deprecated Use {@link #SDK_INT} to easily get this as an integer.
69         */
70        public static final String SDK = getString("ro.build.version.sdk");
71
72        /**
73         * The user-visible SDK version of the framework; its possible
74         * values are defined in {@link Build.VERSION_CODES}.
75         */
76        public static final int SDK_INT = SystemProperties.getInt(
77                "ro.build.version.sdk", 0);
78
79        /**
80         * The current development codename, or the string "REL" if this is
81         * a release build.
82         */
83        public static final String CODENAME = getString("ro.build.version.codename");
84    }
85
86    /**
87     * Enumeration of the currently known SDK version codes.  These are the
88     * values that can be found in {@link VERSION#SDK}.  Version numbers
89     * increment monotonically with each official platform release.
90     */
91    public static class VERSION_CODES {
92        /**
93         * Magic version number for a current development build, which has
94         * not yet turned into an official release.
95         */
96        public static final int CUR_DEVELOPMENT = 10000;
97
98        /**
99         * October 2008: The original, first, version of Android.  Yay!
100         */
101        public static final int BASE = 1;
102        /**
103         * February 2009: First Android update, officially called 1.1.
104         */
105        public static final int BASE_1_1 = 2;
106        /**
107         * May 2009: Android 1.5.
108         */
109        public static final int CUPCAKE = 3;
110        /**
111         * Current work on "Donut" development branch.
112         *
113         * <p>Applications targeting this or a later release will get these
114         * new changes in behavior:</p>
115         * <ul>
116         * <li> They must explicitly request the
117         * {@link android.Manifest.permission#WRITE_SDCARD} permission to be
118         * able to modify the contents of the SD card.  (Apps targeting
119         * earlier versions will always request the permission.)
120         * </ul>
121         */
122        public static final int DONUT = CUR_DEVELOPMENT;
123    }
124
125    /** The type of build, like "user" or "eng". */
126    public static final String TYPE = getString("ro.build.type");
127
128    /** Comma-separated tags describing the build, like "unsigned,debug". */
129    public static final String TAGS = getString("ro.build.tags");
130
131    /** A string that uniquely identifies this build.  Do not attempt to parse this value. */
132    public static final String FINGERPRINT = getString("ro.build.fingerprint");
133
134    // The following properties only make sense for internal engineering builds.
135    public static final long TIME = getLong("ro.build.date.utc") * 1000;
136    public static final String USER = getString("ro.build.user");
137    public static final String HOST = getString("ro.build.host");
138
139    private static String getString(String property) {
140        return SystemProperties.get(property, UNKNOWN);
141    }
142
143    private static long getLong(String property) {
144        try {
145            return Long.parseLong(SystemProperties.get(property));
146        } catch (NumberFormatException e) {
147            return -1;
148        }
149    }
150}
151