org.molgenis.util.cmdline

Annotation Type Option

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

This annotation type helps to describe a single commandline option. With it information about the paramater name, usage, etc is stored. Based on this the CmdLineParser class knows which choices to make when parsing the commandline parameters.

Version:

1.0.0

Author:

RA Scheltema

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Defines the name of the option.
Option.Param	param What type of information is passed with this option, eg: filename, integer, etc.
Option.Type	type The type of this option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	usage This is a description of how to use this option.

Element Detail

name

public abstract String name

Defines the name of the option. This can be a single character, but als a word.

param

public abstract Option.Param param

What type of information is passed with this option, eg: filename, integer, etc.

type

public abstract Option.Type type

The type of this option.

usage

public abstract String usage

This is a description of how to use this option. All information can be gathered here.

Default:

""