1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.cli.processor.command; 28 29 import gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext; 30 import gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException; 31 import gov.nist.secauto.metaschema.core.util.CollectionUtil; 32 33 import org.apache.commons.cli.CommandLine; 34 import org.apache.commons.cli.Option; 35 36 import java.util.Collection; 37 import java.util.List; 38 39 import edu.umd.cs.findbugs.annotations.NonNull; 40 41 public interface ICommand { 42 @NonNull 43 String getName(); 44 45 @NonNull 46 String getDescription(); 47 48 @NonNull 49 default List<ExtraArgument> getExtraArguments() { 50 return CollectionUtil.emptyList(); 51 } 52 53 default int requiredExtraArgumentsCount() { 54 return (int) getExtraArguments().stream() 55 .filter(arg -> arg.isRequired()) 56 .count(); 57 } 58 59 @NonNull 60 default Collection<? extends Option> gatherOptions() { 61 // by default there are no options to handle 62 return CollectionUtil.emptyList(); 63 } 64 65 @NonNull 66 Collection<ICommand> getSubCommands(); 67 68 boolean isSubCommandRequired(); 69 70 @SuppressWarnings("unused") 71 default ICommand getSubCommandByName(@NonNull String name) { 72 // no sub commands by default 73 return null; 74 } 75 76 @SuppressWarnings("unused") 77 default void validateOptions( 78 @NonNull CallingContext callingContext, 79 @NonNull CommandLine cmdLine) throws InvalidArgumentException { 80 // by default there are no options to handle 81 } 82 83 @NonNull 84 ICommandExecutor newExecutor(@NonNull CallingContext callingContext, @NonNull CommandLine cmdLine); 85 }