Android
android.content
public final class

android.content.ComponentName

java.lang.Object
android.content.ComponentName Parcelable

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

Constants

      Value  
Creator<ComponentName CREATOR       
Constants inherited from interface android.os.Parcelable

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

          int  describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
          boolean  equals(Object obj)
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
          String  flattenToShortString()
The samee 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 the receiver.
      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 the receiver.
      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.
Methods inherited from class java.lang.Object
Methods inherited from interface android.os.Parcelable

Details

Constants

public static final Creator<ComponentName> CREATOR

Public Constructors

public ComponentName(String pkg, String cls)

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)

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)

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)

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 int describeContents()

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

public boolean equals(Object obj)

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. The implementation in Object returns true only if the argument is the exact same object as the receiver (==).

Parameters

obj Object the object to compare with this object.

Returns

  • boolean true if the object is the same as this object false if it is different from this object.

public String flattenToShortString()

The samee 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

  • 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()

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

  • 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()

Return the class name of this component.

public String getPackageName()

Return the package name of this component.

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.

public int hashCode()

Returns an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value for this method.

Returns

  • int the receiver's hash.

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

Parameters

in The Parcel from which to read the ComponentName

Returns

  • Returns a new ComponentName matching the previously written object, or null if a null had been written.

public String toShortString()

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

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Returns

  • String a printable representation for the receiver.

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 The String that was returned by flattenToString().

Returns

  • Returns a new ComponentName containing the package and class names that were encoded in str

public static void writeToParcel(ComponentName c, Parcel out)

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.

public void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48