Modifier and Type	Class and Description
public static class	JConsole.BlockingPipedInputStream The overridden read method in this class will not throw "Broken pipe" IOExceptions; It will simply wait for new writers and data.

Modifier and Type	Field and Description
private int	cmdStart
private static final String	COPY
private static final String	CUT
private DefaultStyledDocument	doc
private boolean	gotUp
private int	histLine
private Vector<E>	history
private InputStream	in
private InputStream	inPipe
private JPopupMenu	menu
pack-priv NameCompletion	nameCompletion
private PrintStream	out
private OutputStream	outPipe
private static final String	PASTE
pack-priv final int	SHOW_AMBIG_MAX
private String	startedLine
private JTextPane	text
pack-priv String	ZEROS

Access	Constructor and Description
public	JConsole()
public	JConsole(InputStream cin, OutputStream cout)

Method Summary

Modifier and Type	Method and Description
private void	acceptLine(String line)
public void	actionPerformed(ActionEvent the event to be processed event) Implements java.awt.event.ActionListener.actionPerformed. Invoked when an action occurs.
private void	append(String string)
private void	doCommandCompletion(String part)
private void	enter()
public void	error(Object o) Implements bsh.ConsoleInterface.error.
private void	forceCaretMoveToEnd()
private void	forceCaretMoveToStart()
private String	getCmd()
public PrintStream	getErr() Implements bsh.ConsoleInterface.getErr.
public Reader	getIn() Implements bsh.ConsoleInterface.getIn.
public InputStream	getInputStream()
public PrintStream	getOut() Implements bsh.ConsoleInterface.getOut.
private AttributeSet	getStyle()
private void	historyDown()
private void	historyUp()
private void	inPipeWatcher()
private void	invokeAndWait(Runnable run) If not in the event thread run via SwingUtilities.invokeAndWait()
public void	keyPressed(KeyEvent the event to be processed e) Implements java.awt.event.KeyListener.keyPressed. Invoked when a key has been pressed.
public void	keyReleased(KeyEvent the event to be processed e) Implements java.awt.event.KeyListener.keyReleased. Invoked when a key has been released.
public void	keyTyped(KeyEvent the event to be processed e) Implements java.awt.event.KeyListener.keyTyped. Invoked when a key has been typed.
public void	mouseClicked(MouseEvent the event to be processed event) Implements java.awt.event.MouseListener.mouseClicked. Invoked when the mouse button has been clicked (pressed and released) on a component.
public void	mouseEntered(MouseEvent the event to be processed event) Implements java.awt.event.MouseListener.mouseEntered. Invoked when the mouse enters a component.
public void	mouseExited(MouseEvent the event to be processed event) Implements java.awt.event.MouseListener.mouseExited. Invoked when the mouse exits a component.
public void	mousePressed(MouseEvent the event to be processed event) Implements java.awt.event.MouseListener.mousePressed. Invoked when a mouse button has been pressed on a component.
public void	mouseReleased(MouseEvent the event to be processed event) Implements java.awt.event.MouseListener.mouseReleased. Invoked when a mouse button has been released on a component.
public void	print(final Object o) Implements bsh.ConsoleInterface.print.
public void	print(final Icon icon)
public void	print(Object s, Font font)
public void	print(Object s, Color color) Implements bsh.util.GUIConsoleInterface.print.
public void	print(final Object o, final Font font, final Color color)
public void	print(Object s, String fontFamilyName, int size, Color color)
public void	print(final Object o, final String fontFamilyName, final int size, final Color color, final boolean bold, final boolean italic, final boolean underline)
public void	println(Object o) Implements bsh.ConsoleInterface.println.
public void	println() Prints "\\n" (i.e. newline)
public void	println(Icon icon)
public void	propertyChange(PropertyChangeEvent A PropertyChangeEvent object describing the event source and the property that has changed. event) Implements java.beans.PropertyChangeListener.propertyChange. This method gets called when a bound property is changed.
private String	replaceRange(Object s, int start, int end)
public void	requestFocus() Overrides javax.swing.JComponent.requestFocus. Requests that this `Component` gets the input focus.
private void	resetCommandStart()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public void	setFont(Font the desired `Font` for this component font) Overrides javax.swing.JComponent.setFont. Sets the font for this component.
public void	setNameCompletion(NameCompletion nc) Implements bsh.util.GUIConsoleInterface.setNameCompletion.
private AttributeSet	setStyle(Font font)
private AttributeSet	setStyle(Color color)
private AttributeSet	setStyle(Font font, Color color)
private AttributeSet	setStyle(String fontFamilyName, int size, Color color)
private AttributeSet	setStyle(String fontFamilyName, int size, Color color, boolean bold, boolean italic, boolean underline)
private void	setStyle(AttributeSet attributes)
private void	setStyle(AttributeSet attributes, boolean overWrite)
public void	setWaitFeedback(boolean on) Implements bsh.util.GUIConsoleInterface.setWaitFeedback. e.g. the wait cursor
private void	showHistoryLine()
private int	textLength()
public String	toString() Overrides java.awt.Component.toString. Returns a string representation of this component and its values.
private synchronized void	type(KeyEvent e)

Field Detail

cmdStart	back to summary
private int cmdStart

COPY	back to summary
private static final String COPY

CUT	back to summary
private static final String CUT

doc	back to summary
private DefaultStyledDocument doc

gotUp	back to summary
private boolean gotUp

histLine	back to summary
private int histLine

history	back to summary
private Vector<E> history

in	back to summary
private InputStream in

inPipe	back to summary
private InputStream inPipe

menu	back to summary
private JPopupMenu menu

nameCompletion	back to summary
pack-priv NameCompletion nameCompletion

out	back to summary
private PrintStream out

outPipe	back to summary
private OutputStream outPipe

PASTE	back to summary
private static final String PASTE

SHOW_AMBIG_MAX	back to summary
pack-priv final int SHOW_AMBIG_MAX

startedLine	back to summary
private String startedLine

text	back to summary
private JTextPane text

ZEROS	back to summary
pack-priv String ZEROS

Constructor Detail

JConsole	back to summary
public JConsole()

JConsole	back to summary
public JConsole(InputStream cin, OutputStream cout)

Method Detail

acceptLine	back to summary
private void acceptLine(String line)

actionPerformed	back to summary
public void actionPerformed(ActionEvent event) Implements java.awt.event.ActionListener.actionPerformed. Doc from java.awt.event.ActionListener.actionPerformed. Invoked when an action occurs. Parameters event:ActionEvent the event to be processed

actionPerformed

back to summary

public void actionPerformed(ActionEvent event)

Implements java.awt.event.ActionListener.actionPerformed.

Doc from java.awt.event.ActionListener.actionPerformed.

Invoked when an action occurs.

Parameters

event:ActionEvent: the event to be processed

append	back to summary
private void append(String string)

doCommandCompletion	back to summary
private void doCommandCompletion(String part)

enter	back to summary
private void enter()

error	back to summary
public void error(Object o) Implements bsh.ConsoleInterface.error.

forceCaretMoveToEnd	back to summary
private void forceCaretMoveToEnd()

forceCaretMoveToStart	back to summary
private void forceCaretMoveToStart()

getCmd	back to summary
private String getCmd()

getErr	back to summary
public PrintStream getErr() Implements bsh.ConsoleInterface.getErr.

getIn	back to summary
public Reader getIn() Implements bsh.ConsoleInterface.getIn.

getInputStream	back to summary
public InputStream getInputStream()

getOut	back to summary
public PrintStream getOut() Implements bsh.ConsoleInterface.getOut.

getStyle	back to summary
private AttributeSet getStyle()

historyDown	back to summary
private void historyDown()

historyUp	back to summary
private void historyUp()

inPipeWatcher	back to summary
private void inPipeWatcher() throws IOException

invokeAndWait	back to summary
private void invokeAndWait(Runnable run) If not in the event thread run via SwingUtilities.invokeAndWait()

keyPressed back to summary

keyPressed	back to summary
public void keyPressed(KeyEvent e) Implements java.awt.event.KeyListener.keyPressed. Doc from java.awt.event.KeyListener.keyPressed. Invoked when a key has been pressed. See the class description for `KeyEvent` for a definition of a key pressed event. Parameters e:KeyEvent the event to be processed

public void keyPressed(KeyEvent e)

Implements java.awt.event.KeyListener.keyPressed.

Doc from java.awt.event.KeyListener.keyPressed.

Invoked when a key has been pressed. See the class description for KeyEvent for a definition of a key pressed event.

Parameters

e:KeyEvent: the event to be processed

keyReleased back to summary

keyReleased	back to summary
public void keyReleased(KeyEvent e) Implements java.awt.event.KeyListener.keyReleased. Doc from java.awt.event.KeyListener.keyReleased. Invoked when a key has been released. See the class description for `KeyEvent` for a definition of a key released event. Parameters e:KeyEvent the event to be processed

public void keyReleased(KeyEvent e)

Implements java.awt.event.KeyListener.keyReleased.

Doc from java.awt.event.KeyListener.keyReleased.

Invoked when a key has been released. See the class description for KeyEvent for a definition of a key released event.

Parameters

e:KeyEvent: the event to be processed

keyTyped back to summary

keyTyped	back to summary
public void keyTyped(KeyEvent e) Implements java.awt.event.KeyListener.keyTyped. Doc from java.awt.event.KeyListener.keyTyped. Invoked when a key has been typed. See the class description for `KeyEvent` for a definition of a key typed event. Parameters e:KeyEvent the event to be processed

public void keyTyped(KeyEvent e)

Implements java.awt.event.KeyListener.keyTyped.

Doc from java.awt.event.KeyListener.keyTyped.

Invoked when a key has been typed. See the class description for KeyEvent for a definition of a key typed event.

Parameters

e:KeyEvent: the event to be processed

mouseClicked	back to summary
public void mouseClicked(MouseEvent event) Implements java.awt.event.MouseListener.mouseClicked. Doc from java.awt.event.MouseListener.mouseClicked. Invoked when the mouse button has been clicked (pressed and released) on a component. Parameters event:MouseEvent the event to be processed

mouseClicked

back to summary

public void mouseClicked(MouseEvent event)

Implements java.awt.event.MouseListener.mouseClicked.

Doc from java.awt.event.MouseListener.mouseClicked.

Invoked when the mouse button has been clicked (pressed and released) on a component.

Parameters

event:MouseEvent: the event to be processed

mouseEntered	back to summary
public void mouseEntered(MouseEvent event) Implements java.awt.event.MouseListener.mouseEntered. Doc from java.awt.event.MouseListener.mouseEntered. Invoked when the mouse enters a component. Parameters event:MouseEvent the event to be processed

mouseEntered

back to summary

public void mouseEntered(MouseEvent event)

Implements java.awt.event.MouseListener.mouseEntered.

Doc from java.awt.event.MouseListener.mouseEntered.

Invoked when the mouse enters a component.

Parameters

event:MouseEvent: the event to be processed

mouseExited	back to summary
public void mouseExited(MouseEvent event) Implements java.awt.event.MouseListener.mouseExited. Doc from java.awt.event.MouseListener.mouseExited. Invoked when the mouse exits a component. Parameters event:MouseEvent the event to be processed

mouseExited

back to summary

public void mouseExited(MouseEvent event)

Implements java.awt.event.MouseListener.mouseExited.

Doc from java.awt.event.MouseListener.mouseExited.

Invoked when the mouse exits a component.

Parameters

event:MouseEvent: the event to be processed

mousePressed	back to summary
public void mousePressed(MouseEvent event) Implements java.awt.event.MouseListener.mousePressed. Doc from java.awt.event.MouseListener.mousePressed. Invoked when a mouse button has been pressed on a component. Parameters event:MouseEvent the event to be processed

mousePressed

back to summary

public void mousePressed(MouseEvent event)

Implements java.awt.event.MouseListener.mousePressed.

Doc from java.awt.event.MouseListener.mousePressed.

Invoked when a mouse button has been pressed on a component.

Parameters

event:MouseEvent: the event to be processed

mouseReleased	back to summary
public void mouseReleased(MouseEvent event) Implements java.awt.event.MouseListener.mouseReleased. Doc from java.awt.event.MouseListener.mouseReleased. Invoked when a mouse button has been released on a component. Parameters event:MouseEvent the event to be processed

mouseReleased

back to summary

public void mouseReleased(MouseEvent event)

Implements java.awt.event.MouseListener.mouseReleased.

Doc from java.awt.event.MouseListener.mouseReleased.

Invoked when a mouse button has been released on a component.

Parameters

event:MouseEvent: the event to be processed

print	back to summary
public void print(final Object o) Implements bsh.ConsoleInterface.print.

print	back to summary
public void print(final Icon icon)

print	back to summary
public void print(Object s, Font font)

print	back to summary
public void print(Object s, Color color) Implements bsh.util.GUIConsoleInterface.print.

print	back to summary
public void print(final Object o, final Font font, final Color color)

print	back to summary
public void print(Object s, String fontFamilyName, int size, Color color)

print	back to summary
public void print(final Object o, final String fontFamilyName, final int size, final Color color, final boolean bold, final boolean italic, final boolean underline)

println	back to summary
public void println(Object o) Implements bsh.ConsoleInterface.println.

println	back to summary
public void println() Prints "\\n" (i.e. newline)

println	back to summary
public void println(Icon icon)

propertyChange

back to summary

public void propertyChange(PropertyChangeEvent event)

Implements java.beans.PropertyChangeListener.propertyChange.

Doc from java.beans.PropertyChangeListener.propertyChange.

This method gets called when a bound property is changed.

Parameters

event:PropertyChangeEvent: A PropertyChangeEvent object describing the event source and the property that has changed.

replaceRange	back to summary
private String replaceRange(Object s, int start, int end)

requestFocus back to summary

public void requestFocus()

Overrides javax.swing.JComponent.requestFocus.

Doc from javax.swing.JComponent.requestFocus.

Requests that this Component gets the input focus. Refer to Component.requestFocus() for a complete description of this method.

Note that the use of this method is discouraged because its behavior is platform dependent. Instead we recommend the use of requestFocusInWindow(). If you would like more information on focus, see How to Use the Focus Subsystem, a section in The Java Tutorial.

resetCommandStart	back to summary
private void resetCommandStart()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

setFont back to summary

public void setFont(Font font)

Overrides javax.swing.JComponent.setFont.

Doc from javax.swing.JComponent.setFont.

Sets the font for this component.

Parameters

font:Font: the desired Font for this component

setNameCompletion	back to summary
public void setNameCompletion(NameCompletion nc) Implements bsh.util.GUIConsoleInterface.setNameCompletion.

setStyle	back to summary
private AttributeSet setStyle(Font font)

setStyle	back to summary
private AttributeSet setStyle(Color color)

setStyle	back to summary
private AttributeSet setStyle(Font font, Color color)

setStyle	back to summary
private AttributeSet setStyle(String fontFamilyName, int size, Color color)

setStyle	back to summary
private AttributeSet setStyle(String fontFamilyName, int size, Color color, boolean bold, boolean italic, boolean underline)

setStyle	back to summary
private void setStyle(AttributeSet attributes)

setStyle	back to summary
private void setStyle(AttributeSet attributes, boolean overWrite)

setWaitFeedback

back to summary

public void setWaitFeedback(boolean on)

Implements bsh.util.GUIConsoleInterface.setWaitFeedback.

Doc from bsh.util.GUIConsoleInterface.setWaitFeedback.

e.g. the wait cursor

showHistoryLine	back to summary
private void showHistoryLine()

textLength	back to summary
private int textLength()

toString

back to summary

public String toString()

Overrides java.awt.Component.toString.

Doc from java.awt.Component.toString.

Returns a string representation of this component and its values.

Returns:String: a string representation of this component

type	back to summary
private synchronized void type(KeyEvent e)

bsh.util back to summary

public Class JConsole.BlockingPipedInputStream

Class Inheritance

extends PipedInputStream

java.lang.Object
java.io.InputStream
java.io.PipedInputStream
bsh.util.JConsole.BlockingPipedInputStream

The overridden read method in this class will not throw "Broken pipe" IOExceptions; It will simply wait for new writers and data. This is used by the JConsole internal read thread to allow writers in different (and in particular ephemeral) threads to write to the pipe. It also checks a little more frequently than the original read().

Warning

read() will not even error on a read to an explicitly closed pipe (override closed to for that).

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	closed

Inherited from java.io.PipedInputStream:: buffer in out PIPE_SIZE

Constructor Summary

Access	Constructor and Description
public	BlockingPipedInputStream(PipedOutputStream pout)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.PipedInputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public synchronized int	read() Overrides java.io.PipedInputStream.read. Reads the next byte of data from this piped input stream.

Inherited from java.io.PipedInputStream:: available connect read receive

Field Detail

closed	back to summary
pack-priv boolean closed

Constructor Detail

BlockingPipedInputStream	back to summary
public BlockingPipedInputStream(PipedOutputStream pout) throws IOException

Method Detail

back to summary

public void close() throws IOException

Overrides java.io.PipedInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.PipedInputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

public synchronized int read() throws IOException

Overrides java.io.PipedInputStream.read.

Doc from java.io.PipedInputStream.read.

Reads the next byte of data from this piped input stream. The value byte is returned as an int in the range 0 to 255. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if the pipe is unconnected, broken, closed, or if an I/O error occurs.

public Class JConsole

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class JConsole.BlockingPipedInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail