Replies.java

/*
 * Copyright 2005 Joe Walker
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
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<Reply>
{
    /**
     * @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<Reply> 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<Reply> replies = new ArrayList<Reply>();
}