Added in API level 1

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

ComponentName

---

Kotlin |Java

public final class ComponentName
extends Object implements Parcelable, Cloneable, Comparable<ComponentName>

java.lang.Object
↳	android.content.ComponentName

---

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

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout 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(android.os.Parcel, int).

Public methods
ComponentName	clone() Creates and returns a copy of this object.
int	compareTo(ComponentName that)
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.
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.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one. Two components are considered to be equal if the packages in which they reside have the same name, and if the classes that implement each component also have the same name.
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 a hash code value for the object.
static ComponentName	readFromParcel(Parcel in) Read a ComponentName from a Parcel that was previously written with writeToParcel(android.content.ComponentName, android.os.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 representation of the object.
static ComponentName	unflattenFromString(String str) Recover a ComponentName from a String that was previously created with flattenToString().
static void	writeToParcel(ComponentName c, Parcel out) Write a ComponentName to a Parcel, handling null pointers.
void	writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.
From interface java.lang.Comparable abstract int compareTo(ComponentName o) Compares this object with the specified object for order.

Fields

CREATOR

Added in API level 1

public static final Creator<ComponentName> CREATOR

Public constructors

ComponentName

Added in API level 1

public ComponentName (String pkg, 
                String cls)

Create a new component identifier.

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

ComponentName

Added in API level 1

public ComponentName (Context pkg, 
                String cls)

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

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

ComponentName

Added in API level 1

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

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

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

ComponentName

Added in API level 1

public ComponentName (Parcel in)

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

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

Public methods

clone

Added in API level 1

public ComponentName clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns
ComponentName	a clone of this instance.

compareTo

Added in API level 4

public int compareTo (ComponentName that)

Parameters
that	ComponentName

Returns
int

createRelative

Added in API level 23

public 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.

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	String: the name of the package the component exists in This value cannot be null.
cls	String: the name of the class inside of pkg that implements the component This value cannot be null.

Returns
ComponentName	the new ComponentName This value cannot be null.

createRelative

Added in API level 23

public 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.

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	Context: a Context for the package implementing the component This value cannot be null.
cls	String: the name of the class inside of pkg that implements the component This value cannot be null.

Returns
ComponentName	the new ComponentName This value cannot be null.

describeContents

Added in API level 1

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 1

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Two components are considered to be equal if the packages in which they reside have the same name, and if the classes that implement each component also have the same name.

Parameters
obj	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

flattenToShortString

Added in API level 1

public String flattenToShortString ()

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(java.lang.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. This value cannot be null.

See also:

• unflattenFromString(String)

flattenToString

Added in API level 1

public String flattenToString ()

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(java.lang.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. This value cannot be null.

See also:

• unflattenFromString(String)

getClassName

Added in API level 1

public String getClassName ()

Return the class name of this component.

Returns
String	This value cannot be null.

getPackageName

Added in API level 1

public String getPackageName ()

Return the package name of this component.

Returns
String	This value cannot be null.

getShortClassName

Added in API level 1

public 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.

Returns
String

hashCode

Added in API level 1

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

readFromParcel

Added in API level 1

public static ComponentName readFromParcel (Parcel in)

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

Parameters
in	Parcel: 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.

See also:

• writeToParcel(ComponentName, Parcel)

toShortString

Added in API level 1

public String toShortString ()

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

Returns
String

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

unflattenFromString

Added in API level 1

public static ComponentName unflattenFromString (String str)

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	String: The String that was returned by flattenToString(). This value cannot be null.

Returns
ComponentName	Returns a new ComponentName containing the package and class names that were encoded in str This value may be null.

See also:

• flattenToString()

writeToParcel

Added in API level 1

public static void writeToParcel (ComponentName c, 
                Parcel out)

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

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

See also:

• readFromParcel(Parcel)

writeToParcel

Added in API level 1

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES