Added in version 37.2

ContextHint


public abstract class ContextHint
extends Object

java.lang.Object
   ↳ android.app.personalcontext.hint.ContextHint


A ContextHint holds information about the device or user that may be useful to an understander. Hints are forwarded to refiners and understanders in the personal context service. Refiners may emit new hints, based on existing hints. Understanders emit ContextInsights.

This is an abstract base class for all hints. Only built-in hints classes are supported. Users of this class can use instanceof to determine the type of the hint.

Summary

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Set<ContextHint> getAttributionHints()

Gets the attribution hints used to create this hint.

final long getCreationTimeMillis()

Gets the time this hint was created in milliseconds since epoch.

final UUID getHintId()

Returns the unique ID of this hint.

String getHintTypeName()

Gets the type name of the hint.

long getPublishedTimeMillis()

Gets the time when the hint was published in milliseconds since epoch.

String getPublishingPackage()

Gets the package name of the package that published this hint.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

equals

Added in version 37.2
public boolean equals (Object o)

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.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.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAttributionHints

Added in version 37.2
public Set<ContextHint> getAttributionHints ()

Gets the attribution hints used to create this hint. This is empty for hints that have not been published yet.

Returns
Set<ContextHint> This value cannot be null.

getCreationTimeMillis

Added in version 37.2
public final long getCreationTimeMillis ()

Gets the time this hint was created in milliseconds since epoch.

Returns
long

getHintId

Added in version 37.2
public final UUID getHintId ()

Returns the unique ID of this hint.

Returns
UUID This value cannot be null.

getHintTypeName

Added in version 37.2
public String getHintTypeName ()

Gets the type name of the hint. For ERROR(BundleHint/android.app.personalcontext.hint.BundleHint BundleHint) this is the type name that was provided in the builder. For all other hints it is the canonical class name.

Returns
String This value cannot be null.

getPublishedTimeMillis

Added in version 37.2
public long getPublishedTimeMillis ()

Gets the time when the hint was published in milliseconds since epoch. This is 0 for hints that have not been published yet.

Returns
long

getPublishingPackage

Added in version 37.2
public String getPublishingPackage ()

Gets the package name of the package that published this hint. This is null for hints that have not been published yet.

Returns
String

hashCode

Added in version 37.2
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.

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

Returns
int a hash code value for this object.

toString

Added in version 37.2
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.