org.apache.karaf.shell.commands

Annotation Type Command

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Command

Used to denote a class represents a command which is executable within a shell/scope or as a command line process.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name REturns the name of the command if used inside a shell
String	scope Returns the scope or sub shell of the command

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Returns the description of the command which is used to generate command line help
String	detailedDescription Returns a detailed description of the command

Element Detail

scope

public abstract String scope

Returns the scope or sub shell of the command

name

public abstract String name

REturns the name of the command if used inside a shell

description

public abstract String description

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

Default:

""

detailedDescription

public abstract String detailedDescription

Returns a detailed description of the command

Default:

""