org.apache.karaf.shell.commands

Annotation Type Option

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Option

Used to mark an optional named command line option who's name typically starts with "--"

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	aliases
String	description
boolean	multiValued
boolean	required
String	valueToShowInHelp

Element Detail

name

public abstract String name

aliases

public abstract String[] aliases

Default:

{}

description

public abstract String description

Default:

""

required

public abstract boolean required

Default:

false

multiValued

public abstract boolean multiValued

Default:

false

valueToShowInHelp

public abstract String valueToShowInHelp

Default:

"DEFAULT"