| /** |
| * 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. |
| * |
| * @author John Keyes ( john at integralsource.com ) |
| * @version $Revision$, $Date$ |
| */ |
| public class MissingOptionException extends ParseException |
| { |
| /** The list of missing options */ |
| private List missingOptions; |
| |
| /** |
| * 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 <code>MissingSelectedException</code> with the |
| * specified list of missing options. |
| * |
| * @param missingOptions the list of missing options |
| * @since 1.2 |
| */ |
| public MissingOptionException(List missingOptions) |
| { |
| this(createMessage(missingOptions)); |
| this.missingOptions = missingOptions; |
| } |
| |
| /** |
| * Return the list of options (as strings) missing in the command line parsed. |
| * |
| * @return the missing options |
| * @since 1.2 |
| */ |
| public List getMissingOptions() |
| { |
| return missingOptions; |
| } |
| |
| /** |
| * Build the exception message from the specified list of options. |
| * |
| * @param missingOptions |
| * @since 1.2 |
| */ |
| private static String createMessage(List missingOptions) |
| { |
| StringBuffer buff = new StringBuffer("Missing required option"); |
| buff.append(missingOptions.size() == 1 ? "" : "s"); |
| buff.append(": "); |
| |
| Iterator it = missingOptions.iterator(); |
| while (it.hasNext()) |
| { |
| buff.append(it.next()); |
| if (it.hasNext()) |
| { |
| buff.append(", "); |
| } |
| } |
| |
| return buff.toString(); |
| } |
| } |