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;

import java.util.List;
import java.util.Iterator;


Thrown when a required option has not been provided.

Version:$Id: MissingOptionException.java 1443102 2013-02-06 18:12:16Z tn $
/**
 * Thrown when a required option has not been provided.
 *
 * @version $Id: MissingOptionException.java 1443102 2013-02-06 18:12:16Z tn $
 */
public class MissingOptionException extends ParseException
{
    
This exception serialVersionUID. 
/** This exception {@code serialVersionUID}. */
    private static final long serialVersionUID = 8161889051578563249L;

    
The list of missing options and groups 
/** The list of missing options and groups */
    private List missingOptions;

    
Construct a new MissingSelectedException
with the specified detail message.

Params:
  • message – the detail message
/**
     * Construct a new <code>MissingSelectedException</code>
     * with the specified detail message.
     *
     * @param message the detail message
     */
    public MissingOptionException(String message)
    {
        super(message);
    }

    
Constructs a new MissingSelectedException with the
specified list of missing options.

Params:
  • missingOptions – the list of missing options and groups
Since:1.2
/**
     * Constructs a new <code>MissingSelectedException</code> with the
     * specified list of missing options.
     *
     * @param missingOptions the list of missing options and groups
     * @since 1.2
     */
    public MissingOptionException(List missingOptions)
    {
        this(createMessage(missingOptions));
        this.missingOptions = missingOptions;
    }

    
Returns the list of options or option groups missing in the command line parsed.

Returns:the missing options, consisting of String instances for simple
        options, and OptionGroup instances for required option groups.
Since:1.2
/**
     * Returns the list of options or option groups missing in the command line parsed.
     *
     * @return the missing options, consisting of String instances for simple
     *         options, and OptionGroup instances for required option groups.
     * @since 1.2
     */
    public List getMissingOptions()
    {
        return missingOptions;
    }

    
Build the exception message from the specified list of options.

Params:
  • missingOptions – the list of missing options and groups
Since:1.2
/**
     * Build the exception message from the specified list of options.
     *
     * @param missingOptions the list of missing options and groups
     * @since 1.2
     */
    private static String createMessage(List<?> missingOptions)
    {
        StringBuilder buf = new StringBuilder("Missing required option");
        buf.append(missingOptions.size() == 1 ? "" : "s");
        buf.append(": ");

        Iterator<?> it = missingOptions.iterator();
        while (it.hasNext())
        {
            buf.append(it.next());
            if (it.hasNext())
            {
                buf.append(", ");
            }
        }

        return buf.toString();
    }
}