ApplicationInfo.java revision a8675f67e33bc7337d148358783b0fd138b501ff 
1package android.content.pm;
2
3import android.os.Parcel;
4import android.os.Parcelable;
5import android.util.Printer;
6
7import java.text.Collator;
8import java.util.Comparator;
9
10/**
11 * Information you can retrieve about a particular application.  This
12 * corresponds to information collected from the AndroidManifest.xml's
13 * <application> tag.
14 */
15public class ApplicationInfo extends PackageItemInfo implements Parcelable {
16
17    /**
18     * Default task affinity of all activities in this application. See
19     * {@link ActivityInfo#taskAffinity} for more information.  This comes
20     * from the "taskAffinity" attribute.
21     */
22    public String taskAffinity;
23
24    /**
25     * Optional name of a permission required to be able to access this
26     * application's components.  From the "permission" attribute.
27     */
28    public String permission;
29
30    /**
31     * The name of the process this application should run in.  From the
32     * "process" attribute or, if not set, the same as
33     * <var>packageName</var>.
34     */
35    public String processName;
36
37    /**
38     * Class implementing the Application object.  From the "class"
39     * attribute.
40     */
41    public String className;
42
43    /**
44     * A style resource identifier (in the package's resources) of the
45     * description of an application.  From the "description" attribute
46     * or, if not set, 0.
47     */
48    public int descriptionRes;
49
50    /**
51     * A style resource identifier (in the package's resources) of the
52     * default visual theme of the application.  From the "theme" attribute
53     * or, if not set, 0.
54     */
55    public int theme;
56
57    /**
58     * Class implementing the Application's manage space
59     * functionality.  From the "manageSpaceActivity"
60     * attribute. This is an optional attribute and will be null if
61     * applications don't specify it in their manifest
62     */
63    public String manageSpaceActivityName;
64
65    /**
66     * Class implementing the Application's backup functionality.  From
67     * the "backupAgent" attribute.  This is an optional attribute and
68     * will be null if the application does not specify it in its manifest.
69     *
70     * <p>If android:allowBackup is set to false, this attribute is ignored.
71     *
72     * {@hide}
73     */
74    public String backupAgentName;
75
76    /**
77     * Value for {@link #flags}: if set, this application is installed in the
78     * device's system image.
79     */
80    public static final int FLAG_SYSTEM = 1<<0;
81
82    /**
83     * Value for {@link #flags}: set to true if this application would like to
84     * allow debugging of its
85     * code, even when installed on a non-development system.  Comes
86     * from {@link android.R.styleable#AndroidManifestApplication_debuggable
87     * android:debuggable} of the &lt;application&gt; tag.
88     */
89    public static final int FLAG_DEBUGGABLE = 1<<1;
90
91    /**
92     * Value for {@link #flags}: set to true if this application has code
93     * associated with it.  Comes
94     * from {@link android.R.styleable#AndroidManifestApplication_hasCode
95     * android:hasCode} of the &lt;application&gt; tag.
96     */
97    public static final int FLAG_HAS_CODE = 1<<2;
98
99    /**
100     * Value for {@link #flags}: set to true if this application is persistent.
101     * Comes from {@link android.R.styleable#AndroidManifestApplication_persistent
102     * android:persistent} of the &lt;application&gt; tag.
103     */
104    public static final int FLAG_PERSISTENT = 1<<3;
105
106    /**
107     * Value for {@link #flags}: set to true if this application holds the
108     * {@link android.Manifest.permission#FACTORY_TEST} permission and the
109     * device is running in factory test mode.
110     */
111    public static final int FLAG_FACTORY_TEST = 1<<4;
112
113    /**
114     * Value for {@link #flags}: default value for the corresponding ActivityInfo flag.
115     * Comes from {@link android.R.styleable#AndroidManifestApplication_allowTaskReparenting
116     * android:allowTaskReparenting} of the &lt;application&gt; tag.
117     */
118    public static final int FLAG_ALLOW_TASK_REPARENTING = 1<<5;
119
120    /**
121     * Value for {@link #flags}: default value for the corresponding ActivityInfo flag.
122     * Comes from {@link android.R.styleable#AndroidManifestApplication_allowClearUserData
123     * android:allowClearUserData} of the &lt;application&gt; tag.
124     */
125    public static final int FLAG_ALLOW_CLEAR_USER_DATA = 1<<6;
126
127    /**
128     * Value for {@link #flags}: this is set if this application has been
129     * install as an update to a built-in system application.
130     */
131    public static final int FLAG_UPDATED_SYSTEM_APP = 1<<7;
132
133    /**
134     * Value for {@link #flags}: this is set of the application has set
135     * its android:targetSdkVersion to something >= the current SDK version.
136     */
137    public static final int FLAG_TEST_ONLY = 1<<8;
138
139    /**
140     * Value for {@link #flags}: true when the application's window can be
141     * reduced in size for smaller screens.  Corresponds to
142     * {@link android.R.styleable#AndroidManifestSupportsScreens_smallScreens
143     * android:smallScreens}.
144     */
145    public static final int FLAG_SUPPORTS_SMALL_SCREENS = 1<<9;
146
147    /**
148     * Value for {@link #flags}: true when the application's window can be
149     * displayed on normal screens.  Corresponds to
150     * {@link android.R.styleable#AndroidManifestSupportsScreens_normalScreens
151     * android:normalScreens}.
152     */
153    public static final int FLAG_SUPPORTS_NORMAL_SCREENS = 1<<10;
154
155    /**
156     * Value for {@link #flags}: true when the application's window can be
157     * increased in size for larger screens.  Corresponds to
158     * {@link android.R.styleable#AndroidManifestSupportsScreens_largeScreens
159     * android:smallScreens}.
160     */
161    public static final int FLAG_SUPPORTS_LARGE_SCREENS = 1<<11;
162
163    /**
164     * Value for {@link #flags}: true when the application knows how to adjust
165     * its UI for different screen sizes.  Corresponds to
166     * {@link android.R.styleable#AndroidManifestSupportsScreens_resizeable
167     * android:resizeable}.
168     */
169    public static final int FLAG_RESIZEABLE_FOR_SCREENS = 1<<12;
170
171    /**
172     * Value for {@link #flags}: this is false if the application has set
173     * its android:allowBackup to false, true otherwise.
174     *
175     * {@hide}
176     */
177    public static final int FLAG_ALLOW_BACKUP = 1<<13;
178
179    /**
180     * Indicates that the application supports any densities;
181     * {@hide}
182     */
183    public static final int ANY_DENSITY = -1;
184    static final int[] ANY_DENSITIES_ARRAY = { ANY_DENSITY };
185
186    /**
187     * Flags associated with the application.  Any combination of
188     * {@link #FLAG_SYSTEM}, {@link #FLAG_DEBUGGABLE}, {@link #FLAG_HAS_CODE},
189     * {@link #FLAG_PERSISTENT}, {@link #FLAG_FACTORY_TEST}, and
190     * {@link #FLAG_ALLOW_TASK_REPARENTING}
191     * {@link #FLAG_ALLOW_CLEAR_USER_DATA}, {@link #FLAG_UPDATED_SYSTEM_APP},
192     * {@link #FLAG_TEST_ONLY}, {@link #FLAG_SUPPORTS_SMALL_SCREENS},
193     * {@link #FLAG_SUPPORTS_NORMAL_SCREENS},
194     * {@link #FLAG_SUPPORTS_LARGE_SCREENS}, {@link #FLAG_RESIZEABLE_FOR_SCREENS}.
195     */
196    public int flags = 0;
197
198    /**
199     * Full path to the location of this package.
200     */
201    public String sourceDir;
202
203    /**
204     * Full path to the location of the publicly available parts of this package (i.e. the resources
205     * and manifest).  For non-forward-locked apps this will be the same as {@link #sourceDir).
206     */
207    public String publicSourceDir;
208
209    /**
210     * Paths to all shared libraries this application is linked against.  This
211     * field is only set if the {@link PackageManager#GET_SHARED_LIBRARY_FILES
212     * PackageManager.GET_SHARED_LIBRARY_FILES} flag was used when retrieving
213     * the structure.
214     */
215    public String[] sharedLibraryFiles;
216
217    /**
218     * Full path to a directory assigned to the package for its persistent
219     * data.
220     */
221    public String dataDir;
222
223    /**
224     * The kernel user-ID that has been assigned to this application;
225     * currently this is not a unique ID (multiple applications can have
226     * the same uid).
227     */
228    public int uid;
229
230    /**
231     * The list of densities in DPI that application supprots. This
232     * field is only set if the {@link PackageManager#GET_SUPPORTS_DENSITIES} flag was
233     * used when retrieving the structure.
234     */
235    public int[] supportsDensities;
236
237    /**
238     * The minimum SDK version this application targets.  It may run on earilier
239     * versions, but it knows how to work with any new behavior added at this
240     * version.  Will be {@link android.os.Build.VERSION_CODES#CUR_DEVELOPMENT}
241     * if this is a development build and the app is targeting that.  You should
242     * compare that this number is >= the SDK version number at which your
243     * behavior was introduced.
244     */
245    public int targetSdkVersion;
246
247    /**
248     * When false, indicates that all components within this application are
249     * considered disabled, regardless of their individually set enabled status.
250     */
251    public boolean enabled = true;
252
253    public void dump(Printer pw, String prefix) {
254        super.dumpFront(pw, prefix);
255        pw.println(prefix + "className=" + className);
256        pw.println(prefix + "permission=" + permission
257                + " uid=" + uid);
258        pw.println(prefix + "taskAffinity=" + taskAffinity);
259        pw.println(prefix + "theme=0x" + Integer.toHexString(theme));
260        pw.println(prefix + "flags=0x" + Integer.toHexString(flags)
261                + " processName=" + processName);
262        pw.println(prefix + "sourceDir=" + sourceDir);
263        pw.println(prefix + "publicSourceDir=" + publicSourceDir);
264        pw.println(prefix + "sharedLibraryFiles=" + sharedLibraryFiles);
265        pw.println(prefix + "dataDir=" + dataDir);
266        pw.println(prefix + "targetSdkVersion=" + targetSdkVersion);
267        pw.println(prefix + "enabled=" + enabled);
268        pw.println(prefix + "manageSpaceActivityName="+manageSpaceActivityName);
269        pw.println(prefix + "description=0x"+Integer.toHexString(descriptionRes));
270        pw.println(prefix + "supportsDensities=" + supportsDensities);
271        super.dumpBack(pw, prefix);
272    }
273
274    public static class DisplayNameComparator
275            implements Comparator<ApplicationInfo> {
276        public DisplayNameComparator(PackageManager pm) {
277            mPM = pm;
278        }
279
280        public final int compare(ApplicationInfo aa, ApplicationInfo ab) {
281            CharSequence  sa = mPM.getApplicationLabel(aa);
282            if (sa == null) {
283                sa = aa.packageName;
284            }
285            CharSequence  sb = mPM.getApplicationLabel(ab);
286            if (sb == null) {
287                sb = ab.packageName;
288            }
289
290            return sCollator.compare(sa.toString(), sb.toString());
291        }
292
293        private final Collator   sCollator = Collator.getInstance();
294        private PackageManager   mPM;
295    }
296
297    public ApplicationInfo() {
298    }
299
300    public ApplicationInfo(ApplicationInfo orig) {
301        super(orig);
302        taskAffinity = orig.taskAffinity;
303        permission = orig.permission;
304        processName = orig.processName;
305        className = orig.className;
306        theme = orig.theme;
307        flags = orig.flags;
308        sourceDir = orig.sourceDir;
309        publicSourceDir = orig.publicSourceDir;
310        sharedLibraryFiles = orig.sharedLibraryFiles;
311        dataDir = orig.dataDir;
312        uid = orig.uid;
313        targetSdkVersion = orig.targetSdkVersion;
314        enabled = orig.enabled;
315        manageSpaceActivityName = orig.manageSpaceActivityName;
316        descriptionRes = orig.descriptionRes;
317        supportsDensities = orig.supportsDensities;
318    }
319
320
321    public String toString() {
322        return "ApplicationInfo{"
323            + Integer.toHexString(System.identityHashCode(this))
324            + " " + packageName + "}";
325    }
326
327    public int describeContents() {
328        return 0;
329    }
330
331    public void writeToParcel(Parcel dest, int parcelableFlags) {
332        super.writeToParcel(dest, parcelableFlags);
333        dest.writeString(taskAffinity);
334        dest.writeString(permission);
335        dest.writeString(processName);
336        dest.writeString(className);
337        dest.writeInt(theme);
338        dest.writeInt(flags);
339        dest.writeString(sourceDir);
340        dest.writeString(publicSourceDir);
341        dest.writeStringArray(sharedLibraryFiles);
342        dest.writeString(dataDir);
343        dest.writeInt(uid);
344        dest.writeInt(targetSdkVersion);
345        dest.writeInt(enabled ? 1 : 0);
346        dest.writeString(manageSpaceActivityName);
347        dest.writeString(backupAgentName);
348        dest.writeInt(descriptionRes);
349        dest.writeIntArray(supportsDensities);
350    }
351
352    public static final Parcelable.Creator<ApplicationInfo> CREATOR
353            = new Parcelable.Creator<ApplicationInfo>() {
354        public ApplicationInfo createFromParcel(Parcel source) {
355            return new ApplicationInfo(source);
356        }
357        public ApplicationInfo[] newArray(int size) {
358            return new ApplicationInfo[size];
359        }
360    };
361
362    private ApplicationInfo(Parcel source) {
363        super(source);
364        taskAffinity = source.readString();
365        permission = source.readString();
366        processName = source.readString();
367        className = source.readString();
368        theme = source.readInt();
369        flags = source.readInt();
370        sourceDir = source.readString();
371        publicSourceDir = source.readString();
372        sharedLibraryFiles = source.readStringArray();
373        dataDir = source.readString();
374        uid = source.readInt();
375        targetSdkVersion = source.readInt();
376        enabled = source.readInt() != 0;
377        manageSpaceActivityName = source.readString();
378        backupAgentName = source.readString();
379        descriptionRes = source.readInt();
380        supportsDensities = source.createIntArray();
381    }
382
383    /**
384     * Retrieve the textual description of the application.  This
385     * will call back on the given PackageManager to load the description from
386     * the application.
387     *
388     * @param pm A PackageManager from which the label can be loaded; usually
389     * the PackageManager from which you originally retrieved this item.
390     *
391     * @return Returns a CharSequence containing the application's description.
392     * If there is no description, null is returned.
393     */
394    public CharSequence loadDescription(PackageManager pm) {
395        if (descriptionRes != 0) {
396            CharSequence label = pm.getText(packageName, descriptionRes, null);
397            if (label != null) {
398                return label;
399            }
400        }
401        return null;
402    }
403
404    /**
405     * Disable compatibility mode
406     *
407     * @hide
408     */
409    public void disableCompatibilityMode() {
410        flags |= (FLAG_SUPPORTS_LARGE_SCREENS | FLAG_SUPPORTS_NORMAL_SCREENS |
411                FLAG_SUPPORTS_SMALL_SCREENS | FLAG_RESIZEABLE_FOR_SCREENS);
412        supportsDensities = ANY_DENSITIES_ARRAY;
413    }
414}
415