oracle.dbtools.plugin.api.cmdline.annotations

Annotation Type Option

@Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface Option

Describes an optional argument to a command.

Author:

cdivilly

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
TranslatableText	description Description of the optional argument's purpose
String	name The name of the option

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	hasArgument Indicates if the option takes a value
Class<?>	type The type of the option value

Element Detail

name

public abstract String name

The name of the option

Returns:

option name

description

public abstract TranslatableText description

Description of the optional argument's purpose

Returns:

option description

type

public abstract Class<?> type

The type of the option value

Returns:

option type

Default:

java.lang.String.class

hasArgument

public abstract boolean hasArgument

Indicates if the option takes a value

Returns:

true if the option takes a value, false otherwise

Default:

true