ClaypotType.java

/*
 * Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.claypot.core;

import com.beust.jcommander.JCommander;

import java.util.SortedMap;

/**
 * The main wrapper over {@link JCommander}.
 */

public interface ClaypotType
{
  /**
   * @return The exit code resulting from the most recent {@link #execute(String[])}
   */

  int exitCode();

  /**
   * Execute the wrapper for the given command-line arguments.
   *
   * @param args The command-line arguments
   */

  void execute(String[] args);

  /**
   * @return The available commands, by name
   */

  SortedMap<String, CLPCommandType> commands();
}