package votorola.a.response.line; // Copyright 2008-2009, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import java.util.*;
import java.util.regex.*;
import votorola.g.lang.*;
import votorola.g.option.*;


/** Utilities for the command-line administrative interface.
  *
  *     @see <a href='../../../../../../s/manual.xht#Line'
  *                              >../../s/manual.xht#Line</a>
  */
public @ThreadSafe final class CommandLine
{

    private CommandLine() {}



    /** Matches and groups a single command argument, delimited by whitepace.
      */
    public static final Pattern COMMAND_ARGUMENT_PATTERN = Pattern.compile( "\\s*(\\S+)" );



    /** Compiles a map of options that are common to all command line executables.
      */
    public static HashMap<String,Option> compileBaseOptions()
    {
        final HashMap<String,Option> optionMap = new HashMap<String,Option>();
        String name;

      // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        name = "help";
        optionMap.put( name, new Option( name, Option.NO_ARGUMENT ));

      // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        name = "verbose";
        optionMap.put( name, new Option( name, Option.NO_ARGUMENT ));

      // - - -
        return optionMap;
    }


}