com.google.devtools.common.options

Class OptionsBase

java.lang.Object

com.google.devtools.common.options.OptionsBase

public abstract class OptionsBase
extends java.lang.Object

Base class for all options classes. Extend this class, adding public instance fields annotated with @Option. Then you can create instances either programmatically:

   X x = Options.getDefaults(X.class);
   x.host = "localhost";
   x.port = 80;
 

or from an array of command-line arguments:

   OptionsParser parser = OptionsParser.newOptionsParser(X.class);
   parser.parse("--host", "localhost", "--port", "80");
   X x = parser.getOptions(X.class);
 

Subclasses of OptionsBase must be constructed reflectively, i.e. using not new MyOptions, but one of the two methods above instead. (Direct construction creates an empty instance, not containing default values. This leads to surprising behavior and often NullPointerExceptions, etc.)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptionsBase() Subclasses must provide a default (no argument) constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMap() Returns this options object in the form of a (new) mapping from option names, including inherited ones, to option values.
java.lang.String	cacheKey() Returns a string that uniquely identifies the options.
boolean	equals(java.lang.Object that)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OptionsBase

protected OptionsBase()

Subclasses must provide a default (no argument) constructor.

Method Detail

asMap

public final java.util.Map<java.lang.String,java.lang.Object> asMap()

Returns this options object in the form of a (new) mapping from option names, including inherited ones, to option values. If the public fields are mutated, this will be reflected in subsequent calls to asMap. Mutation of this map by the caller does not affect this options object.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

cacheKey

public final java.lang.String cacheKey()

Returns a string that uniquely identifies the options. This value is intended for analysis caching.

equals

public final boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object