Package org.jline.console

Class CommandRegistry.CommandSession

java.lang.Object

org.jline.console.CommandRegistry.CommandSession

Enclosing interface:

CommandRegistry

public static class CommandRegistry.CommandSession
extends Object

Class representing a command execution session.

A CommandSession encapsulates the terminal and I/O streams used for command execution. It provides access to the terminal, input stream, output stream, and error stream for the command being executed.

Field Summary

Fields

Modifier and Type	Field	Description
private final PrintStream	err	The error stream for the command session
private final InputStream	in	The input stream for the command session
private final PrintStream	out	The output stream for the command session
private final Terminal	terminal	The terminal for the command session

Constructor Summary

Constructors

Constructor	Description
CommandSession()	Creates a new command session with the system's standard I/O streams.
CommandSession(Terminal terminal)	Creates a new command session with the specified terminal.
CommandSession(Terminal terminal, InputStream in, PrintStream out, PrintStream err)	Creates a new command session with the specified terminal and I/O streams.

Method Summary

Modifier and Type	Method	Description
PrintStream	err()	Returns the error stream for the command session.
InputStream	in()	Returns the input stream for the command session.
PrintStream	out()	Returns the output stream for the command session.
Terminal	terminal()	Returns the terminal for the command session.

Methods inherited from class java.lang.Object

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

Field Details

terminal

private final Terminal terminal

The terminal for the command session

in

private final InputStream in

The input stream for the command session

out

private final PrintStream out

The output stream for the command session

err

private final PrintStream err

The error stream for the command session

Constructor Details

CommandSession

public CommandSession()

Creates a new command session with the system's standard I/O streams. The terminal will be null in this case.

CommandSession

public CommandSession(Terminal terminal)

Creates a new command session with the specified terminal. The I/O streams will be derived from the terminal.

Parameters:

terminal - the terminal for the command session

CommandSession

public CommandSession(Terminal terminal,
 InputStream in,
 PrintStream out,
 PrintStream err)

Creates a new command session with the specified terminal and I/O streams.

Parameters:

terminal - the terminal for the command session

in - the input stream for the command session

out - the output stream for the command session

err - the error stream for the command session

Method Details

terminal

public Terminal terminal()

Returns the terminal for the command session.

Returns:

the terminal, or null if no terminal is associated with this session

in

public InputStream in()

Returns the input stream for the command session.

Returns:

the input stream

out

public PrintStream out()

Returns the output stream for the command session.

Returns:

the output stream

err

public PrintStream err()

Returns the error stream for the command session.

Returns:

the error stream