org.jboss.aesh.console.command.container

Interface CommandContainer<T extends Command>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AeshCommandContainer, DefaultCommandContainer

public interface CommandContainer<T extends Command>
extends AutoCloseable

A CommandContainer hold reference to the Command and the CommandLineParser generated from the Command. CommandRegistry will not put any CommandContainer objects in the registry if it have any create errors.

Author:

Ståle W. Pedersen

Method Summary

Modifier and Type	Method and Description
CommandContainerResult	executeCommand(AeshLine line, InvocationProviders invocationProviders, AeshContext aeshContext, CommandInvocation commandInvocation)
String	getBuildErrorMessage()
CommandLineParser<T>	getParser()
boolean	haveBuildError()
String	printHelp(String childCommandName)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getParser

CommandLineParser<T> getParser()

Returns:

parser generated from Command

haveBuildError

boolean haveBuildError()

Returns:

true if the CommandLineParser or Command generation generated any errors

printHelp

String printHelp(String childCommandName)

Parameters:

childCommandName - (for group commands)

Returns:

help info

getBuildErrorMessage

String getBuildErrorMessage()

Returns:

error message

executeCommand

CommandContainerResult executeCommand(AeshLine line,
                                      InvocationProviders invocationProviders,
                                      AeshContext aeshContext,
                                      CommandInvocation commandInvocation)
                               throws CommandLineParserException,
                                      OptionValidatorException,
                                      CommandValidatorException,
                                      IOException,
                                      InterruptedException

Throws:

CommandLineParserException

OptionValidatorException

CommandValidatorException

IOException

InterruptedException