Package org.dellroad.jct.core.simple.command

Class SubshellCommand

java.lang.Object

org.dellroad.jct.core.simple.AbstractSimpleCommand

org.dellroad.jct.core.simple.command.SubshellCommand

All Implemented Interfaces:

SimpleCommand

Direct Known Subclasses:

JShellCommand

public class SubshellCommand
extends AbstractSimpleCommand

A command that fires up subshell sessions.

This command only works within shell sessions.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Shell	shell

Constructor Summary

Constructors

Constructor	Description
SubshellCommand(Shell shell, String usage, String summary, String detail)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected ShellRequest	buildShellRequest(ShellSession session, String name, List<String> params)	Create the subshell request.
protected ShellSession	createSubshell(ShellRequest request)	Create the subshell session.
int	execute(ConsoleSession<?,?> session0, String name, List<String> params)	Execute this command in the current thread and return success or failure.
protected int	executeSubshell(ShellSession session)	Execute the subshell session.

Methods inherited from class org.dellroad.jct.core.simple.AbstractSimpleCommand

getHelpDetail, getHelpSummary, getUsage, printUsage

Methods inherited from class java.lang.Object

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

Field Details

shell

protected final Shell shell

Constructor Details

SubshellCommand

public SubshellCommand(Shell shell,
 String usage,
 String summary,
 String detail)

Constructor.

Parameters:

shell - the subshell, which creates the underlying subshell sessions

usage - usage string, or null if command takes no arguments

summary - help summary

detail - help detail

Throws:

IllegalArgumentException - if shell, summary or detail is null

Method Details

execute

public int execute(ConsoleSession<?,?> session0,
 String name,
 List<String> params)
            throws InterruptedException

Description copied from interface: SimpleCommand

Execute this command in the current thread and return success or failure.

In the failure case, some error information should be written to standard error.

Parameters:

session0 - associated session

name - the name under which this command was invoked

params - zero or more command arguments (does not include command name)

Returns:

zero if successful, non-zero error code if an error occurred

Throws:

InterruptedException - if execution is interrupted

executeSubshell

protected int executeSubshell(ShellSession session)
                       throws InterruptedException

Execute the subshell session.

The implementation in SubshellCommand simply invokes ConsoleSession.execute().

Parameters:

session - subshell session

Returns:

subshell exit value

Throws:

InterruptedException - if execution is interrupted via ConsoleSession.interrupt()

IllegalArgumentException - if session is null

createSubshell

protected ShellSession createSubshell(ShellRequest request)
                               throws IOException

Create the subshell session.

Parameters:

request - subshell session request

Returns:

subshell session

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if request is null

buildShellRequest

protected ShellRequest buildShellRequest(ShellSession session,
 String name,
 List<String> params)

Create the subshell request.

Parameters:

session - outer shell session

name - command name

params - command parameters

Returns:

new shell request