com.nhl.bootique.cli.Cli Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bootique Show documentation

Bootique is a simple DI-based framework for launching command-line Java applications of any kind. Be it webservices, webapps, jobs, etc.

There is a newer version: 0.18

Show newest version

package com.nhl.bootique.cli;

import java.io.Writer;
import java.util.List;

/**
 * An object that represents a set of command-line options passed to the
 * Bootique app.
 * 
 * @since 0.12
 */
public interface Cli {

	/**
	 * Returns the name of the command to run, possibly derived from options or
	 * standalone arguments.
	 */
	String commandName();

	// TODO: this probably does not belong here.. instead we should be able to
	// extract all options and print them using external renderer
	void printHelp(Writer out);

	boolean hasOption(String name);

	/**
	 * Returns a List of String values for the specified option name.
	 * 
	 * @param name
	 *            option name
	 * @return a potentially empty collection of CLI values for a given option.
	 */
	List optionStrings(String name);

	/**
	 * Returns a single value for option or null if not present.
	 * 
	 * @param name
	 *            option name.
	 * @return a single value for option or null if not present.
	 * @throws RuntimeException
	 *             if there's more then one value for the option.
	 */
	String optionString(String name);

	/**
	 * Returns all arguments that are not options or option values in the order
	 * they are encountered on the command line.
	 */
	List standaloneArguments();
}