Android APIs
public final class

UsageEvents

extends Object
implements Parcelable
java.lang.Object
   ↳ android.app.usage.UsageEvents

Class Overview

A result returned from queryEvents(long, long) from which to read UsageEvents.Event objects.

Summary

Nested Classes
class UsageEvents.Event An event representing a state change for a component. 
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<UsageEvents> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean getNextEvent(UsageEvents.Event eventOut)
Retrieve the next UsageEvents.Event from the collection and put the resulting data into eventOut.
boolean hasNextEvent()
Returns whether or not there are more events to read using getNextEvent(android.app.usage.UsageEvents.Event).
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<UsageEvents> CREATOR

Added in API level 21

Public Methods

public int describeContents ()

Added in API level 21

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean getNextEvent (UsageEvents.Event eventOut)

Added in API level 21

Retrieve the next UsageEvents.Event from the collection and put the resulting data into eventOut.

Parameters
eventOut The UsageEvents.Event object that will receive the next event data.
Returns
  • true if an event was available, false if there are no more events.

public boolean hasNextEvent ()

Added in API level 21

Returns whether or not there are more events to read using getNextEvent(android.app.usage.UsageEvents.Event).

Returns
  • true if there are more events, false otherwise.

public void writeToParcel (Parcel dest, int flags)

Added in API level 21

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Protected Methods

protected void finalize ()

Added in API level 21

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable