OptionClass

public abstract @interface OptionClass
implements Annotation

com.android.tradefed.config.OptionClass

Annotates a class as representing a IConfiguration object.

Summary

Public methods

String alias()

An optional descriptive alias for this configuration object.

boolean global_namespace()

Whether or not to add this Option to the global Option namespace.

Public methods

alias

public String alias ()

An optional descriptive alias for this configuration object.

This alias will currently be used for two purposes:

  • displayed in help output, to help classify options
  • can be used to namespace Option command line arguments, in cases where a given Option.name() is not unique amongst configuration objects. To provide a namespace with an Option command line argument, use this format:

    '--[OptionClass alias]:[Option name]'.

Returns
String

global_namespace

public boolean global_namespace ()

Whether or not to add this Option to the global Option namespace.

If true (the default), then it will be possible to specify this option simply by its name -- --[Option name]. If false, then the alias or another specific namespace (such as the full classname) must be specified in order to use Options for this class -- --[OptionClass alias]:[Option name] will work, but --[Option name] won't resolve to the Option.

FIXME: update documentation methods to distinguish classes/fields that aren't in the global FIXME: namespace

Returns
boolean