Module dev.civl.gmc

Package dev.civl.gmc

Class Option

java.lang.Object

dev.civl.gmc.Option

All Implemented Interfaces:

Serializable

public class Option
extends Object
implements Serializable

An instance of this class represents a command-line parameter for a model checker. The type of the option specifies the type of the values that the parameter can take.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Option.OptionType	The types of option.

Method Summary

Modifier and Type	Method	Description
Object	defaultValue()	Returns the default value for this option
String	description()	Returns the human-readable description of this option.
boolean	equals(Object object)
int	hashCode()
String	name()	Returns the name of this option.
static Option	newMapOption(String name, String description)	Returns a new option of type MAP with default value the empty map.
static Option	newScalarOption(String name, Option.OptionType type, String description, Object defaultValue)
void	print(PrintStream out)
String	toString()	Prints a human-readable description of this option, including its name, type, and default value.
Option.OptionType	type()	Returns the type of this option

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newScalarOption

public static Option newScalarOption(String name,
 Option.OptionType type,
 String description,
 Object defaultValue)

newMapOption

public static Option newMapOption(String name,
 String description)

Returns a new option of type MAP with default value the empty map.

Parameters:

name - the name to assign to this option

description - a human readable description of this option

Returns:

new option of type MAP with default value the empty map

name

public String name()

Returns the name of this option.

Returns:

the name of this option

type

public Option.OptionType type()

Returns the type of this option

Returns:

the type of this option

description

public String description()

Returns the human-readable description of this option.

Returns:

the human-readable description of this option

defaultValue

public Object defaultValue()

Returns the default value for this option

Returns:

the default value for this option

toString

public String toString()

Prints a human-readable description of this option, including its name, type, and default value. The form is appropriate for including in a "usage" message.

Overrides:

toString in class Object

print

public void print(PrintStream out)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object