org.jboss.aesh.console

Class AeshCompletionHandler

java.lang.Object

org.jboss.aesh.console.AeshCompletionHandler

All Implemented Interfaces:

CompletionHandler

public class AeshCompletionHandler
extends java.lang.Object
implements CompletionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private AeshContext	aeshContext
private AliasManager	aliasManager
private boolean	askDisplayCompletion
private java.util.List<Completion>	completionList
private ConsoleBuffer	consoleBuffer
private int	displayCompletionSize
private boolean	doLogging
private boolean	enabled
private static java.util.logging.Logger	LOGGER
private Shell	shell

Constructor Summary

Constructors

Constructor and Description
AeshCompletionHandler(AeshContext aeshContext, ConsoleBuffer consoleBuffer, Shell shell, boolean doLogging)

Method Summary

Modifier and Type	Method and Description
void	addCompletion(Completion completion)
void	complete(java.io.PrintStream out, Buffer buffer) Display possible completions.
private void	displayCompletion(TerminalString completion, Buffer buffer, java.io.PrintStream out, boolean appendSpace, char separator) Display the completion string in the terminal.
private void	displayCompletions(java.util.List<TerminalString> completions, Buffer buffer, java.io.PrintStream out) Display all possible completions
boolean	doAskDisplayCompletion()
private CompleteOperation	findAliases(java.lang.String buffer, int cursor)
int	getAskCompletionSize()
void	removeCompletion(Completion completion)
void	setAliasManager(AliasManager aliasManager)
void	setAskCompletionSize(int size)
void	setAskDisplayCompletion(boolean askDisplayCompletion)
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Field Detail

enabled

private volatile boolean enabled

aeshContext

private final AeshContext aeshContext

askDisplayCompletion

private boolean askDisplayCompletion

displayCompletionSize

private int displayCompletionSize

completionList

private final java.util.List<Completion> completionList

aliasManager

private AliasManager aliasManager

consoleBuffer

private final ConsoleBuffer consoleBuffer

shell

private final Shell shell

doLogging

private final boolean doLogging

LOGGER

private static final java.util.logging.Logger LOGGER

Constructor Detail

AeshCompletionHandler

public AeshCompletionHandler(AeshContext aeshContext,
                             ConsoleBuffer consoleBuffer,
                             Shell shell,
                             boolean doLogging)

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface CompletionHandler

addCompletion

public void addCompletion(Completion completion)

Specified by:

addCompletion in interface CompletionHandler

removeCompletion

public void removeCompletion(Completion completion)

Specified by:

removeCompletion in interface CompletionHandler

doAskDisplayCompletion

public boolean doAskDisplayCompletion()

Specified by:

doAskDisplayCompletion in interface CompletionHandler

setAskDisplayCompletion

public void setAskDisplayCompletion(boolean askDisplayCompletion)

Specified by:

setAskDisplayCompletion in interface CompletionHandler

setAskCompletionSize

public void setAskCompletionSize(int size)

Specified by:

setAskCompletionSize in interface CompletionHandler

getAskCompletionSize

public int getAskCompletionSize()

Specified by:

getAskCompletionSize in interface CompletionHandler

setAliasManager

public void setAliasManager(AliasManager aliasManager)

Specified by:

setAliasManager in interface CompletionHandler

complete

public void complete(java.io.PrintStream out,
                     Buffer buffer)
              throws java.io.IOException

Display possible completions. 1. Find all possible completions 2. If we find only one, display it. 3. If we find more than one, display them, but not more than 100 at once

Specified by:

complete in interface CompletionHandler

Throws:

java.io.IOException - stream

displayCompletion

private void displayCompletion(TerminalString completion,
                               Buffer buffer,
                               java.io.PrintStream out,
                               boolean appendSpace,
                               char separator)
                        throws java.io.IOException

Display the completion string in the terminal. If !completion.startsWith(buffer.getLine()) the completion will be added to the line, else it will replace whats at the buffer line.

Parameters:

completion - partial completion

appendSpace - if its an actual complete

Throws:

java.io.IOException - stream

displayCompletions

private void displayCompletions(java.util.List<TerminalString> completions,
                                Buffer buffer,
                                java.io.PrintStream out)
                         throws java.io.IOException

Display all possible completions

Parameters:

completions - all completion items

Throws:

java.io.IOException - stream

findAliases

private CompleteOperation findAliases(java.lang.String buffer,
                                      int cursor)