org.hyphenType.datastructure.annotations
Annotation Type SimpleArgument

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface SimpleArgument

Author:

Aurelio Akira M. Matsui

Optional Element Summary

InputChannel[]	channels
String	description
int	index The index of this simple argument.
boolean	mandatory
String	name
String	regex

name

public abstract String name

Default:

""

index

public abstract int index

The index of this simple argument. Each simple argument should have a unique index. Indexes should be a sequence in the form 0, 1, ...

This property has 0 as the default value to keep the code clean when there is only one argument.

But it is not advisable to omit the index when using more than one option argument since it is harder to read. This is a counter example:

 @SimpleArgument
 String arg1();
 
 @SimpleArgument(index=1)
 String arg2();
 

The following is more readable:

 @SimpleArgument(index=0)
 String arg1();
 
 @SimpleArgument(index=1)
 String arg2();
 

Returns:

Default:

0

description

public abstract String description

Default:

""

regex

public abstract String regex

Default:

"[^\\Q\\h\\E&^\\Q\\H\\E].*"

mandatory

public abstract boolean mandatory

Default:

false

channels

public abstract InputChannel[] channels

Default:

org.hyphenType.datastructure.annotations.InputChannel.ARGUMENT