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

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

All Implemented Interfaces:

SubShell

public class AnnotatedSubShell
extends Object
implements SubShell

Constructor Summary

AnnotatedSubShell()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedSubShell

public AnnotatedSubShell()

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

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

getDetailedDescription

public String getDetailedDescription()

Description copied from interface: SubShell

Returns a detailed description of the command

Specified by:

getDetailedDescription in interface SubShell