org.jboss.aesh.console.command.container

Interface CommandContainer<T extends Command>

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AeshCommandContainer, DefaultCommandContainer

public interface CommandContainer<T extends Command>
extends java.lang.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.

Method Summary

Modifier and Type	Method and Description
CommandContainerResult	executeCommand(AeshLine line, InvocationProviders invocationProviders, AeshContext aeshContext, CommandInvocation commandInvocation)
java.lang.String	getBuildErrorMessage()
CommandLineParser<T>	getParser()
boolean	haveBuildError()
java.lang.String	printHelp(java.lang.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

java.lang.String printHelp(java.lang.String childCommandName)

Parameters:

childCommandName - (for group commands)

Returns:

help info

getBuildErrorMessage

java.lang.String getBuildErrorMessage()

Returns:

error message

executeCommand

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

Throws:

CommandLineParserException

OptionValidatorException

CommandValidatorException

java.io.IOException

java.lang.InterruptedException