Package org.openhab.core.io.console

Class ConsoleInterpreter

java.lang.Object

org.openhab.core.io.console.ConsoleInterpreter

@NonNullByDefault
public class ConsoleInterpreter
extends Object

This class provides generic methods for handling console input (i.e. pure strings).

Author:

Kai Kreuzer - Initial contribution, Markus Rathgeb - Change interface

Constructor Summary

Constructors

Constructor	Description
ConsoleInterpreter()

Method Summary

Modifier and Type	Method	Description
static void	execute(Console console, ConsoleCommandExtension extension, String[] args)
static String	getHelp(String base, String separator, Collection<ConsoleCommandExtension> extensions)
static String	getUsage(Collection<ConsoleCommandExtension> consoleCommandExtensions)	returns a CR-separated list of usage texts for all available commands
static List<String>	getUsages(Collection<ConsoleCommandExtension> consoleCommandExtensions)	returns an array of the usage texts for all available commands
static void	printHelp(Console console, String base, String separator, Collection<ConsoleCommandExtension> extensions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConsoleInterpreter

public ConsoleInterpreter()

Method Details

getHelp

public static String getHelp(String base,
 String separator,
 Collection<ConsoleCommandExtension> extensions)

printHelp

public static void printHelp(Console console,
 String base,
 String separator,
 Collection<ConsoleCommandExtension> extensions)

execute

public static void execute(Console console,
 ConsoleCommandExtension extension,
 String[] args)

getUsage

public static String getUsage(Collection<ConsoleCommandExtension> consoleCommandExtensions)

returns a CR-separated list of usage texts for all available commands

getUsages

public static List<String> getUsages(Collection<ConsoleCommandExtension> consoleCommandExtensions)

returns an array of the usage texts for all available commands