001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.cli.processor; 028 029import org.apache.commons.cli.Option; 030import org.apache.commons.cli.ParseException; 031 032import edu.umd.cs.findbugs.annotations.NonNull; 033import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; 034 035public class InvalidArgumentException 036 extends ParseException { 037 038 /** 039 * the serial version UID. 040 */ 041 private static final long serialVersionUID = 1L; 042 043 /** The option that had the invalid argument. */ 044 private Option option; 045 046 /** 047 * Generate a new exception. 048 * 049 * @param message 050 * the message 051 */ 052 public InvalidArgumentException(String message) { 053 super(message); 054 } 055 056 /** 057 * Return the option requiring an argument that wasn't provided on the command 058 * line. 059 * 060 * @return the related option 061 */ 062 @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "intended to expose option for error handling") 063 public Option getOption() { 064 return option; 065 } 066 067 /** 068 * Assign the option requiring an argument that wasn't provided on the command 069 * line. 070 * 071 * @param option 072 * the option to set 073 */ 074 @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "intended to expose option for error handling") 075 public void setOption(@NonNull Option option) { 076 this.option = option; 077 } 078}