Griffon 1.2.0

org.codehaus.griffon.cli.shell
[Java] Annotation Type Command

java.lang.Object
  org.codehaus.griffon.cli.shell.Command

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.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 @default ""

java.lang.String detailedDescription

Returns a detailed description of the command @default ""

 
Method Summary
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Element Detail

description

String description
Returns the description of the command which is used to generate command line help @default ""


detailedDescription

String detailedDescription
Returns a detailed description of the command @default ""


name

String name
REturns the name of the command if used inside a shell


scope

String scope
Returns the scope or sub shell of the command


 

Groovy Documentation