/* ======================================================================
   Parts Copyright 2006 University of Leeds, Oxford University, University of the Highlands and Islands.

   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.bodington.server;

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


/**
 * Class that should be thrown when an error is encountered that should be show
 * to the user but probably doesn't need to be logged.
 * We also allow a list of user errors that can be nicely formatted and 
 * displayed to the user.
 * @author buckett
 * @see org.bodington.servlet.facilities.Utils#writeUserExceptionHTML(BuildingServerUserException, PrintWriter)
 */
public class BuildingServerUserException extends BuildingServerException
{

    private List messages = new ArrayList();;
    
    /**
     * Create a new BuildingServerUserException.
     * @param s The error message that will probably be show to the user.
     */
    public BuildingServerUserException(String s)
    {
        super(s);
    }
    
    public void addMessage(String message)
    {
        messages.add(message);
    }
    
    public void addMessages(Collection messages)
    {
        this.messages.addAll(messages);
    }
    
    public Iterator iterator()
    {
        return messages.iterator();
     }


}