src/net/pterodactylus/fcp/highlevel/RequestListResult.java

   1 /*
   2  * jFCPlib-high-level-client - RequestListResult.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp.highlevel;
  21
  22 import java.util.ArrayList;
  23 import java.util.Collections;
  24 import java.util.Iterator;
  25 import java.util.List;
  26
  27 /**
  28  * The request list results lists all currently running requests on a node.
  29  *
  30  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  31  */
  32 public class RequestListResult extends HighLevelResult implements Iterable<RequestResult> {
  33
  34         /** The request results. */
  35         private List<RequestResult> requestResults = Collections.synchronizedList(new ArrayList<RequestResult>());
  36
  37         /**
  38          * Creates a new request list result.
  39          *
  40          * @param identifier
  41          *            The identifier of the request
  42          */
  43         RequestListResult(String identifier) {
  44                 super(identifier);
  45         }
  46
  47         /**
  48          * Adds a request result.
  49          *
  50          * @param requestResult
  51          *            The request result to add
  52          */
  53         void addRequestResult(RequestResult requestResult) {
  54                 requestResults.add(requestResult);
  55         }
  56
  57         /**
  58          * {@inheritDoc}
  59          */
  60         public Iterator<RequestResult> iterator() {
  61                 return requestResults.iterator();
  62         }
  63
  64         /**
  65          * Returns the request result at the given index.
  66          *
  67          * @param index
  68          *            The index of the request result
  69          * @return The request result
  70          */
  71         public RequestResult get(int index) {
  72                 return requestResults.get(index);
  73         }
  74
  75         /**
  76          * Returns the number of request results in this request list.
  77          *
  78          * @return The number of request results
  79          */
  80         public int size() {
  81                 return requestResults.size();
  82         }
  83
  84 }