org.directwebremoting.extend.Replies Maven / Gradle / Ivy

Go to download
package org.directwebremoting.extend;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * The request made by the browser which consists of a number of function call
 * requests and some associated information like the request mode (XHR or
 * iframe).
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public class Replies implements Iterable
{
    /**
     * @param calls The set of calls to that we are the reply to
     */
    public Replies(Calls calls)
    {
        this.calls = calls;
    }

    /**
     * How many replies are there is this request
     * @return The total number of replies
     */
    public int getReplyCount()
    {
        return replies.size();
    }

    /**
     * @param index The index (starts at 0) of the reply to fetch
     * @return Returns the replies.
     */
    public Reply getReply(int index)
    {
        return replies.get(index);
    }

    /**
     * Add a reply to the collection of replies we are about to make
     * @param reply The reply to add
     */
    public void addReply(Reply reply)
    {
        replies.add(reply);
    }

    /**
     * @return Returns the batchId.
     */
    public Calls getCalls()
    {
        return calls;
    }

    /* (non-Javadoc)
     * @see java.lang.Iterable#iterator()
     */
    public Iterator iterator()
    {
        return replies.iterator();
    }

    /**
     * The calls that we are the reply to
     */
    private final Calls calls;

    /**
     * The collection of Replies that we should execute
     */
    private final List replies = new ArrayList();
}