org.crsh.processor.jline
Class JLineProcessContext

java.lang.Object
  org.crsh.processor.jline.JLineProcessContext

All Implemented Interfaces:

ShellProcessContext

 class JLineProcessContext
extends Object
implements ShellProcessContext

Author:

Julien Viet

Field Summary

(package private) CountDownLatch	latch .
private static Character	NO_ECHO .
(package private) JLineProcessor	processor .
(package private) AtomicReference<ShellResponse>	resp .

Constructor Summary

JLineProcessContext(JLineProcessor processor)

Method Summary

void	end(ShellResponse response) This method is invoked when the process ends.
String	getProperty(String name) Returns the property defined within this context.
int	getWidth() Returns the term width in chars.
String	readLine(String msg, boolean echo) A callback made by the process when it needs to read a line of text on the term.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ECHO

private static final Character NO_ECHO

.

processor

final JLineProcessor processor

.

latch

final CountDownLatch latch

.

resp

final AtomicReference<ShellResponse> resp

.

Constructor Detail

JLineProcessContext

public JLineProcessContext(JLineProcessor processor)

Method Detail

getWidth

public int getWidth()

Description copied from interface: ShellProcessContext

Returns the term width in chars. When the value is not positive it means the value could not be determined.

Specified by:

getWidth in interface ShellProcessContext

Returns:

the term width

getProperty

public String getProperty(String name)

Description copied from interface: ShellProcessContext

Returns the property defined within this context.

Specified by:

getProperty in interface ShellProcessContext

Parameters:

name - the name of the property

Returns:

the value of the property

readLine

public String readLine(String msg,
                       boolean echo)

Description copied from interface: ShellProcessContext

A callback made by the process when it needs to read a line of text on the term.

Specified by:

readLine in interface ShellProcessContext

Parameters:

msg - the message to display prior reading the term

echo - whether the input line should be echoed or not

Returns:

the line read or null if no line was possible to be read

end

public void end(ShellResponse response)

Description copied from interface: ShellProcessContext

This method is invoked when the process ends.

Specified by:

end in interface ShellProcessContext

Parameters:

response - the shell response