dev.nokee.core.exec

Interface CommandLineToolProvider

public interface CommandLineToolProvider

A command line tool provider if available.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
static CommandLineToolProvider	from(Supplier<CommandLineTool> toolSupplier) Creates a provider from the specified command line tool supplier.
CommandLineTool	get() Returns the command line tool provided by this provider.
boolean	isAvailable() Returns the availability of the command line tool providered.
static CommandLineToolProvider	of(CommandLineTool tool) Creates a fixed provider of the specified command line tool.
static CommandLineToolProvider	unavailable() Creates an unavailable provider.

Method Detail

get

CommandLineTool get()

Returns the command line tool provided by this provider.

Returns:

a CommandLineTool instance or throws IllegalArgumentException if no command line tool can be provided.

isAvailable

boolean isAvailable()

Returns the availability of the command line tool providered.

Returns:

true if the command line tool is available or false otherwise.

of

static CommandLineToolProvider of(CommandLineTool tool)

Creates a fixed provider of the specified command line tool. Calling get() will return the specified command line tool.

Parameters:

tool - a command line tool to provide.

Returns:

a CommandLineToolProvider instance for the specified tool

unavailable

static CommandLineToolProvider unavailable()

Creates an unavailable provider. Calling get() will throw an exception.

Returns:

a CommandLineToolProvider instance that is unavailable.

from

static CommandLineToolProvider from(Supplier<CommandLineTool> toolSupplier)

Creates a provider from the specified command line tool supplier. Calling get() will throw an exception only if the supplier returns null.

Parameters:

toolSupplier - a supplier for the tool provided.

Returns:

a CommandLineToolProvider instance for the specified tool supplier.