/*************************************************************************
 *                                                                       *
 *  EJBCA Community: The OpenSource Certificate Authority                *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.ejbca.util;

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

/** Tools used in command line handling
 * @version $Id: CliTools.java 22117 2015-10-29 10:53:42Z mikekushner $
 */
public class CliTools {

    /**
     * Using Arrays.asList will return an AbstractList that you cannot remove items from. This List is backed by a new ArrayList.
     * 
     * Example usage for parsing argument switches:
     *  public void method(String[] args) {
     *   List<String> argsList = getAsModifyableList(args);
     *   boolean switch1 = argsList.remove("-switch1");
     *   boolean switch2 = argsList.remove("-switch2");
     *   args = argsList.toArray(new String[0]);
     *   ...
     *  }
     */
    public static List<String> getAsModifyableList(String[] stringArray) {
    	List<String> list = new ArrayList<String>();
    	for (String string : stringArray) {
    		list.add(string);
    	}
    	return list;
    }
    
    /** 
     * Returns the next string after the specified parameter if the switch exists and null otherwise.
     * The switch and the following value is removed from the supplied list.
     */
    public static String getAndRemoveParameter(String parameter, List<String> modifyableList) {
        String ret = null;
        int index = modifyableList.indexOf(parameter);
        if (index > -1) {
            ret = modifyableList.get(index + 1);
            modifyableList.remove(index + 1);
            modifyableList.remove(index);
        }
        return ret;
    }
    
    /** @return true if the parameter was present and removes it from the list. */
    public static boolean getAndRemoveSwitch(final String parameter, List<String> modifyableList) {
        final int index = modifyableList.indexOf(parameter);
        if (index > -1) {
            modifyableList.remove(index);
            return true;
        }
        return false;
    }
    
    /** @return the remaining list as a regular args[] array */
    public static String[] getAsArgs(List<String> modifyableList) {
        return modifyableList.toArray(new String[modifyableList.size()]);
    }
}