org.apache.karaf.shell.commands

Annotation Type Command

Deprecated.

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Deprecated
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 Deprecated. Return the name of the command if used inside a shell.
String	scope Deprecated. Return the scope or sub shell of the command.

Optional Element Summary

Optional Elements

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

Element Detail

scope

public abstract String scope

Deprecated.

Return the scope or sub shell of the command.

Returns:

The command scope.

name

public abstract String name

Deprecated.

Return the name of the command if used inside a shell.

Returns:

The command name.

description

public abstract String description

Deprecated.

Return the description of the command which is used to generate command line help.

Returns:

The command description.

Default:

""

detailedDescription

public abstract String detailedDescription

Deprecated.

Return a detailed description of the command.

Returns:

The command detailed description.

Default:

""