http://commons.apache.org/proper/commons-cli/: Apache Commons CLI provides a simple API for presenting, processing and validating a command line interface. (The Apache Software Foundation)
  • Beluga Behr
  • Peter Donald
  • Brian Egge
  • Duncan Jones
  • Berin Loritsch
  • Peter Maddocks (Hewlett-Packard)
  • Alexandru Mocanu
  • Andrew Shirley
  • Greg Thomas
  • Slawek Zachcial
  • James Strachan (SpiritSoft, Inc.)
  • Bob McWhirter (Werken)
  • John Keyes (integral Source)
  • Rob Oxspring (Indigo Stone)
  • Emmanuel Bourg (Ariane Software)
  • Thomas Neidhart 
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.cli;


A class that implements the CommandLineParser interface can parse a String array according to the Options specified and return a CommandLine. 
Version:$Id: CommandLineParser.java 1443102 2013-02-06 18:12:16Z tn $
/**
 * A class that implements the <code>CommandLineParser</code> interface
 * can parse a String array according to the {@link Options} specified
 * and return a {@link CommandLine}.
 *
 * @version $Id: CommandLineParser.java 1443102 2013-02-06 18:12:16Z tn $
 */
public interface CommandLineParser
{
    
Parse the arguments according to the specified options.

Params:
  • options – the specified Options
  • arguments – the command line arguments
Throws:
  • ParseException – if there are any problems encountered
while parsing the command line tokens.
Returns:the list of atomic option and value tokens
/**
     * Parse the arguments according to the specified options.
     *
     * @param options the specified Options
     * @param arguments the command line arguments
     * @return the list of atomic option and value tokens
     *
     * @throws ParseException if there are any problems encountered
     * while parsing the command line tokens.
     */
    CommandLine parse(Options options, String[] arguments) throws ParseException;

    /**
     * Parse the arguments according to the specified options and
     * properties.
     *
     * @param options the specified Options
     * @param arguments the command line arguments
     * @param properties command line option name-value pairs
     * @return the list of atomic option and value tokens
     *
     * @throws ParseException if there are any problems encountered
     * while parsing the command line tokens.
     */
    /* To maintain binary compatibility, this is commented out.
       It is still in the abstract Parser class, so most users will
       still reap the benefit.
    CommandLine parse(Options options, String[] arguments, Properties properties)
               throws ParseException;
     */

    
Parse the arguments according to the specified options.

Params:
  • options – the specified Options
  • arguments – the command line arguments
  • stopAtNonOption – if true an unrecognized argument stops the parsing and the remaining arguments are added to the CommandLines args list. If false an unrecognized
    argument triggers a ParseException.
Throws:
  • ParseException – if there are any problems encountered
while parsing the command line tokens.
Returns:the list of atomic option and value tokens
/**
     * Parse the arguments according to the specified options.
     *
     * @param options the specified Options
     * @param arguments the command line arguments
     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
     *     the parsing and the remaining arguments are added to the 
     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
     *     argument triggers a ParseException.
     *
     * @return the list of atomic option and value tokens
     * @throws ParseException if there are any problems encountered
     * while parsing the command line tokens.
     */
    CommandLine parse(Options options, String[] arguments, boolean stopAtNonOption) throws ParseException;

    /**
     * Parse the arguments according to the specified options and
     * properties.
     *
     * @param options the specified Options
     * @param arguments the command line arguments
     * @param properties command line option name-value pairs
     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
     *     the parsing and the remaining arguments are added to the 
     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
     *     argument triggers a ParseException.
     *
     * @return the list of atomic option and value tokens
     * @throws ParseException if there are any problems encountered
     * while parsing the command line tokens.
     */
    /* To maintain binary compatibility, this is commented out.
       It is still in the abstract Parser class, so most users will
       still reap the benefit.
    CommandLine parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption)
            throws ParseException;
     */
}