Package org.openhab.core.io.console.karaf

Class OSGiConsole

java.lang.Object

org.openhab.core.io.console.karaf.OSGiConsole

All Implemented Interfaces:

Console

@NonNullByDefault
public class OSGiConsole
extends Object
implements Console

Author:

Markus Rathgeb - Initial contribution

Constructor Summary

Constructors

Constructor	Description
OSGiConsole(String scope, PrintStream out, org.apache.karaf.shell.api.console.Session session)

Method Summary

Modifier and Type	Method	Description
org.apache.karaf.shell.api.console.Session	getSession()
@Nullable String	getUser()	Returns the user name associated with the console, or null if no user is associated.
void	print(String s)	Prints a string to the console without appending a newline.
void	printf(String format, Object... args)	Prints formatted output to the console.
void	println(String s)	Prints a string to the console followed by a newline.
void	printUsage(String s)	usage output is treated differently from other output as it might differ between different kinds of consoles
String	readLine(String prompt, @Nullable Character mask)	Reads a line from the console.

Methods inherited from class java.lang.Object

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

Constructor Details

OSGiConsole

public OSGiConsole(String scope,
 PrintStream out,
 org.apache.karaf.shell.api.console.Session session)

Method Details

printf

public void printf(String format,
 Object... args)

Description copied from interface: Console

Prints formatted output to the console. This method formats the given string using the specified arguments and prints it to the console without appending a newline.

Specified by:

printf in interface Console

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) syntax)

args - the arguments referenced by the format specifiers in the format string

print

public void print(String s)

Description copied from interface: Console

Prints a string to the console without appending a newline.

Specified by:

print in interface Console

Parameters:

s - the string to print

println

public void println(String s)

Description copied from interface: Console

Prints a string to the console followed by a newline.

Specified by:

println in interface Console

Parameters:

s - the string to print

printUsage

public void printUsage(String s)

Description copied from interface: Console

usage output is treated differently from other output as it might differ between different kinds of consoles

Specified by:

printUsage in interface Console

Parameters:

s - the main usage string (console independent)

readLine

public String readLine(String prompt,
 @Nullable Character mask)
                throws IOException

Description copied from interface: Console

Reads a line from the console. The prompt is displayed before the line is read.

Specified by:

readLine in interface Console

Parameters:

prompt - the prompt to display

mask - the character to use for masking input (e.g. '*'), or null if no masking is required

Returns:

the line read from the console

Throws:

IOException - if an I/O error occurs

getUser

public @Nullable String getUser()

Description copied from interface: Console

Returns the user name associated with the console, or null if no user is associated.

Specified by:

getUser in interface Console

Returns:

the user name, or null if no user is associated

getSession

public org.apache.karaf.shell.api.console.Session getSession()