org.wymiwyg.commons.util.arguments

Annotation Type CommandLine

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

Author:

reto

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	longName
String[]	shortName

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	defaultBooleanValue the default value for a non-switch attribute
String[]	defaultValue the default value for a single-string attribute
String	description a text describing the attribute
boolean	isSwitch if the return type is boolean this indicated that the argument is used without value, if present the result is true, otherwise false (defaultBooleanValue ignored)
boolean	required

Element Detail

longName

public abstract String[] longName

shortName

public abstract String[] shortName

defaultValue

public abstract String[] defaultValue

the default value for a single-string attribute

Returns:

Default:

{}

defaultBooleanValue

public abstract boolean defaultBooleanValue

the default value for a non-switch attribute

Returns:

Default:

false

isSwitch

public abstract boolean isSwitch

if the return type is boolean this indicated that the argument is used without value, if present the result is true, otherwise false (defaultBooleanValue ignored)

Returns:

Default:

true

required

public abstract boolean required

Default:

false

description

public abstract String description

a text describing the attribute

Returns:

Default:

"undocumented"