001package 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.
002
003import java.util.*;
004import java.util.regex.*;
005import votorola.g.lang.*;
006import votorola.g.option.*;
007
008
009/** Utilities for the command-line administrative interface.
010  *
011  *     @see <a href='../../../../../../s/manual.xht#Line'
012  *                              >../../s/manual.xht#Line</a>
013  */
014public @ThreadSafe final class CommandLine
015{
016
017    private CommandLine() {}
018
019
020
021    /** Matches and groups a single command argument, delimited by whitepace.
022      */
023    public static final Pattern COMMAND_ARGUMENT_PATTERN = Pattern.compile( "\\s*(\\S+)" );
024
025
026
027    /** Compiles a map of options that are common to all command line executables.
028      */
029    public static HashMap<String,Option> compileBaseOptions()
030    {
031        final HashMap<String,Option> optionMap = new HashMap<String,Option>();
032        String name;
033
034      // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
035        name = "help";
036        optionMap.put( name, new Option( name, Option.NO_ARGUMENT ));
037
038      // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
039        name = "verbose";
040        optionMap.put( name, new Option( name, Option.NO_ARGUMENT ));
041
042      // - - -
043        return optionMap;
044    }
045
046
047}