org.jboss.aesh.console.man

Class Man

java.lang.Object

org.jboss.aesh.console.man.AeshFileDisplayer

org.jboss.aesh.console.man.Man

All Implemented Interfaces:

Command

public class Man
extends AeshFileDisplayer

A Man implementation for Aesh. ref: http://en.wikipedia.org/wiki/Man_page

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Man.ManCompleter

Field Summary

Fields

Modifier and Type	Field and Description
private ManFileParser	fileParser
private java.util.List<java.lang.String>	manPages
private ManProvider	manProvider
private static CommandRegistry	registry

Constructor Summary

Constructors

Constructor and Description
Man(ManProvider manProvider)

Method Summary

Modifier and Type	Method and Description
void	displayBottom()
CommandResult	execute(CommandInvocation commandInvocation) Will be executed when this command is triggered by the command line.
FileParser	getFileParser()
void	setRegistry(CommandRegistry registry)

Methods inherited from class org.jboss.aesh.console.man.AeshFileDisplayer

afterAttach, afterDetach, clearBottomLine, getCommandInvocation, getSearchStatus, getSearchWord, getShell, getTopVisibleRow, isAtBottom, isAtTop, processInput, processOperation, setCommandInvocation, setControlOperator, writeToConsole

Methods inherited from class java.lang.Object

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

Field Detail

manPages

private final java.util.List<java.lang.String> manPages

fileParser

private final ManFileParser fileParser

registry

private static CommandRegistry registry

manProvider

private final ManProvider manProvider

Constructor Detail

Man

public Man(ManProvider manProvider)

Method Detail

setRegistry

public void setRegistry(CommandRegistry registry)

getFileParser

public FileParser getFileParser()

Specified by:

getFileParser in class AeshFileDisplayer

displayBottom

public void displayBottom()
                   throws java.io.IOException

Specified by:

displayBottom in class AeshFileDisplayer

Throws:

java.io.IOException

execute

public CommandResult execute(CommandInvocation commandInvocation)
                      throws java.io.IOException,
                             java.lang.InterruptedException

Description copied from interface: Command

Will be executed when this command is triggered by the command line.

Parameters:

commandInvocation - invocation

Returns:

success or failure depending on how the execution went.

Throws:

java.io.IOException

java.lang.InterruptedException