org.apache.felix.gogo.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
 java.lang.String name
          REturns the name of the command if used inside a shell
 java.lang.String scope
          Returns the scope or sub shell of the command
 
Optional Element Summary
 java.lang.String description
          Returns the description of the command which is used to generate command line help
 java.lang.String detailedDescription
          Returns a detailed description of the command
 

Element Detail

scope

public abstract java.lang.String scope
Returns the scope or sub shell of the command


name

public abstract java.lang.String name
REturns the name of the command if used inside a shell

description

public abstract java.lang.String description
Returns the description of the command which is used to generate command line help

Default:
""

detailedDescription

public abstract java.lang.String detailedDescription
Returns a detailed description of the command

Default:
""


Copyright © 2007-2011 Apache Software Foundation. All Rights Reserved.