Page Summary
-
AdParamIterator is an iterator for ad params.
-
It includes methods like
hasNext()to check for more elements,next()to get the next AdParam, andtotalNumEntities()to see the total number of matched entities. -
A typical usage involves a while loop checking
hasNext()and callingnext().
Typical usage:
while ( adParamIterator . hasNext ()) { var adParam = adParamIterator . next (); }
Methods:
| Member | Type | Description |
|---|---|---|
boolean
|
Returns true
if the iterator has more elements. |
|
AdsApp.AdParam
|
Returns the next AdParam in the iterator. | |
int
|
Returns the total number of entities matched by the selector which generated this iterator. |
hasNext()
Returns true
if the iterator has more elements. Return values:
| Type | Description |
|---|---|
boolean
|
true
if the iterator has more elements. |
next()
Returns the next AdParam
in the iterator. Return values:
| Type | Description |
|---|---|
AdsApp.AdParam
|
The next AdParam in the iterator. |
totalNumEntities()
Returns the total number of entities matched by the selector which
generated this iterator. Note that the returned number disregards limits, and that the iterator
is not guaranteed to have this many elements — hasNext
will
start to return false
and next
will start to
throw exceptions as soon as the limit for entity reads has been reached,
even if the selector matched more entities.
Return values:
| Type | Description |
|---|---|
int
|
The number of entities matched by the selector which generated this iterator. |
