TWiki/TWikiAggregateIteratorDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::_AggregateIterat"></a> Package =TWiki::AggregateIterator
   2
   3 combine multiple iterators
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::_AggregateIterat"> Package TWiki::AggregateIterator</a><ul>
   8         <li><a href="#new(\@list, $unique)"> new(\@list, $unique)</a></li>
   9         <li><a href="#hasNext() -> $boolean"> hasNext() -&gt; $boolean</a></li>
  10         <li><a href="#next() -> $data"> next() -&gt; $data</a></li>
  11       </ul>
  12     </li>
  13   </ul>
  14 </div>
  15
  16 ## <a name="new(\@list, $unique)"></a> new(\\@list, $unique)
  17
  18 Create a new iterator over the given list of iterators. The list is not damaged in any way.
  19
  20 if $unique is set, we try to not repeat values. Warning: $unique assumes that the values are strings (so works for cUID's )
  21
  22 ## <a name="hasNext() - $boolean"></a> hasNext() -&gt; $boolean
  23
  24 Returns false when the iterator is exhausted.
  25
  26     my $it = new TWiki::ListIterator(\@list);
  27     while ($it->hasNext()) {
  28        ...
  29
  30 ## <a name="next() - $data"></a> next() -&gt; $data
  31
  32 Return the next entry in the list.
  33
  34 The iterator object can be customised to pre- and post-process entries from the list before returning them. This is done by setting two fields in the iterator object:
  35
  36 - `{filter}` can be defined to be a sub that filters each entry. The entry will be ignored (next() will not return it) if the filter returns false.
  37 - `{process}` can be defined to be a sub to process each entry before it is returned by next. The value returned from next is the value returned by the process function.