org.apache.karaf.shell.console.commands
Class BasicSubShell

java.lang.Object
  org.apache.karaf.shell.console.commands.BasicSubShell

All Implemented Interfaces:

SubShell

public class BasicSubShell
extends Object
implements SubShell

Constructor Summary

BasicSubShell()

Method Summary

String	getDescription() Returns the description of the command which is used to generate command line help
String	getDetailedDescription() Returns a detailed description of the command
String	getName() Returns the name of the command if used inside a shell
void	setDescription(String description)
void	setDetailedDescription(String detailedDescription)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSubShell

public BasicSubShell()

Method Detail

getName

public String getName()

Description copied from interface: SubShell

Returns the name of the command if used inside a shell

Specified by:

getName in interface SubShell

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: SubShell

Returns the description of the command which is used to generate command line help

Specified by:

getDescription in interface SubShell

setDescription

public void setDescription(String description)

getDetailedDescription

public String getDetailedDescription()

Description copied from interface: SubShell

Returns a detailed description of the command

Specified by:

getDetailedDescription in interface SubShell

setDetailedDescription

public void setDetailedDescription(String detailedDescription)