ComponentName
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 |
|---|
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 |
|
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. |
String
|
flattenToShortString()
The same as |
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 |
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
|
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 | |
|---|---|
java.lang.Object
| |
android.os.Parcelable
| |
java.lang.Comparable
| |
Fields
Public constructors
ComponentName
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.This value must never be |
cls |
String: The name of the class inside of pkg that
implements the component. Can not be null.
This value must never be |
ComponentName
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 must never be |
cls |
String: The name of the class inside of pkg that
implements the component.
This value must never be |
ComponentName
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 must never be |
cls |
Class: The Class object of the desired component, from which the
actual class name will be retrieved.
This value must never be |
ComponentName
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 |
Parcel: The Parcel containing the previously written ComponentName,
positioned at the location in the buffer where it was written.
|
Public methods
clone
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:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
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.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
| Returns | |
|---|---|
ComponentName |
a clone of this instance. |
compareTo
int compareTo (ComponentName that)
| Parameters | |
|---|---|
that |
ComponentName |
| Returns | |
|---|---|
int |
|
createRelative
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 inThis value must never be |
cls |
String: the name of the class inside of pkg that implements
the componentThis value must never be |
| Returns | |
|---|---|
ComponentName |
the new ComponentName
This value will never be |
createRelative
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 componentThis value must never be |
cls |
String: the name of the class inside of pkg that implements
the componentThis value must never be |
| Returns | |
|---|---|
ComponentName |
the new ComponentName
This value will never be |
describeContents
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(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. |
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
obj |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
flattenToShortString
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(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 will never be |
See also:
flattenToString
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 | |
|---|---|
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 will never be |
See also:
getClassName
String getClassName ()
Return the class name of this component.
| Returns | |
|---|---|
String |
This value will never be |
getPackageName
String getPackageName ()
Return the package name of this component.
| Returns | |
|---|---|
String |
This value will never be |
getShortClassName
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
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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(Object)method, then calling thehashCodemethod 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(java.lang.Object)method, then calling thehashCodemethod 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
readFromParcel
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 |
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:
toShortString
String toShortString ()
Return string representation of this class without the class's name as a prefix.
| Returns | |
|---|---|
String |
|
toString
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
unflattenFromString
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 must never be |
| Returns | |
|---|---|
ComponentName |
Returns a new ComponentName containing the package and class
names that were encoded in str This value may be |
See also:
writeToParcel
void writeToParcel (ComponentName c, Parcel out)
Write a ComponentName to a Parcel, handling null pointers. Must be
read with readFromParcel(Parcel).
| Parameters | |
|---|---|
c |
ComponentName: The ComponentName to be written. |
out |
Parcel: The Parcel in which the ComponentName will be placed. |
See also:
writeToParcel
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. |
flags |
int: Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|
Interfaces
- ClipboardManager.OnPrimaryClipChangedListener
- ComponentCallbacks
- ComponentCallbacks2
- ContentProvider.PipeDataWriter
- DialogInterface
- DialogInterface.OnCancelListener
- DialogInterface.OnClickListener
- DialogInterface.OnDismissListener
- DialogInterface.OnKeyListener
- DialogInterface.OnMultiChoiceClickListener
- DialogInterface.OnShowListener
- EntityIterator
- IntentSender.OnFinished
- Loader.OnLoadCanceledListener
- Loader.OnLoadCompleteListener
- ServiceConnection
- SharedPreferences
- SharedPreferences.Editor
- SharedPreferences.OnSharedPreferenceChangeListener
- SyncStatusObserver
Classes
- AbstractThreadedSyncAdapter
- AsyncQueryHandler
- AsyncQueryHandler.WorkerArgs
- AsyncQueryHandler.WorkerHandler
- AsyncTaskLoader
- BroadcastReceiver
- BroadcastReceiver.PendingResult
- ClipboardManager
- ClipData
- ClipData.Item
- ClipDescription
- ComponentName
- ContentProvider
- ContentProviderClient
- ContentProviderOperation
- ContentProviderOperation.Builder
- ContentProviderResult
- ContentQueryMap
- ContentResolver
- ContentUris
- ContentValues
- Context
- ContextWrapper
- CursorLoader
- Entity
- Entity.NamedContentValues
- Intent
- Intent.FilterComparison
- Intent.ShortcutIconResource
- IntentFilter
- IntentFilter.AuthorityEntry
- IntentSender
- Loader
- Loader.ForceLoadContentObserver
- MutableContextWrapper
- PeriodicSync
- QuickViewConstants
- RestrictionEntry
- RestrictionsManager
- SearchRecentSuggestionsProvider
- SyncAdapterType
- SyncContext
- SyncInfo
- SyncRequest
- SyncRequest.Builder
- SyncResult
- SyncStats
- UriMatcher
- UriPermission
Exceptions