AdSelectionOutcome
public
class
AdSelectionOutcome
extends Object
java.lang.Object | |
↳ | android.adservices.adselection.AdSelectionOutcome |
This class represents a field in the OutcomeReceiver
, which is an input to the AdSelectionManager.selectAds(AdSelectionConfig, Executor, OutcomeReceiver)
in the AdSelectionManager
. This field is populated in the
case of a successful AdSelectionManager#selectAds
call.
Empty outcome may be returned from AdSelectionManager.selectAds(android.adservices.adselection.AdSelectionFromOutcomesConfig, java.util.concurrent.Executor, android.os.OutcomeReceiver)
. Use
AdSelectionOutcome#hasOutcome()
to check if an instance has a valid outcome. When hasOutcome()
returns false
, results from #getAdSelectionId()
and AdSelectionOutcome#getRenderUri()
are invalid and shouldn't be
used.
Summary
Nested classes | |
---|---|
class |
AdSelectionOutcome.Builder
Builder for |
Fields | |
---|---|
public
static
final
AdSelectionOutcome |
NO_OUTCOME
Represents an AdSelectionOutcome with empty results. |
Public methods | |
---|---|
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
long
|
getAdSelectionId()
Returns the adSelectionId that identifies the AdSelection. |
Uri
|
getRenderUri()
Returns the renderUri that the AdSelection returns. |
boolean
|
hasOutcome()
Returns whether the outcome contains results or empty. |
int
|
hashCode()
Returns a hash code value for the object. |
Inherited methods | |
---|---|
Fields
NO_OUTCOME
public static final AdSelectionOutcome NO_OUTCOME
Represents an AdSelectionOutcome with empty results.
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAdSelectionId
public long getAdSelectionId ()
Returns the adSelectionId that identifies the AdSelection.
Returns | |
---|---|
long |
This value cannot be null . |
getRenderUri
public Uri getRenderUri ()
Returns the renderUri that the AdSelection returns.
Returns | |
---|---|
Uri |
This value cannot be null . |
hasOutcome
public boolean hasOutcome ()
Returns whether the outcome contains results or empty. Empty outcomes' render uris
shouldn't be used.
Returns | |
---|---|
boolean |
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
hashCode
method must consistently return the same integer, provided no information used inequals
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(Object)
method, then calling thehashCode
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(java.lang.Object)
method, then calling thehashCode
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.
As much as is reasonably practical, the hashCode method defined
by class Object
does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)
Returns | |
---|---|
int |
a hash code value for this object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-12-20 UTC.