Android APIs
public final class

ComponentName

extends Object
implements Parcelable Cloneable Comparable<ComponentName>
java.lang.Object
   ↳ android.content.ComponentName

Class Overview

Identifier for a specific application component (Activity, Service, BroadcastReceiver, or ContentProvider) that is available. Two pieces of information, encapsulated here, are required to identify a component: the package (a String) it exists in, and the class (a String) name inside of that package.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<ComponentName> CREATOR
Public Constructors
ComponentName(String pkg, String cls)
Create a new component identifier.
ComponentName(Context pkg, String cls)
Create a new component identifier from a Context and class name.
ComponentName(Context pkg, Class<?> cls)
Create a new component identifier from a Context and Class object.
ComponentName(Parcel in)
Instantiate a new ComponentName from the data in a Parcel that was previously written with writeToParcel(Parcel, int).
Public Methods
ComponentName clone()
Creates and returns a copy of this Object.
int compareTo(ComponentName that)
static ComponentName createRelative(Context pkg, String cls)
Create a new component identifier where the class name may be specified as either absolute or relative to the containing package.
static ComponentName createRelative(String pkg, String cls)
Create a new component identifier where the class name may be specified as either absolute or relative to the containing package.
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.
String flattenToShortString()
The same as flattenToString(), but abbreviates the class name if it is a suffix of the package.
String flattenToString()
Return a String that unambiguously describes both the package and class names contained in the ComponentName.
String getClassName()
Return the class name of this component.
String getPackageName()
Return the package name of this component.
String getShortClassName()
Return the class name, either fully qualified or in a shortened form (with a leading '.') if it is a suffix of the package.
int hashCode()
Returns an integer hash code for this object.
static ComponentName readFromParcel(Parcel in)
Read a ComponentName from a Parcel that was previously written with writeToParcel(ComponentName, Parcel), returning either a null or new object as appropriate.
String toShortString()
Return string representation of this class without the class's name as a prefix.
String toString()
Returns a string containing a concise, human-readable description of this object.
static ComponentName unflattenFromString(String str)
Recover a ComponentName from a String that was previously created with flattenToString().
void writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
static void writeToParcel(ComponentName c, Parcel out)
Write a ComponentName to a Parcel, handling null pointers.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable
From interface java.lang.Comparable

Fields

public static final Creator<ComponentName> CREATOR

Added in API level 1

Public Constructors

public ComponentName (String pkg, String cls)

Added in API level 1

Create a new component identifier.

Parameters
pkg The name of the package that the component exists in. Can not be null.
cls The name of the class inside of pkg that implements the component. Can not be null.

public ComponentName (Context pkg, String cls)

Added in API level 1

Create a new component identifier from a Context and class name.

Parameters
pkg A Context for the package implementing the component, from which the actual package name will be retrieved.
cls The name of the class inside of pkg that implements the component.

public ComponentName (Context pkg, Class<?> cls)

Added in API level 1

Create a new component identifier from a Context and Class object.

Parameters
pkg A Context for the package implementing the component, from which the actual package name will be retrieved.
cls The Class object of the desired component, from which the actual class name will be retrieved.

public ComponentName (Parcel in)

Added in API level 1

Instantiate a new ComponentName from the data in a Parcel that was previously written with writeToParcel(Parcel, int). Note that you must not use this with data written by writeToParcel(ComponentName, Parcel) since it is not possible to handle a null ComponentObject here.

Parameters
in The Parcel containing the previously written ComponentName, positioned at the location in the buffer where it was written.

Public Methods

public ComponentName clone ()

Added in API level 1

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
ComponentName a copy of this object.

public int compareTo (ComponentName that)

Added in API level 4

Parameters
that
Returns
int

public static ComponentName createRelative (Context pkg, String cls)

Added in API level 23

Create a new component identifier where the class name may be specified as either absolute or relative to the containing package.

Relative package names begin with a '.' character. For a package "com.example" and class name ".app.MyActivity" this method will return a ComponentName with the package "com.example"and class name "com.example.app.MyActivity". Fully qualified class names are also permitted.

Parameters
pkg a Context for the package implementing the component
cls the name of the class inside of pkg that implements the component
Returns
ComponentName the new ComponentName

public static ComponentName createRelative (String pkg, String cls)

Added in API level 23

Create a new component identifier where the class name may be specified as either absolute or relative to the containing package.

Relative package names begin with a '.' character. For a package "com.example" and class name ".app.MyActivity" this method will return a ComponentName with the package "com.example"and class name "com.example.app.MyActivity". Fully qualified class names are also permitted.

Parameters
pkg the name of the package the component exists in
cls the name of the class inside of pkg that implements the component
Returns
ComponentName the new ComponentName

public int describeContents ()

Added in API level 1

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object obj)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public String flattenToShortString ()

Added in API level 1

The same as flattenToString(), but abbreviates the class name if it is a suffix of the package. The result can still be used with unflattenFromString(String).

Returns
String Returns a new String holding the package and class names. This is represented as the package name, concatenated with a '/' and then the class name.

public String flattenToString ()

Added in API level 1

Return a String that unambiguously describes both the package and class names contained in the ComponentName. You can later recover the ComponentName from this string through unflattenFromString(String).

Returns
String Returns a new String holding the package and class names. This is represented as the package name, concatenated with a '/' and then the class name.

public String getClassName ()

Added in API level 1

Return the class name of this component.

Returns
String

public String getPackageName ()

Added in API level 1

Return the package name of this component.

Returns
String

public String getShortClassName ()

Added in API level 1

Return the class name, either fully qualified or in a shortened form (with a leading '.') if it is a suffix of the package.

Returns
String

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public static ComponentName readFromParcel (Parcel in)

Added in API level 1

Read a ComponentName from a Parcel that was previously written with writeToParcel(ComponentName, Parcel), returning either a null or new object as appropriate.

Parameters
in The Parcel from which to read the ComponentName
Returns
ComponentName Returns a new ComponentName matching the previously written object, or null if a null had been written.

public String toShortString ()

Added in API level 1

Return string representation of this class without the class's name as a prefix.

Returns
String

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public static ComponentName unflattenFromString (String str)

Added in API level 1

Recover a ComponentName from a String that was previously created with flattenToString(). It splits the string at the first '/', taking the part before as the package name and the part after as the class name. As a special convenience (to use, for example, when parsing component names on the command line), if the '/' is immediately followed by a '.' then the final class name will be the concatenation of the package name with the string following the '/'. Thus "com.foo/.Blah" becomes package="com.foo" class="com.foo.Blah".

Parameters
str The String that was returned by flattenToString().
Returns
ComponentName Returns a new ComponentName containing the package and class names that were encoded in str

See also:

public void writeToParcel (Parcel out, int flags)

Added in API level 1

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

public static void writeToParcel (ComponentName c, Parcel out)

Added in API level 1

Write a ComponentName to a Parcel, handling null pointers. Must be read with readFromParcel(Parcel).

Parameters
c The ComponentName to be written.
out The Parcel in which the ComponentName will be placed.