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.
See also:
ERROR(for a description of the personal context service and the role that hints play in it./android.service.personalcontext.PersonalContextManager for a description of the personal context service and the role that hints play in it.)ERROR(for a general-purpose hint container./android.app.personalcontext.hint.BundleHint for a general-purpose hint container.)
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
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 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.
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
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
public final long getCreationTimeMillis ()
Gets the time this hint was created in milliseconds since epoch.
| Returns | |
|---|---|
long |
|
getHintId
public final UUID getHintId ()
Returns the unique ID of this hint.
| Returns | |
|---|---|
UUID |
This value cannot be null. |
getHintTypeName
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
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
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
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
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
equalsmethod, 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
equalsmethod, 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.
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |