Skip navigation links
?sh 0.33.7
A B C D E F G H I K L M N O P Q R S T U V W Y 

A

AbstractTerminal - Class in org.jboss.aesh.terminal
 
Action - Enum in org.jboss.aesh.edit.actions
User actions
addAlias(String, String) - Method in class org.jboss.aesh.console.alias.AliasManager
 
addArgument(String) - Method in class org.jboss.aesh.cl.CommandLine
 
addCompletion(Completion) - Method in class org.jboss.aesh.console.Console
Add a Completion to the completion list
addCompletionCandidate(String) - Method in class org.jboss.aesh.complete.CompleteOperation
 
addCompletionCandidates(List<String>) - Method in class org.jboss.aesh.complete.CompleteOperation
 
addCompletions(List<Completion>) - Method in class org.jboss.aesh.console.Console
Add a list of completions to the completion list
addOperation(KeyOperation) - Method in class org.jboss.aesh.edit.KeyOperationManager
 
addOperations(List<KeyOperation>) - Method in class org.jboss.aesh.edit.KeyOperationManager
 
addOption(ParsedOption) - Method in class org.jboss.aesh.cl.CommandLine
 
addOption(OptionInt) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
addOption(char, String, String, boolean, String, boolean, boolean, Class<?>) - Method in class org.jboss.aesh.cl.internal.ParameterInt
Add an option Name or longName can be null Both argument and type can be null
addOption(char, String, String, boolean) - Method in class org.jboss.aesh.cl.internal.ParameterInt
Add an option Name or longName can be null
addOption(OptionInt) - Method in class org.jboss.aesh.cl.ParameterBuilder
 
addOptions(List<OptionInt>) - Method in class org.jboss.aesh.cl.ParameterBuilder
 
addParameter(ParameterInt) - Method in class org.jboss.aesh.cl.CommandLineParser
 
addParameter(ParameterInt) - Method in class org.jboss.aesh.cl.ParserBuilder
 
addProperty(String, String) - Method in class org.jboss.aesh.cl.internal.OptionInt
 
addText(StringBuilder) - Method in class org.jboss.aesh.edit.PasteManager
 
addUndo(UndoAction) - Method in class org.jboss.aesh.undo.UndoManager
 
addValue(String) - Method in class org.jboss.aesh.cl.internal.OptionInt
 
afterAttach() - Method in class org.jboss.aesh.console.ConsoleCommand
Called after attach(..) is called.
afterDetach() - Method in class org.jboss.aesh.console.ConsoleCommand
Called after detach() is called
Alias - Class in org.jboss.aesh.console.alias
Alias value object
Alias(String, String) - Constructor for class org.jboss.aesh.console.alias.Alias
 
AliasCompletion - Class in org.jboss.aesh.console.alias
 
AliasCompletion(AliasManager) - Constructor for class org.jboss.aesh.console.alias.AliasCompletion
 
AliasManager - Class in org.jboss.aesh.console.alias
Manages Aliases
AliasManager(File) - Constructor for class org.jboss.aesh.console.alias.AliasManager
 
ANSI - Class in org.jboss.aesh.util
Utility class to provide ANSI codes for different operations
argument(String) - Method in class org.jboss.aesh.cl.OptionBuilder
 
argumentType(Class<?>) - Method in class org.jboss.aesh.cl.ParameterBuilder
 
asAnsi() - Method in class org.jboss.aesh.terminal.CursorPosition
 
attach(ConsoleOutput) - Method in class org.jboss.aesh.console.ConsoleCommand
Called by creator of the process Calls afterAttach()
attachProcess(ConsoleCommand) - Method in class org.jboss.aesh.console.Console
Used by ConsoleCommand to attach itself to the Console

B

blackBackground() - Static method in class org.jboss.aesh.util.ANSI
 
blackText() - Static method in class org.jboss.aesh.util.ANSI
 
blueBackground() - Static method in class org.jboss.aesh.util.ANSI
 
blueText() - Static method in class org.jboss.aesh.util.ANSI
 
Buffer - Class in org.jboss.aesh.console
A simple buffer to keep track of one line in the console and the cursor position.
Buffer() - Constructor for class org.jboss.aesh.console.Buffer
 
Buffer(Prompt) - Constructor for class org.jboss.aesh.console.Buffer
Instantiate a Buffer with given prompt
Buffer(Prompt, Character) - Constructor for class org.jboss.aesh.console.Buffer
 

C

changeCase() - Method in class org.jboss.aesh.console.Buffer
Switch case if the current character is a letter.
CharacterType - Enum in org.jboss.aesh.terminal
Define what kind of character type to display
clean() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
clean() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
clear() - Method in class org.jboss.aesh.console.Buffer
 
clear() - Method in class org.jboss.aesh.console.Console
Clear a ansi terminal
clear(boolean) - Method in class org.jboss.aesh.console.Console
Clear an ansi terminal.
clear() - Method in class org.jboss.aesh.edit.KeyOperationManager
 
clear() - Method in interface org.jboss.aesh.history.History
 
clear() - Method in class org.jboss.aesh.history.InMemoryHistory
 
clear() - Method in class org.jboss.aesh.terminal.AbstractTerminal
 
clear() - Method in interface org.jboss.aesh.terminal.Terminal
clears the screen
clear() - Method in class org.jboss.aesh.terminal.TestTerminal
 
clear() - Method in class org.jboss.aesh.undo.UndoManager
 
clearScreen() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
clearScreen() - Static method in class org.jboss.aesh.util.ANSI
 
Color - Enum in org.jboss.aesh.terminal
 
CommandLine - Class in org.jboss.aesh.cl
A parsed String based on the provided Parameter and Options defined in a CommandLineParser.
CommandLine() - Constructor for class org.jboss.aesh.cl.CommandLine
 
CommandLineCompletionParser - Class in org.jboss.aesh.cl
 
CommandLineCompletionParser(CommandLineParser) - Constructor for class org.jboss.aesh.cl.CommandLineCompletionParser
 
CommandLineParser - Class in org.jboss.aesh.cl
A simple command line parser.
CommandLineParser(List<ParameterInt>) - Constructor for class org.jboss.aesh.cl.CommandLineParser
 
CommandLineParser(ParameterInt) - Constructor for class org.jboss.aesh.cl.CommandLineParser
 
CommandLineParser(String, String) - Constructor for class org.jboss.aesh.cl.CommandLineParser
 
compareTo(Object) - Method in class org.jboss.aesh.console.alias.Alias
 
complete(CompleteOperation) - Method in interface org.jboss.aesh.complete.Completion
Populate the CompleteOperation object with possible completions + offset if needed
complete(CompleteOperation) - Method in class org.jboss.aesh.console.alias.AliasCompletion
 
complete(CompleteOperation) - Method in class org.jboss.aesh.console.operator.RedirectionCompletion
 
CompleteOperation - Class in org.jboss.aesh.complete
A payload object to store completion data
CompleteOperation(String, int) - Constructor for class org.jboss.aesh.complete.CompleteOperation
 
Completion - Interface in org.jboss.aesh.complete
To enable auto completion, commands need to implement this interface.
Config - Class in org.jboss.aesh.console
 
Config() - Constructor for class org.jboss.aesh.console.Config
 
Console - Class in org.jboss.aesh.console
A console reader.
Console() - Constructor for class org.jboss.aesh.console.Console
 
Console(Settings) - Constructor for class org.jboss.aesh.console.Console
 
console - Variable in class org.jboss.aesh.console.ConsoleCommand
 
ConsoleCommand - Class in org.jboss.aesh.console
A ConsoleCommand is the base of any "external" commands that will run in the foreground of aesh.
ConsoleCommand(Console) - Constructor for class org.jboss.aesh.console.ConsoleCommand
 
ConsoleInputSession - Class in org.jboss.aesh.console.reader
 
ConsoleInputSession(InputStream) - Constructor for class org.jboss.aesh.console.reader.ConsoleInputSession
 
ConsoleOperation - Class in org.jboss.aesh.console
 
ConsoleOperation(ControlOperator, String) - Constructor for class org.jboss.aesh.console.ConsoleOperation
 
ConsoleOutput - Class in org.jboss.aesh.console
Value object returned by Console when newline is pressed If the command is part of a pipeline sequence the stdOut and stdErr is populated accordingly
ConsoleOutput(ConsoleOperation) - Constructor for class org.jboss.aesh.console.ConsoleOutput
 
ConsoleOutput(ConsoleOperation, String, String) - Constructor for class org.jboss.aesh.console.ConsoleOutput
 
containNewLine(int[]) - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
containRedirection() - Method in class org.jboss.aesh.console.Buffer
 
ControlOperator - Enum in org.jboss.aesh.console.operator
A token that performs a control function.
ControlOperatorParser - Class in org.jboss.aesh.console.operator
Parser class for everything that contain operator and pipelines
ControlOperatorParser() - Constructor for class org.jboss.aesh.console.operator.ControlOperatorParser
 
create() - Method in class org.jboss.aesh.cl.OptionBuilder
 
CursorPosition - Class in org.jboss.aesh.terminal
Define the position of the cursor in a terminal 1:1 is upper left corner.
CursorPosition(int, int) - Constructor for class org.jboss.aesh.terminal.CursorPosition
 
cyanBackground() - Static method in class org.jboss.aesh.util.ANSI
 
cyanText() - Static method in class org.jboss.aesh.util.ANSI
 

D

defaultBackground() - Static method in class org.jboss.aesh.util.ANSI
 
defaultText() - Static method in class org.jboss.aesh.util.ANSI
 
delete(int, int) - Method in class org.jboss.aesh.console.Buffer
 
DeleteAction - Class in org.jboss.aesh.edit.actions
 
DeleteAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.DeleteAction
 
DeleteAction(int, Action, boolean) - Constructor for class org.jboss.aesh.edit.actions.DeleteAction
 
description(String) - Method in class org.jboss.aesh.cl.OptionBuilder
 
detach() - Method in class org.jboss.aesh.console.ConsoleCommand
Mark this process ready to be detached from console.
disablePrompt(boolean) - Method in class org.jboss.aesh.console.Buffer
Need to disable prompt in calculations involving search.
doAction(String) - Method in class org.jboss.aesh.edit.actions.DeleteAction
 
doAction(String) - Method in class org.jboss.aesh.edit.actions.EditAction
Perform an action
doAction(String) - Method in class org.jboss.aesh.edit.actions.NextSpaceWordAction
 
doAction(String) - Method in class org.jboss.aesh.edit.actions.NextWordAction
 
doAction(String) - Method in class org.jboss.aesh.edit.actions.PrevSpaceWordAction
 
doAction(String) - Method in class org.jboss.aesh.edit.actions.PrevWordAction
 
doAction(String) - Method in class org.jboss.aesh.edit.actions.SimpleAction
 
doAppendSeparator(boolean) - Method in class org.jboss.aesh.complete.CompleteOperation
Set if this CompletionOperation would allow an separator to be appended.
doDisplayOptions() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
doReadInputrc() - Method in class org.jboss.aesh.console.settings.Settings
Should we read config from inputrc Set to true by default
doStringContainPipeline(String) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
Used when parsing a complete
doStringContainRedirectionNoPipeline(String) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
 
doWordContainEscapedSpace(String) - Static method in class org.jboss.aesh.util.Parser
 
doWordContainOnlyEscapedSpace(String) - Static method in class org.jboss.aesh.util.Parser
 

E

EditAction - Class in org.jboss.aesh.edit.actions
 
EditAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.EditAction
 
EditActionManager - Class in org.jboss.aesh.edit.actions
 
EditActionManager() - Constructor for class org.jboss.aesh.edit.actions.EditActionManager
 
EditMode - Interface in org.jboss.aesh.edit
 
EmacsEditMode - Class in org.jboss.aesh.edit
Trying to follow the Emacs mode GNU Readline impl found here: http://cnswww.cns.cwru.edu/php/chet/readline/readline.html
EmacsEditMode(KeyOperationManager) - Constructor for class org.jboss.aesh.edit.EmacsEditMode
 
enableAlternateScreen() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
enableMainScreen() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
equals(Object) - Method in class org.jboss.aesh.console.alias.Alias
 
equals(Object) - Method in class org.jboss.aesh.console.ConsoleOperation
 
equals(Object) - Method in class org.jboss.aesh.edit.KeyOperation
 
equals(Object) - Method in class org.jboss.aesh.terminal.CursorPosition
 
equals(Object) - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
equals(Object) - Method in class org.jboss.aesh.terminal.TerminalSize
 
equalsIgnoreCharacter(TerminalCharacter) - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
equalValues(int[]) - Method in class org.jboss.aesh.edit.KeyOperation
 
Example - Class in <Unnamed>
 
Example() - Constructor for class Example
 

F

FileHistory - Class in org.jboss.aesh.history
Read the history file at init and writeToStdOut to it at shutdown
FileHistory(String, int) - Constructor for class org.jboss.aesh.history.FileHistory
 
FileLister - Class in org.jboss.aesh.util
Helper class to list possible files during a complete operation.
FileLister(String, File) - Constructor for class org.jboss.aesh.util.FileLister
 
FileUtils - Class in org.jboss.aesh.util
Helper to find proper files/directories given partial paths/filenames.
FileUtils() - Constructor for class org.jboss.aesh.util.FileUtils
 
find(String) - Method in interface org.jboss.aesh.history.History
 
find(String) - Method in class org.jboss.aesh.history.InMemoryHistory
 
findAllControlOperators(String) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
Parse buffer and find all RedirectionOperations
findAllMatchingNames(String) - Method in class org.jboss.aesh.console.alias.AliasManager
 
findAllOccurrences(String, String) - Static method in class org.jboss.aesh.util.Parser
 
findAllWords(String) - Static method in class org.jboss.aesh.util.Parser
 
findCompleteObject(String) - Method in class org.jboss.aesh.cl.CommandLineCompletionParser
1.
findEscapedSpaceWordCloseToEnd(String) - Static method in class org.jboss.aesh.util.Parser
Search backwards for a non-escaped space and only return work containing non-escaped space
findFirstWord(String) - Static method in class org.jboss.aesh.util.Parser
If string contain space, return the text before the first space.
findIfWordEndWithSpace(String) - Static method in class org.jboss.aesh.util.Parser
 
findLastPipelinePositionBeforeCursor(String, int) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
Used when finding the correct word to base complete on
findLastRedirectionPositionBeforeCursor(String, int) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
Used when finding the correct word to base operator complete on
findLongOption(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
findMatchingDirectories(CompleteOperation) - Method in class org.jboss.aesh.util.FileLister
findMatchingDirectories will try to populate the CompleteOperation object based on it initial params.
findOperation(List<KeyOperation>, int[]) - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
findOperation(int[]) - Method in class org.jboss.aesh.edit.KeyOperationManager
 
findOption(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
findPossibleLongNamesWitdDash(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
findStartsWith(List<String>) - Static method in class org.jboss.aesh.util.Parser
Return the biggest common startsWith string
findStartsWithOperation(List<CompleteOperation>) - Static method in class org.jboss.aesh.util.Parser
If there is any common start string in the completion list, return it
findWordClosestToCursor(String, int) - Static method in class org.jboss.aesh.util.Parser
Return the word "connected" to cursor Note that cursor position starts at 0
formatDisplayList(String[], int, int) - Static method in class org.jboss.aesh.util.Parser
Format completions so that they look similar to GNU Readline
formatDisplayList(List<String>, int, int) - Static method in class org.jboss.aesh.util.Parser
Format completions so that they look similar to GNU Readline

G

generateParameter() - Method in class org.jboss.aesh.cl.ParameterBuilder
 
generateParser() - Method in class org.jboss.aesh.cl.ParserBuilder
 
generateParser(Class<?>...) - Static method in class org.jboss.aesh.cl.ParserGenerator
 
generatePOSIXEmacsMode() - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
generatePOSIXViMode() - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
generateWindowsEmacsMode() - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
generateWindowsViMode() - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
get(int) - Method in class org.jboss.aesh.edit.PasteManager
 
get(int) - Method in interface org.jboss.aesh.history.History
 
get(int) - Method in class org.jboss.aesh.history.InMemoryHistory
 
getAction() - Method in class org.jboss.aesh.edit.actions.EditAction
 
getAction() - Method in enum org.jboss.aesh.edit.actions.Operation
 
getAlias(String) - Method in class org.jboss.aesh.console.alias.AliasManager
 
getAliasFile() - Method in class org.jboss.aesh.console.settings.Settings
 
getAll() - Method in interface org.jboss.aesh.history.History
 
getAll() - Method in class org.jboss.aesh.history.InMemoryHistory
 
getAllNames() - Method in class org.jboss.aesh.console.alias.AliasManager
 
getAlternateBufferScreen() - Static method in class org.jboss.aesh.util.ANSI
 
getArgument() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getArguments() - Method in class org.jboss.aesh.cl.CommandLine
 
getArgumentType() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
getAsString(TerminalCharacter) - Method in class org.jboss.aesh.terminal.TerminalCharacter
type, text color, background color
getAsString() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
getBackgroundColor() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
getBackgroundColor() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
getBellStyle() - Method in class org.jboss.aesh.console.settings.Settings
By default, bell style is noisy NOTE: Not implemented yet
getBlink() - Static method in class org.jboss.aesh.util.ANSI
 
getBlinkOff() - Static method in class org.jboss.aesh.util.ANSI
 
getBold() - Static method in class org.jboss.aesh.util.ANSI
 
getBoldOff() - Static method in class org.jboss.aesh.util.ANSI
 
getBuffer() - Method in class org.jboss.aesh.complete.CompleteOperation
 
getBuffer() - Method in class org.jboss.aesh.console.ConsoleOperation
 
getBuffer() - Method in class org.jboss.aesh.console.ConsoleOutput
 
getBuffer() - Method in class org.jboss.aesh.undo.UndoAction
 
getCharacter() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
getCharacters() - Method in class org.jboss.aesh.console.Prompt
 
getColumn() - Method in class org.jboss.aesh.terminal.CursorPosition
 
getCommand() - Method in enum org.jboss.aesh.console.InternalCommands
 
getCompletionCandidates() - Method in class org.jboss.aesh.complete.CompleteOperation
 
getConsoleOutput() - Method in class org.jboss.aesh.console.ConsoleCommand
 
getControlOperator() - Method in class org.jboss.aesh.console.ConsoleOperation
 
getControlOperator() - Method in class org.jboss.aesh.console.ConsoleOutput
 
getCurrent() - Method in interface org.jboss.aesh.history.History
 
getCurrent() - Method in class org.jboss.aesh.history.InMemoryHistory
 
getCurrentAction() - Method in interface org.jboss.aesh.edit.EditMode
 
getCurrentAction() - Method in class org.jboss.aesh.edit.EmacsEditMode
 
getCurrentAction() - Method in class org.jboss.aesh.edit.ViEditMode
 
getCurrentCursorPos() - Static method in class org.jboss.aesh.util.ANSI
 
getCursor() - Method in class org.jboss.aesh.complete.CompleteOperation
 
getCursor() - Method in class org.jboss.aesh.console.Buffer
 
getCursor() - Method in class org.jboss.aesh.terminal.AbstractTerminal
Return the row position if we use a ansi terminal Send a terminal: '[6n' and we receive the position as: '[n;mR' where n = current row and m = current column
getCursor() - Method in interface org.jboss.aesh.terminal.Terminal
 
getCursor() - Method in class org.jboss.aesh.terminal.TestTerminal
 
getCursorPosition() - Method in class org.jboss.aesh.undo.UndoAction
 
getCursorWithPrompt() - Method in class org.jboss.aesh.console.Buffer
 
getDelta() - Method in class org.jboss.aesh.console.Buffer
 
getDescription() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getEditMode() - Method in class org.jboss.aesh.console.settings.Settings
Either Emacs or Vi mode.
getEnd() - Method in class org.jboss.aesh.edit.actions.EditAction
 
getExternalInputStream() - Method in class org.jboss.aesh.console.reader.ConsoleInputSession
 
getFirstValue() - Method in class org.jboss.aesh.edit.KeyOperation
 
getForegroundColor() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
getFormattedCompletion(String) - Method in class org.jboss.aesh.complete.CompleteOperation
 
getFormattedCompletionCandidates() - Method in class org.jboss.aesh.complete.CompleteOperation
 
getFormattedLength() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getFormattedOption(int, int, int) - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getFullEditMode() - Method in class org.jboss.aesh.console.settings.Settings
Get EditMode based on os and mode
getHeight() - Method in class org.jboss.aesh.terminal.TerminalSize
 
getHistory() - Method in class org.jboss.aesh.console.Console
Get the History object
getHistoryFile() - Method in class org.jboss.aesh.console.settings.Settings
If not set the history file will be: $HOME/.aesh_history
getHistorySize() - Method in class org.jboss.aesh.console.settings.Settings
By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
getHomeDir() - Static method in class org.jboss.aesh.console.Config
 
getInput() - Method in class org.jboss.aesh.console.helper.Search
 
getInput() - Method in enum org.jboss.aesh.edit.actions.Operation
 
getInputrc() - Method in class org.jboss.aesh.console.settings.Settings
Get the inputrc file, if not set it defaults to: System.getProperty("user.home")+Config.getPathSeparator()+".inputrc"
getInputStream() - Method in class org.jboss.aesh.console.settings.Settings
If not set, System.in will be used
getInstance() - Static method in class org.jboss.aesh.console.settings.Settings
 
getInterruptHook() - Method in class org.jboss.aesh.console.settings.Settings
 
getInvertedBackground() - Static method in class org.jboss.aesh.util.ANSI
 
getKeyValues() - Method in class org.jboss.aesh.edit.KeyOperation
 
getLength() - Method in class org.jboss.aesh.console.Prompt
 
getLine() - Method in class org.jboss.aesh.console.Buffer
 
getLineFrom(int) - Method in class org.jboss.aesh.console.Buffer
Get line from given param
getLineNoMask() - Method in class org.jboss.aesh.console.Buffer
 
getLineSeparator() - Static method in class org.jboss.aesh.console.Config
 
getLineWithPrompt() - Method in class org.jboss.aesh.console.Buffer
Get the complete line (including prompt)
getLogFile() - Method in class org.jboss.aesh.console.settings.Settings
Get log file
getLogger(String) - Static method in class org.jboss.aesh.util.LoggerUtil
 
getLongName() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getLongName() - Method in class org.jboss.aesh.cl.ParsedOption
 
getMainBufferScreen() - Static method in class org.jboss.aesh.util.ANSI
 
getMode() - Method in interface org.jboss.aesh.edit.EditMode
 
getMode() - Method in class org.jboss.aesh.edit.EmacsEditMode
 
getMode() - Method in class org.jboss.aesh.edit.ViEditMode
 
getMovement() - Method in enum org.jboss.aesh.edit.actions.Operation
 
getName() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getName() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
getName() - Method in class org.jboss.aesh.cl.OptionProperty
 
getName() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
getName() - Method in class org.jboss.aesh.cl.ParsedOption
 
getName() - Method in class org.jboss.aesh.console.alias.Alias
 
getName() - Method in class org.jboss.aesh.console.settings.Settings
Get the name of the cli
getNewLine() - Static method in class org.jboss.aesh.edit.KeyOperationFactory
 
getNext() - Method in class org.jboss.aesh.undo.UndoManager
 
getNextFetch() - Method in interface org.jboss.aesh.history.History
 
getNextFetch() - Method in class org.jboss.aesh.history.InMemoryHistory
 
getNormalBackground() - Static method in class org.jboss.aesh.util.ANSI
 
getOffset() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
getOffset() - Method in class org.jboss.aesh.complete.CompleteOperation
 
getOperation() - Method in class org.jboss.aesh.console.helper.Search
 
getOperation() - Method in class org.jboss.aesh.edit.KeyOperation
 
getOperationManager() - Method in class org.jboss.aesh.console.settings.Settings
 
getOperations() - Method in class org.jboss.aesh.edit.KeyOperationManager
 
getOptionLongNamesWithDash() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
getOptionProperties(String) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptions() - Method in class org.jboss.aesh.cl.CommandLine
 
getOptions() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
getOptionValue(char) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptionValue(String) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptionValue(String, String) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptionValues(char) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptionValues(String) - Method in class org.jboss.aesh.cl.CommandLine
 
getOptionValues(String, List<String>) - Method in class org.jboss.aesh.cl.CommandLine
 
getParameters() - Method in class org.jboss.aesh.cl.CommandLineParser
 
getPathSeparator() - Static method in class org.jboss.aesh.console.Config
 
getPosition() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
getPositionOfFirstRedirection(String) - Static method in class org.jboss.aesh.console.operator.ControlOperatorParser
 
getPreviousFetch() - Method in interface org.jboss.aesh.history.History
 
getPreviousFetch() - Method in class org.jboss.aesh.history.InMemoryHistory
 
getPrompt() - Method in class org.jboss.aesh.console.Buffer
 
getPromptAsString() - Method in class org.jboss.aesh.console.Prompt
 
getProperties() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getProperties() - Method in class org.jboss.aesh.cl.ParsedOption
 
getRedirectionPosition() - Method in class org.jboss.aesh.console.Buffer
 
getResult() - Method in class org.jboss.aesh.console.helper.Search
 
getRow() - Method in class org.jboss.aesh.terminal.CursorPosition
 
getSearchDirection() - Method in interface org.jboss.aesh.history.History
 
getSearchDirection() - Method in class org.jboss.aesh.history.InMemoryHistory
 
getSearchTerm() - Method in class org.jboss.aesh.console.helper.Search
 
getSeparator() - Method in class org.jboss.aesh.complete.CompleteOperation
Get the separator character, by default its space
getSize() - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
getSize() - Method in interface org.jboss.aesh.terminal.Terminal
 
getSize() - Method in class org.jboss.aesh.terminal.TestTerminal
 
getSize() - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
getStart() - Method in class org.jboss.aesh.edit.actions.EditAction
 
getStart() - Static method in class org.jboss.aesh.util.ANSI
 
getStdErr() - Method in class org.jboss.aesh.console.ConsoleOutput
 
getStdErr() - Method in class org.jboss.aesh.console.settings.Settings
If not set System.out is used
getStdOut() - Method in class org.jboss.aesh.console.ConsoleOutput
 
getStdOut() - Method in class org.jboss.aesh.console.settings.Settings
If not set System.out is used
getTerminal() - Method in class org.jboss.aesh.console.Console
 
getTerminal() - Method in class org.jboss.aesh.console.settings.Settings
Use the specified terminal implementation If not set, aesh will try to use the best suited one
getTerminal() - Method in class org.jboss.aesh.terminal.TerminalHandler
 
getTerminalSize() - Method in class org.jboss.aesh.console.Console
 
getTextColor() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
getTmpDir() - Static method in class org.jboss.aesh.console.Config
 
getType() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getType() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
getType() - Method in class org.jboss.aesh.cl.ParsedOption
 
getType() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
getUnderline() - Static method in class org.jboss.aesh.util.ANSI
 
getUnderlineOff() - Static method in class org.jboss.aesh.util.ANSI
 
getUsage() - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
getValue() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getValue() - Method in class org.jboss.aesh.cl.OptionProperty
 
getValue() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
getValue() - Method in class org.jboss.aesh.cl.ParsedOption
 
getValue() - Method in class org.jboss.aesh.console.alias.Alias
 
getValue() - Method in enum org.jboss.aesh.terminal.CharacterType
 
getValue() - Method in enum org.jboss.aesh.terminal.Color
 
getValueComparedToPrev(CharacterType) - Method in enum org.jboss.aesh.terminal.CharacterType
 
getValues() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getValues() - Method in class org.jboss.aesh.cl.ParsedOption
 
getValues() - Method in enum org.jboss.aesh.console.settings.VariableSettings
 
getValueSeparator() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
getVariable() - Method in enum org.jboss.aesh.console.settings.VariableSettings
 
getWidth() - Method in class org.jboss.aesh.terminal.TerminalSize
 
getWorkingMode() - Method in class org.jboss.aesh.edit.KeyOperation
 
greenBackground() - Static method in class org.jboss.aesh.util.ANSI
 
greenText() - Static method in class org.jboss.aesh.util.ANSI
 

H

handleInterrupt(Console) - Method in interface org.jboss.aesh.console.helper.InterruptHook
 
hasAppendSeparator() - Method in class org.jboss.aesh.complete.CompleteOperation
Do this completion allow for appending a separator after completion? By default this is true.
hasChars() - Method in class org.jboss.aesh.console.Prompt
 
hashCode() - Method in class org.jboss.aesh.console.alias.Alias
 
hashCode() - Method in class org.jboss.aesh.console.ConsoleOperation
 
hashCode() - Method in class org.jboss.aesh.edit.KeyOperation
 
hashCode() - Method in class org.jboss.aesh.terminal.CursorPosition
 
hashCode() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
hashCode() - Method in class org.jboss.aesh.terminal.TerminalSize
 
hasInterruptHook() - Method in class org.jboss.aesh.console.settings.Settings
 
hasMoreThanOneKeyValue() - Method in class org.jboss.aesh.edit.KeyOperation
 
hasMultipleValues() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
hasMultipleValues(boolean) - Method in class org.jboss.aesh.cl.OptionBuilder
 
hasOption(char) - Method in class org.jboss.aesh.cl.CommandLine
 
hasOption(String) - Method in class org.jboss.aesh.cl.CommandLine
 
hasRedirectOut() - Method in class org.jboss.aesh.console.ConsoleCommand
 
hasValue() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
hasValue(boolean) - Method in class org.jboss.aesh.cl.OptionBuilder
 
History - Interface in org.jboss.aesh.history
 

I

init(InputStream, OutputStream, OutputStream) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
init(InputStream, OutputStream, OutputStream) - Method in interface org.jboss.aesh.terminal.Terminal
Initialize the Terminal with which input/output stream it should use
init(InputStream, OutputStream, OutputStream) - Method in class org.jboss.aesh.terminal.TestTerminal
 
init(InputStream, OutputStream, OutputStream) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
initInterrupt() - Method in class org.jboss.aesh.console.helper.InterruptHandler
 
InMemoryHistory - Class in org.jboss.aesh.history
A simple in-memory history implementation By default max size is 500
InMemoryHistory() - Constructor for class org.jboss.aesh.history.InMemoryHistory
 
InMemoryHistory(int) - Constructor for class org.jboss.aesh.history.InMemoryHistory
 
insert(int, String) - Method in class org.jboss.aesh.console.Buffer
 
InternalCommands - Enum in org.jboss.aesh.console
List over internal commands/functions in aesh
InterruptHandler - Class in org.jboss.aesh.console.helper
A simple InterruptHandler, for now it only handles INT.
InterruptHandler(Console) - Constructor for class org.jboss.aesh.console.helper.InterruptHandler
 
InterruptHook - Interface in org.jboss.aesh.console.helper
InterruptHook is the handler thats called when an interrupt has occured.
interruptPipe() - Method in class org.jboss.aesh.console.reader.ConsoleInputSession
 
isAliasEnabled() - Method in class org.jboss.aesh.console.settings.Settings
 
isAnsiConsole() - Method in class org.jboss.aesh.console.settings.Settings
 
isArgument() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
isAttached() - Method in class org.jboss.aesh.console.ConsoleCommand
 
isDelimiter(char) - Method in class org.jboss.aesh.edit.actions.EditAction
Checks to see if the specified character is a delimiter.
isDisableCompletion() - Method in class org.jboss.aesh.console.settings.Settings
Is completion disabled? Set to false by default
isEchoEnabled() - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
isEchoEnabled() - Method in interface org.jboss.aesh.terminal.Terminal
 
isEchoEnabled() - Method in class org.jboss.aesh.terminal.TestTerminal
 
isEchoEnabled() - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
isEmpty() - Method in class org.jboss.aesh.undo.UndoManager
 
isFinished() - Method in class org.jboss.aesh.console.helper.Search
 
isHistoryDisabled() - Method in class org.jboss.aesh.console.settings.Settings
Is history disabled Set to true to disable history
isHistoryPersistent() - Method in class org.jboss.aesh.console.settings.Settings
Is the history list persisted to file.
isInEditMode() - Method in class org.jboss.aesh.edit.ViEditMode
 
isLogging() - Method in class org.jboss.aesh.console.settings.Settings
Are we logging?
isMasking() - Method in class org.jboss.aesh.console.Buffer
 
isOption() - Method in class org.jboss.aesh.cl.ParsedCompleteObject
 
isOSPOSIXCompatible() - Static method in class org.jboss.aesh.console.Config
 
isPipelineAndRedirectionEnabled() - Method in class org.jboss.aesh.console.settings.Settings
 
isPositionWithinSize(CursorPosition) - Method in class org.jboss.aesh.terminal.TerminalSize
 
isProperty() - Method in class org.jboss.aesh.cl.internal.OptionInt
Gets the value of the property property.
isProperty(boolean) - Method in class org.jboss.aesh.cl.OptionBuilder
 
isReadAhead() - Method in class org.jboss.aesh.console.settings.Settings
Read all bytes on buffer if its available Set to true by default WARNING: Do not set this to false if unsure
isRedirectionErr(ControlOperator) - Static method in enum org.jboss.aesh.console.operator.ControlOperator
 
isRedirectionOut(ControlOperator) - Static method in enum org.jboss.aesh.console.operator.ControlOperator
 
isRequired() - Method in class org.jboss.aesh.cl.internal.OptionInt
 
isRunning() - Method in class org.jboss.aesh.console.Console
 
isSpace(char) - Method in class org.jboss.aesh.edit.actions.EditAction
Checks to see if the specified character is a space.

K

KeyMapper - Class in org.jboss.aesh.edit.mapper
Map key bindings to specified operation.
KeyMapper() - Constructor for class org.jboss.aesh.edit.mapper.KeyMapper
 
KeyOperation - Class in org.jboss.aesh.edit
 
KeyOperation(int, Operation) - Constructor for class org.jboss.aesh.edit.KeyOperation
 
KeyOperation(int[], Operation) - Constructor for class org.jboss.aesh.edit.KeyOperation
 
KeyOperation(int, Operation, Action) - Constructor for class org.jboss.aesh.edit.KeyOperation
 
KeyOperation(int[], Operation, Action) - Constructor for class org.jboss.aesh.edit.KeyOperation
 
KeyOperationFactory - Class in org.jboss.aesh.edit
Bind default key codes to KeyOperations
KeyOperationFactory() - Constructor for class org.jboss.aesh.edit.KeyOperationFactory
 
KeyOperationManager - Class in org.jboss.aesh.edit
 
KeyOperationManager() - Constructor for class org.jboss.aesh.edit.KeyOperationManager
 

L

length() - Method in class org.jboss.aesh.console.Buffer
 
LoggerUtil - Class in org.jboss.aesh.util
butt ugly logger util, but its simple and gets the job done (hopefully not too dangerous)
LoggerUtil() - Constructor for class org.jboss.aesh.util.LoggerUtil
 
longName(String) - Method in class org.jboss.aesh.cl.OptionBuilder
 

M

magentaBackground() - Static method in class org.jboss.aesh.util.ANSI
 
magentaText() - Static method in class org.jboss.aesh.util.ANSI
 
main(String[]) - Static method in class Example
 
mapKeys(String, Operation) - Static method in class org.jboss.aesh.edit.mapper.KeyMapper
Parse lines that contain mapping like: C-q, Control-q, M-a, Meta-a, Meta-Control-b....
mapKeys(String, String) - Static method in class org.jboss.aesh.edit.mapper.KeyMapper
Parse lines that contain mapping like: C-q, Control-q, M-a, Meta-a, Meta-Control-b....
mapQuoteKeys(String, Operation) - Static method in class org.jboss.aesh.edit.mapper.KeyMapper
Parse key mapping lines that start with "
mapQuoteKeys(String, String) - Static method in class org.jboss.aesh.edit.mapper.KeyMapper
Parse key mapping lines that start with "
mapToFunction(String) - Static method in class org.jboss.aesh.edit.mapper.OperationMapper
 
Mode - Enum in org.jboss.aesh.edit
 
move(int, int) - Method in class org.jboss.aesh.console.Buffer
Move the cursor left if the param is negative, and right if its positive.
move(int, int, boolean) - Method in class org.jboss.aesh.console.Buffer
 
move(int, int) - Method in class org.jboss.aesh.terminal.CursorPosition
 
moveCursor(int) - Method in class org.jboss.aesh.console.Console
 
moveCursor(int, int) - Method in class org.jboss.aesh.terminal.AbstractTerminal
 
moveCursor(int, int) - Method in interface org.jboss.aesh.terminal.Terminal
Move the cursor relative to the current position Will not move outside of TerminalSize boundaries
moveCursor(int, int) - Method in class org.jboss.aesh.terminal.TestTerminal
 
moveCursorToBeginningOfLine() - Static method in class org.jboss.aesh.util.ANSI
 
Movement - Enum in org.jboss.aesh.edit.actions
Describes possible movements

N

name(char) - Method in class org.jboss.aesh.cl.OptionBuilder
 
name(String) - Method in class org.jboss.aesh.cl.ParameterBuilder
 
NextSpaceWordAction - Class in org.jboss.aesh.edit.actions
 
NextSpaceWordAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.NextSpaceWordAction
 
NextWordAction - Class in org.jboss.aesh.edit.actions
 
NextWordAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.NextWordAction
 

O

Operation - Enum in org.jboss.aesh.edit.actions
An Operation is a stream parsed by the current EditMode.
OperationMapper - Class in org.jboss.aesh.edit.mapper
 
OperationMapper() - Constructor for class org.jboss.aesh.edit.mapper.OperationMapper
 
Option - Annotation Type in org.jboss.aesh.cl
A single command line option.
OptionBuilder - Class in org.jboss.aesh.cl
Build a OptionInt object using the Builder pattern.
OptionBuilder() - Constructor for class org.jboss.aesh.cl.OptionBuilder
 
OptionInt - Class in org.jboss.aesh.cl.internal
 
OptionInt(char, String, String, boolean, String, boolean, char, boolean, boolean, Class<?>) - Constructor for class org.jboss.aesh.cl.internal.OptionInt
 
OptionProperty - Class in org.jboss.aesh.cl
 
OptionProperty(String, String) - Constructor for class org.jboss.aesh.cl.OptionProperty
 
org.jboss.aesh.cl - package org.jboss.aesh.cl
 
org.jboss.aesh.cl.internal - package org.jboss.aesh.cl.internal
 
org.jboss.aesh.complete - package org.jboss.aesh.complete
 
org.jboss.aesh.console - package org.jboss.aesh.console
 
org.jboss.aesh.console.alias - package org.jboss.aesh.console.alias
 
org.jboss.aesh.console.helper - package org.jboss.aesh.console.helper
 
org.jboss.aesh.console.operator - package org.jboss.aesh.console.operator
 
org.jboss.aesh.console.reader - package org.jboss.aesh.console.reader
 
org.jboss.aesh.console.settings - package org.jboss.aesh.console.settings
 
org.jboss.aesh.edit - package org.jboss.aesh.edit
 
org.jboss.aesh.edit.actions - package org.jboss.aesh.edit.actions
 
org.jboss.aesh.edit.mapper - package org.jboss.aesh.edit.mapper
 
org.jboss.aesh.history - package org.jboss.aesh.history
 
org.jboss.aesh.terminal - package org.jboss.aesh.terminal
 
org.jboss.aesh.undo - package org.jboss.aesh.undo
 
org.jboss.aesh.util - package org.jboss.aesh.util
 

P

Parameter - Annotation Type in org.jboss.aesh.cl
Parameter represent a list of Option objects, a usage description and which parser to use for a command.
ParameterBuilder - Class in org.jboss.aesh.cl
Build a ParameterInt object using the Builder pattern.
ParameterBuilder() - Constructor for class org.jboss.aesh.cl.ParameterBuilder
 
ParameterInt - Class in org.jboss.aesh.cl.internal
 
ParameterInt(String, String) - Constructor for class org.jboss.aesh.cl.internal.ParameterInt
 
ParameterInt(String, String, Class<?>) - Constructor for class org.jboss.aesh.cl.internal.ParameterInt
 
ParameterInt(String, String, Class<?>, OptionInt[]) - Constructor for class org.jboss.aesh.cl.internal.ParameterInt
 
ParameterInt(String, String, Class<?>, List<OptionInt>) - Constructor for class org.jboss.aesh.cl.internal.ParameterInt
 
parse(String) - Method in class org.jboss.aesh.cl.CommandLineParser
Parse a command line with the defined parameter as base of the rules.
parse(String, boolean) - Method in class org.jboss.aesh.cl.CommandLineParser
Parse a command line with the defined parameter as base of the rules.
parse(CommandLineParser) - Method in class org.jboss.aesh.console.ConsoleOutput
 
parseAction(Operation, int, int) - Static method in class org.jboss.aesh.edit.actions.EditActionManager
 
parseAlias(String) - Method in class org.jboss.aesh.console.alias.AliasManager
 
ParsedCompleteObject - Class in org.jboss.aesh.cl
A value object designed to show on which option a complete operation is performed on.
ParsedCompleteObject(boolean) - Constructor for class org.jboss.aesh.cl.ParsedCompleteObject
 
ParsedCompleteObject(boolean, String, int) - Constructor for class org.jboss.aesh.cl.ParsedCompleteObject
 
ParsedCompleteObject(String, String, Class<?>, boolean) - Constructor for class org.jboss.aesh.cl.ParsedCompleteObject
 
ParsedOption - Class in org.jboss.aesh.cl
 
ParsedOption(String, String, List<String>, Class<?>) - Constructor for class org.jboss.aesh.cl.ParsedOption
 
ParsedOption(String, String, OptionProperty, Class<?>) - Constructor for class org.jboss.aesh.cl.ParsedOption
 
ParsedOption(String, String, String, Class<?>) - Constructor for class org.jboss.aesh.cl.ParsedOption
 
parseInput(int[], String) - Method in interface org.jboss.aesh.edit.EditMode
 
parseInput(int[], String) - Method in class org.jboss.aesh.edit.EmacsEditMode
 
parseInput(int[], String) - Method in class org.jboss.aesh.edit.ViEditMode
 
parseInputrc(Settings) - Static method in class org.jboss.aesh.console.Config
Must be able to parse: set variablename value keyname: function-name or macro "keyseq": function-name or macro Lines starting with # are comments Lines starting with $ are conditional init constructs
Parser - Class in org.jboss.aesh.util
String/Parser util methods
Parser() - Constructor for class org.jboss.aesh.util.Parser
 
ParserBuilder - Class in org.jboss.aesh.cl
 
ParserBuilder() - Constructor for class org.jboss.aesh.cl.ParserBuilder
 
ParserBuilder(ParameterInt) - Constructor for class org.jboss.aesh.cl.ParserBuilder
 
ParserGenerator - Class in org.jboss.aesh.cl
Generates a CommandLineParser based on annotations defined in the specified class.
ParserGenerator() - Constructor for class org.jboss.aesh.cl.ParserGenerator
 
PasteManager - Class in org.jboss.aesh.edit
Keep track of edits for paste
PasteManager() - Constructor for class org.jboss.aesh.edit.PasteManager
 
persist() - Method in class org.jboss.aesh.console.alias.AliasManager
 
POSIXTerminal - Class in org.jboss.aesh.terminal
Terminal that should work on most POSIX systems
POSIXTerminal() - Constructor for class org.jboss.aesh.terminal.POSIXTerminal
 
PrevSpaceWordAction - Class in org.jboss.aesh.edit.actions
 
PrevSpaceWordAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.PrevSpaceWordAction
 
PrevWordAction - Class in org.jboss.aesh.edit.actions
 
PrevWordAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.PrevWordAction
 
printAllAliases() - Method in class org.jboss.aesh.console.alias.AliasManager
 
printAnsi(String) - Static method in class org.jboss.aesh.console.Buffer
Return a ansified string based on param
printAnsi(char[]) - Static method in class org.jboss.aesh.console.Buffer
Return a ansified string based on param
printHelp() - Method in class org.jboss.aesh.cl.CommandLineParser
Returns a usage String based on the defined parameter and options.
printHelp() - Method in class org.jboss.aesh.cl.internal.ParameterInt
Returns a usage String based on the defined parameter and options.
processOperation(Operation) - Method in class org.jboss.aesh.console.ConsoleCommand
Called after every operation made by the user
Prompt - Class in org.jboss.aesh.console
The Prompt: If created with a String value that value will be the prompt with the default back and foreground colors.
Prompt(String) - Constructor for class org.jboss.aesh.console.Prompt
 
Prompt(List<TerminalCharacter>) - Constructor for class org.jboss.aesh.console.Prompt
 
push(String) - Method in interface org.jboss.aesh.history.History
 
push(String) - Method in class org.jboss.aesh.history.InMemoryHistory
 
pushToStdErr(String) - Method in class org.jboss.aesh.console.Console
 
pushToStdErr(char[]) - Method in class org.jboss.aesh.console.Console
 
pushToStdOut(String) - Method in class org.jboss.aesh.console.Console
Push text to the console, note that this will not update the internal cursor position.
pushToStdOut(char[]) - Method in class org.jboss.aesh.console.Console
 

Q

quit() - Method in class org.jboss.aesh.console.settings.QuitHandler
 
quit() - Method in class org.jboss.aesh.console.settings.Settings
 
QuitHandler - Class in org.jboss.aesh.console.settings
A simple Callback thats called when the program quits
QuitHandler() - Constructor for class org.jboss.aesh.console.settings.QuitHandler
 

R

read(String) - Method in class org.jboss.aesh.console.Console
Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.
read(Prompt, Character) - Method in class org.jboss.aesh.console.Console
Read from the input stream, perform action according to mapped operations/completions/etc Return the stream when a new line is found.
read(boolean) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
read(boolean) - Method in interface org.jboss.aesh.terminal.Terminal
Read from the input stream (char by char)
read(boolean) - Method in class org.jboss.aesh.terminal.TestTerminal
 
read(boolean) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
readFile(File) - Static method in class org.jboss.aesh.util.FileUtils
 
readRuntimeProperties(Settings) - Static method in class org.jboss.aesh.console.Config
 
redBackground() - Static method in class org.jboss.aesh.util.ANSI
 
RedirectionCompletion - Class in org.jboss.aesh.console.operator
ControlOperator completor
RedirectionCompletion() - Constructor for class org.jboss.aesh.console.operator.RedirectionCompletion
 
redText() - Static method in class org.jboss.aesh.util.ANSI
 
removeAlias(String) - Method in class org.jboss.aesh.console.alias.AliasManager
 
removeEscapedSpacesFromCompletionCandidates() - Method in class org.jboss.aesh.complete.CompleteOperation
 
replaceChar(char) - Method in class org.jboss.aesh.console.Buffer
 
required(boolean) - Method in class org.jboss.aesh.cl.OptionBuilder
 
reset(Prompt) - Method in class org.jboss.aesh.console.Buffer
Reset the buffer
reset(Prompt, Character) - Method in class org.jboss.aesh.console.Buffer
 
reset(Settings) - Method in class org.jboss.aesh.console.Console
Reset the Console with Settings Can only be called after stop()
reset() - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
reset() - Method in interface org.jboss.aesh.terminal.Terminal
Set it back to normal when we exit
reset() - Method in class org.jboss.aesh.terminal.TestTerminal
 
reset() - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
reset() - Static method in class org.jboss.aesh.util.ANSI
 
resetEditMode() - Method in class org.jboss.aesh.console.settings.Settings
 
resetToDefaults() - Method in class org.jboss.aesh.console.settings.Settings
 
restoreCursor() - Static method in class org.jboss.aesh.util.ANSI
 

S

saveCursor() - Static method in class org.jboss.aesh.util.ANSI
 
saveFile(File, String, boolean) - Static method in class org.jboss.aesh.util.FileUtils
 
Search - Class in org.jboss.aesh.console.helper
 
Search(Operation, int) - Constructor for class org.jboss.aesh.console.helper.Search
 
search(String) - Method in interface org.jboss.aesh.history.History
 
search(String) - Method in class org.jboss.aesh.history.InMemoryHistory
 
SearchDirection - Enum in org.jboss.aesh.history
 
setAliasEnabled(boolean) - Method in class org.jboss.aesh.console.settings.Settings
 
setAliasFile(File) - Method in class org.jboss.aesh.console.settings.Settings
 
setAnsiConsole(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Possible to override the type of console
setArgumentType(Class<?>) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
setBackgroundColor(Color) - Method in class org.jboss.aesh.terminal.TerminalHandler
 
setBellStyle(String) - Method in class org.jboss.aesh.console.settings.Settings
 
setColumn(int) - Method in class org.jboss.aesh.terminal.CursorPosition
 
setCompletionCandidates(List<String>) - Method in class org.jboss.aesh.complete.CompleteOperation
 
setConsoleOperation(ConsoleOperation) - Method in class org.jboss.aesh.console.ConsoleOutput
 
setCurrent(String) - Method in interface org.jboss.aesh.history.History
 
setCurrent(String) - Method in class org.jboss.aesh.history.InMemoryHistory
 
setCursor(int) - Method in class org.jboss.aesh.console.Buffer
 
setCursor(CursorPosition) - Method in class org.jboss.aesh.terminal.AbstractTerminal
 
setCursor(CursorPosition) - Method in interface org.jboss.aesh.terminal.Terminal
Set cursor position
setCursor(CursorPosition) - Method in class org.jboss.aesh.terminal.TestTerminal
 
setDisableCompletion(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Set to true do disable completion Set to false by default
setEditMode(Mode) - Method in class org.jboss.aesh.console.settings.Settings
 
setEnablePipelineAndRedirectionParser(boolean) - Method in class org.jboss.aesh.console.settings.Settings
 
setEnd(int) - Method in class org.jboss.aesh.edit.actions.EditAction
 
setFinished(boolean) - Method in class org.jboss.aesh.console.helper.Search
 
setForegroundColor(Color) - Method in class org.jboss.aesh.terminal.TerminalHandler
 
setHeight(int) - Method in class org.jboss.aesh.terminal.TerminalSize
 
setHistoryDisabled(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Is history disabled Set to true to disable history
setHistoryFile(File) - Method in class org.jboss.aesh.console.settings.Settings
 
setHistoryPersistent(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Is the history list persisted to file.
setHistorySize(int) - Method in class org.jboss.aesh.console.settings.Settings
By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
setInput(int) - Method in class org.jboss.aesh.console.helper.Search
 
setInput(int[]) - Method in enum org.jboss.aesh.edit.actions.Operation
 
setInputrc(File) - Method in class org.jboss.aesh.console.settings.Settings
 
setInputStream(InputStream) - Method in class org.jboss.aesh.console.settings.Settings
Set where input is coming from
setInterruptHook(InterruptHook) - Method in class org.jboss.aesh.console.settings.Settings
 
setLine(String) - Method in class org.jboss.aesh.console.Buffer
 
setLogFile(String) - Method in class org.jboss.aesh.console.settings.Settings
Specify a log file
setLogging(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Set logging, by default set to true
setName(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
setName(String) - Method in class org.jboss.aesh.console.settings.Settings
Set the name of the cli
setOffset(int) - Method in class org.jboss.aesh.complete.CompleteOperation
 
setOperation(Operation) - Method in class org.jboss.aesh.console.helper.Search
 
setPosition(CursorPosition) - Method in class org.jboss.aesh.terminal.CursorPosition
 
setPosition(CursorPosition) - Method in class org.jboss.aesh.terminal.TerminalHandler
 
setQuitHandler(QuitHandler) - Method in class org.jboss.aesh.console.settings.Settings
 
setReadAhead(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Read all bytes on buffer if its available Set to true by default WARNING: Do not set this to false if unsure
setReadInputrc(boolean) - Method in class org.jboss.aesh.console.settings.Settings
Specify if we should read config from inputrc Set to true by default
setResult(String) - Method in class org.jboss.aesh.console.helper.Search
 
setRow(int) - Method in class org.jboss.aesh.terminal.CursorPosition
 
setSearchDirection(SearchDirection) - Method in interface org.jboss.aesh.history.History
 
setSearchDirection(SearchDirection) - Method in class org.jboss.aesh.history.InMemoryHistory
 
setSearchTerm(String) - Method in class org.jboss.aesh.console.helper.Search
 
setSearchTerm(StringBuilder) - Method in class org.jboss.aesh.console.helper.Search
 
setSeparator(char) - Method in class org.jboss.aesh.complete.CompleteOperation
By default the separator is one space char, but it can be overridden here.
setStdErr(OutputStream) - Method in class org.jboss.aesh.console.settings.Settings
Set where output should go to
setStdOut(OutputStream) - Method in class org.jboss.aesh.console.settings.Settings
Set where output should go to
setTerminal(Terminal) - Method in class org.jboss.aesh.console.settings.Settings
Specify which terminal impl to use
Settings - Class in org.jboss.aesh.console.settings
Settings object that is parsed when Console is initialized.
setUsage(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
setWidth(int) - Method in class org.jboss.aesh.terminal.TerminalSize
 
SimpleAction - Class in org.jboss.aesh.edit.actions
A placeholder class for simple actions that require little logic.
SimpleAction(int, Action) - Constructor for class org.jboss.aesh.edit.actions.SimpleAction
 
SimpleAction(int, Action, int) - Constructor for class org.jboss.aesh.edit.actions.SimpleAction
 
size() - Method in interface org.jboss.aesh.history.History
 
size() - Method in class org.jboss.aesh.history.InMemoryHistory
 
size() - Method in class org.jboss.aesh.undo.UndoManager
 
splitBySizeKeepWords(String, int) - Static method in class org.jboss.aesh.util.Parser
 
startWithLongOption(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
startWithOption(String) - Method in class org.jboss.aesh.cl.internal.ParameterInt
 
stop() - Method in class org.jboss.aesh.console.Console
Stop the Console, close streams, and reset terminals.
stop() - Method in class org.jboss.aesh.console.reader.ConsoleInputSession
 
stty(String) - Static method in class org.jboss.aesh.terminal.POSIXTerminal
Run stty with arguments on the active terminal
switchEscapedSpacesToSpacesInList(List<String>) - Static method in class org.jboss.aesh.util.Parser
 
switchEscapedSpacesToSpacesInWord(String) - Static method in class org.jboss.aesh.util.Parser
 
switchSpacesToEscapedSpacesInWord(String) - Static method in class org.jboss.aesh.util.Parser
 

T

Terminal - Interface in org.jboss.aesh.terminal
Generic interface for Terminals
TerminalCharacter - Class in org.jboss.aesh.terminal
Describe how a terminal character should be displayed
TerminalCharacter(char) - Constructor for class org.jboss.aesh.terminal.TerminalCharacter
 
TerminalCharacter(char, CharacterType) - Constructor for class org.jboss.aesh.terminal.TerminalCharacter
 
TerminalCharacter(char, Color, Color) - Constructor for class org.jboss.aesh.terminal.TerminalCharacter
 
TerminalCharacter(char, Color, Color, CharacterType) - Constructor for class org.jboss.aesh.terminal.TerminalCharacter
 
TerminalHandler - Class in org.jboss.aesh.terminal
Helper class to write to a terminal.
TerminalHandler(Terminal) - Constructor for class org.jboss.aesh.terminal.TerminalHandler
 
TerminalSize - Class in org.jboss.aesh.terminal
 
TerminalSize(int, int) - Constructor for class org.jboss.aesh.terminal.TerminalSize
 
TestTerminal - Class in org.jboss.aesh.terminal
A dummy terminal used for tests
TestTerminal() - Constructor for class org.jboss.aesh.terminal.TestTerminal
 
toString() - Method in class org.jboss.aesh.complete.CompleteOperation
 
toString() - Method in class org.jboss.aesh.console.alias.Alias
 
toString() - Method in class org.jboss.aesh.console.ConsoleOperation
 
toString() - Method in class org.jboss.aesh.console.ConsoleOutput
 
toString() - Method in class org.jboss.aesh.edit.KeyOperation
 
toString() - Method in class org.jboss.aesh.terminal.CursorPosition
 
toString() - Method in class org.jboss.aesh.terminal.TerminalCharacter
 
toString() - Method in class org.jboss.aesh.terminal.TerminalSize
 
toString() - Method in class org.jboss.aesh.util.FileLister
 
totalLength() - Method in class org.jboss.aesh.console.Buffer
 
trim(String) - Static method in class org.jboss.aesh.util.Parser
Similar to String.trim(), but do not remove spaces that are escaped
trimOptionName(String) - Static method in class org.jboss.aesh.util.Parser
remove leading dashes from word
type(Class<?>) - Method in class org.jboss.aesh.cl.OptionBuilder
 

U

UndoAction - Class in org.jboss.aesh.undo
 
UndoAction(int, String) - Constructor for class org.jboss.aesh.undo.UndoAction
 
UndoManager - Class in org.jboss.aesh.undo
 
UndoManager() - Constructor for class org.jboss.aesh.undo.UndoManager
 
usage(String) - Method in class org.jboss.aesh.cl.ParameterBuilder
 

V

valueOf(String) - Static method in enum org.jboss.aesh.console.InternalCommands
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.console.operator.ControlOperator
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.console.settings.VariableSettings
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.edit.actions.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.edit.actions.Movement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.edit.actions.Operation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.edit.Mode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.history.SearchDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.terminal.CharacterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.aesh.terminal.Color
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.aesh.console.InternalCommands
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.console.operator.ControlOperator
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.console.settings.VariableSettings
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.edit.actions.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.edit.actions.Movement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.edit.actions.Operation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.edit.Mode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.history.SearchDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.terminal.CharacterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.aesh.terminal.Color
Returns an array containing the constants of this enum type, in the order they are declared.
valueSeparator(char) - Method in class org.jboss.aesh.cl.OptionBuilder
 
VariableSettings - Enum in org.jboss.aesh.console.settings
Defines all the possible variable settings defined for GNU Readline, ref: http://cnswww.cns.cwru.edu/php/chet/readline/readline.html#SEC10
ViEditMode - Class in org.jboss.aesh.edit
 
ViEditMode(KeyOperationManager) - Constructor for class org.jboss.aesh.edit.ViEditMode
 

W

whiteBackground() - Static method in class org.jboss.aesh.util.ANSI
 
whiteText() - Static method in class org.jboss.aesh.util.ANSI
 
WindowsTerminal - Class in org.jboss.aesh.terminal
 
WindowsTerminal() - Constructor for class org.jboss.aesh.terminal.WindowsTerminal
 
write(char) - Method in class org.jboss.aesh.console.Buffer
Write a char to the line and update cursor accordingly
write(String) - Method in class org.jboss.aesh.console.Buffer
Write a string to the line and update cursor accordingly
writeChar(TerminalCharacter) - Method in class org.jboss.aesh.terminal.AbstractTerminal
 
writeChar(TerminalCharacter) - Method in interface org.jboss.aesh.terminal.Terminal
Write a TerminalCharacter to std out
writeChar(TerminalCharacter) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeChars(List<TerminalCharacter>) - Method in class org.jboss.aesh.terminal.AbstractTerminal
 
writeChars(List<TerminalCharacter>) - Method in interface org.jboss.aesh.terminal.Terminal
Write a list of TerminalCharacters to std out
writeChars(List<TerminalCharacter>) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdErr(String) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdErr(char[]) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdErr(char) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdErr(String) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard error stream
writeToStdErr(char[]) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard error stream
writeToStdErr(char) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard error stream
writeToStdErr(String) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdErr(char[]) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdErr(char) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdErr(String) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
writeToStdErr(char[]) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
writeToStdErr(char) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
writeToStdOut(String) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdOut(char[]) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdOut(char) - Method in class org.jboss.aesh.terminal.POSIXTerminal
 
writeToStdOut(String) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard output stream
writeToStdOut(char[]) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard output stream
writeToStdOut(char) - Method in interface org.jboss.aesh.terminal.Terminal
Write to the standard output stream
writeToStdOut(String) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdOut(char[]) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdOut(char) - Method in class org.jboss.aesh.terminal.TestTerminal
 
writeToStdOut(String) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
writeToStdOut(char[]) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 
writeToStdOut(char) - Method in class org.jboss.aesh.terminal.WindowsTerminal
 

Y

yellowBackground() - Static method in class org.jboss.aesh.util.ANSI
 
yellowText() - Static method in class org.jboss.aesh.util.ANSI
 
A B C D E F G H I K L M N O P Q R S T U V W Y 
Skip navigation links
?sh 0.33.7

Copyright © 2015 JBoss by Red Hat. All rights reserved.