Package org.springframework.shell.core

Class InteractiveShellRunner

java.lang.Object

org.springframework.shell.core.InteractiveShellRunner

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, ShellRunner

Direct Known Subclasses:

JLineShellRunner, SystemShellRunner

public abstract class InteractiveShellRunner
extends Object
implements ShellRunner, org.springframework.beans.factory.DisposableBean

Base class for interactive shell runners. Implementations must provide concrete methods to print messages and flush the output.

Since:

4.0.0

Author:

Mahmoud Ben Hassine, David Pilar

Constructor Summary

Constructors

Constructor	Description
InteractiveShellRunner(InputProvider inputProvider, CommandParser commandParser, CommandRegistry commandRegistry)	Create a new InteractiveShellRunner instance.

Method Summary

Modifier and Type	Method	Description
void	destroy()
abstract void	flush()	Flush the output.
abstract InputReader	getReader()	Get the input reader.
abstract PrintWriter	getWriter()	Get the writer to the output.
abstract void	print(String message)	Print a message to the output.
void	run(String[] args)	Execute ShellRunner with given args.
void	setDebugMode(boolean debugMode)	Set debug mode.
void	stop()	Signal the runner to stop and wait briefly for its thread to exit.
protected void	wakeup()	Unblock a parked InputProvider.readInput() so stop() can return.

Methods inherited from class java.lang.Object

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

Constructor Details

InteractiveShellRunner

public InteractiveShellRunner(InputProvider inputProvider,
 CommandParser commandParser,
 CommandRegistry commandRegistry)

Create a new InteractiveShellRunner instance.

Parameters:

inputProvider - the input provider

commandParser - the command parser

commandRegistry - the command registry

Method Details

run

public void run(String[] args)
         throws Exception

Description copied from interface: ShellRunner

Execute ShellRunner with given args.

Specified by:

run in interface ShellRunner

Parameters:

args - the raw arguments

Throws:

Exception - possible error during run

print

public abstract void print(String message)

Print a message to the output.

Parameters:

message - the message to print

flush

public abstract void flush()

Flush the output.

getWriter

public abstract PrintWriter getWriter()

Get the writer to the output.

Returns:

the print writer

getReader

public abstract InputReader getReader()

Get the input reader.

Returns:

the input reader

setDebugMode

public void setDebugMode(boolean debugMode)

Set debug mode.

Parameters:

debugMode - true to enable debug mode, false otherwise

stop

public void stop()

Signal the runner to stop and wait briefly for its thread to exit.

wakeup

protected void wakeup()

Unblock a parked InputProvider.readInput() so stop() can return.

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean