ComponentName  |  API reference  |  Android Developers (original) (raw)

Stay organized with collections Save and categorize content based on your preferences.

public final class ComponentName
extends [Object](/reference/java/lang/Object) implements[Cloneable](/reference/java/lang/Cloneable), [Comparable](/reference/java/lang/Comparable)<[ComponentName](/reference/android/content/ComponentName)>, [Parcelable](/reference/android/os/Parcelable)

Identifier for a specific application component ([Activity](/reference/android/app/Activity), [Service](/reference/android/app/Service),[BroadcastReceiver](/reference/android/content/BroadcastReceiver), or[ContentProvider](/reference/android/content/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

Fields

Public constructors

ComponentName

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

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

ComponentName

public ComponentName (Context pkg, String cls)

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

ComponentName

public ComponentName (String pkg, String cls)

Create a new component identifier.

Public methods

clone

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 callingsuper.clone. If a class and all of its superclasses (exceptObject) obey this convention, it will be the case thatx.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.

compareTo

public int compareTo (ComponentName that)

createRelative

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.

createRelative

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.

describeContents

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)](/reference/android/os/Parcelable#writeToParcel%28android.os.Parcel,%20int%29), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](/reference/android/os/Parcelable#CONTENTS%5FFILE%5FDESCRIPTOR) bit.

equals

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 valuex, x.equals(x) should returntrue.
• It is symmetric: for any non-null reference valuesx and y, x.equals(y) should return true if and only ify.equals(x) returns true.
• It is transitive: for any non-null reference valuesx, y, and z, ifx.equals(y) returns true andy.equals(z) returns true, thenx.equals(z) should return true.
• It is consistent: for any non-null reference valuesx and y, multiple invocations ofx.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.

flattenToShortString

public String flattenToShortString ()

The same as [flattenToString()](/reference/android/content/ComponentName#flattenToString%28%29), but abbreviates the class name if it is a suffix of the package. The result can still be used with [unflattenFromString(java.lang.String)](/reference/android/content/ComponentName#unflattenFromString%28java.lang.String%29).

flattenToString

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)](/reference/android/content/ComponentName#unflattenFromString%28java.lang.String%29).

getClassName

public String getClassName ()

Return the class name of this component.

getPackageName

public String getPackageName ()

Return the package name of this component.

getShortClassName

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.

hashCode

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](/reference/java/util/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](/reference/java/lang/Object#equals%28java.lang.Object%29) 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](/reference/java/lang/Object#equals%28java.lang.Object%29) 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.

toShortString

public String toShortString ()

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

toString

public String toString ()

Returns a string representation of the object.

unflattenFromString

public static ComponentName unflattenFromString (String str)

Recover a ComponentName from a String that was previously created with[flattenToString()](/reference/android/content/ComponentName#flattenToString%28%29). 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".

writeToParcel

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)](/reference/android/content/ComponentName#readFromParcel%28android.os.Parcel%29).

writeToParcel

public void writeToParcel (Parcel out, int flags)

Flatten this object in to a Parcel.