Added in API level 34

Summary: Inherited Constants | Fields | Methods | Inherited Methods

OverlayInfo

Kotlin |Java

public final class OverlayInfo
extends Object implements Parcelable

java.lang.Object
↳	android.content.om.OverlayInfo

An immutable information about an overlay.

Applications calling OverlayManager.getOverlayInfosForTarget(String) get the information list of the registered overlays. Each element in the list presents the information of the particular overlay.

See also:

OverlayManager.getOverlayInfosForTarget(String)

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<OverlayInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`OverlayIdentifier`	`getOverlayIdentifier()` Get the unique identifier from the overlay information.
`String`	`getOverlayName()` Get the overlay name from the registered fabricated overlay.
`String`	`getTargetOverlayableName()` Return the target overlayable name.
`String`	`getTargetPackageName()` Returns the name of the target overlaid package.
`void`	`writeToParcel(Parcel dest, 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.

Fields

CREATOR

Added in API level 34

public static final Creator<OverlayInfo> CREATOR

Public methods

describeContents

Added in API level 34

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`

getOverlayIdentifier

Added in API level 34

public OverlayIdentifier getOverlayIdentifier ()

Get the unique identifier from the overlay information.

The return value of this function can be used to unregister the related overlay.

Returns
`OverlayIdentifier`	an identifier representing the current overlay. This value cannot be `null`.

getOverlayName

Added in API level 34

public String getOverlayName ()

Get the overlay name from the registered fabricated overlay.

Returns
`String`	the overlay name This value may be `null`.

getTargetOverlayableName

Added in API level 34

public String getTargetOverlayableName ()

Return the target overlayable name.

Returns
`String`	the name of the target overlayable resources set This value may be `null`.

getTargetPackageName

Added in API level 34

public String getTargetPackageName ()

Returns the name of the target overlaid package.

Returns
`String`	the target package name This value cannot be `null`.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: 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