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.command;
028
029import gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext;
030import gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException;
031import gov.nist.secauto.metaschema.core.util.CollectionUtil;
032
033import org.apache.commons.cli.CommandLine;
034import org.apache.commons.cli.Option;
035
036import java.util.Collection;
037import java.util.List;
038
039import edu.umd.cs.findbugs.annotations.NonNull;
040
041public interface ICommand {
042  @NonNull
043  String getName();
044
045  @NonNull
046  String getDescription();
047
048  @NonNull
049  default List<ExtraArgument> getExtraArguments() {
050    return CollectionUtil.emptyList();
051  }
052
053  default int requiredExtraArgumentsCount() {
054    return (int) getExtraArguments().stream()
055        .filter(arg -> arg.isRequired())
056        .count();
057  }
058
059  @NonNull
060  default Collection<? extends Option> gatherOptions() {
061    // by default there are no options to handle
062    return CollectionUtil.emptyList();
063  }
064
065  @NonNull
066  Collection<ICommand> getSubCommands();
067
068  boolean isSubCommandRequired();
069
070  @SuppressWarnings("unused")
071  default ICommand getSubCommandByName(@NonNull String name) {
072    // no sub commands by default
073    return null;
074  }
075
076  @SuppressWarnings("unused")
077  default void validateOptions(
078      @NonNull CallingContext callingContext,
079      @NonNull CommandLine cmdLine) throws InvalidArgumentException {
080    // by default there are no options to handle
081  }
082
083  @NonNull
084  ICommandExecutor newExecutor(@NonNull CallingContext callingContext, @NonNull CommandLine cmdLine);
085}