org.apache.felix.shell.impl

Class HelpCommandImpl

java.lang.Object

org.apache.felix.shell.impl.HelpCommandImpl

All Implemented Interfaces:

Command

public class HelpCommandImpl
extends Object
implements Command

Constructor Summary

Constructors

Constructor and Description
HelpCommandImpl(org.osgi.framework.BundleContext context)

Method Summary

Modifier and Type	Method and Description
void	execute(String s, PrintStream out, PrintStream err) Executes the command using the supplied command line, output print stream, and error print stream.
String	getName() Returns the name of the command that is implemented by the interface.
String	getShortDescription() Returns a short description of the command; this description should be as short as possible.
String	getUsage() Returns the usage string for the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommandImpl

public HelpCommandImpl(org.osgi.framework.BundleContext context)

Method Detail

getName

public String getName()

Description copied from interface: Command

Returns the name of the command that is implemented by the interface. The command name should not contain whitespace and should also be unique.

Specified by:

getName in interface Command

Returns:

the name of the command.

getUsage

public String getUsage()

Description copied from interface: Command

Returns the usage string for the command. The usage string is a short string that illustrates how to use the command on the command line. This information is used when generating command help information. An example usage string for the install command is:

     install  [ ...]
 

Specified by:

getUsage in interface Command

Returns:

the usage string for the command.

getShortDescription

public String getShortDescription()

Description copied from interface: Command

Returns a short description of the command; this description should be as short as possible. This information is used when generating the command help information.

Specified by:

getShortDescription in interface Command

Returns:

a short description of the command.

execute

public void execute(String s,
                    PrintStream out,
                    PrintStream err)

Description copied from interface: Command

Executes the command using the supplied command line, output print stream, and error print stream.

Specified by:

execute in interface Command

Parameters:

s - the complete command line, including the command name.

out - the print stream to use for standard output.

err - the print stream to use for standard error.