/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.cli.framework;

import java.util.HashMap;
import java.util.Iterator;
import java.io.Serializable;

/**
 * The class holds the list of ValidCommand's
 *      @version  $Revision: 1.4 $
 */
public class ValidCommandsList implements Serializable
{

    private HashMap validCommands = null;
    
    /** Creates new ValidCommandsList */
    public ValidCommandsList() 
    {
        validCommands = new HashMap();
    }

    
    /**
     * Returns the ValidCommand that macthes the parameter command name
     * @param commandName The name of the command that should be checked in the list
     * @return ValidCommand The ValidCommand object
     */
    public ValidCommand getValidCommand(String commandName) 
    {
        return (ValidCommand) validCommands.get(commandName);
    }
 
    
    /**
     * Return the list of ValidCommand's
     */
    public Iterator getCommands()
    {
        return validCommands.values().iterator();
    }
    
    
    /**
     * Return the number of commands in the list
    **/
    public int size()
    {
        return validCommands.size();
    }
 
    
     /** Adds the ValidCommand to ValidCommandsList
     * @param command The Valid command to be added to the list
     */
    public void addCommand(ValidCommand command)
    {
        validCommands.put(command.getName(), command);
    }

    
    /** Removes all commands from this list
     */
    public void removeAllCommands()
    {
        validCommands.clear();
    }
}