Package org.openqa.selenium.grid.config

Class DescribedOption

java.lang.Object

org.openqa.selenium.grid.config.DescribedOption

All Implemented Interfaces:

Comparable<DescribedOption>

public class DescribedOption
extends Object
implements Comparable<DescribedOption>

Represents a configurable attribute of the Selenium Grid.

Field Summary

Fields

Modifier and Type	Field	Description
final String	defaultValue
final String	description
final String[]	example
final Set<String>	flags
final boolean	hidden
final String	optionName
final boolean	prefixed
final boolean	quotable
final boolean	repeats
final String	section
final String	type

Method Summary

Modifier and Type	Method	Description
int	compareTo(DescribedOption o)
String	description()
boolean	equals(Object o)
String[]	example()
String	example(Config config, String example)
static Set<DescribedOption>	findAllMatchingOptions(Collection<Role> roles)
Set<String>	flags()
String	getType(Type type)
int	hashCode()
String	optionName()
boolean	repeats()
boolean	requiresTomlQuoting()
String	section()

Methods inherited from class java.lang.Object

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

Field Details

section

public final String section

optionName

public final String optionName

description

public final String description

type

public final String type

example

public final String[] example

defaultValue

public final String defaultValue

prefixed

public final boolean prefixed

repeats

public final boolean repeats

quotable

public final boolean quotable

hidden

public final boolean hidden

flags

public final Set<String> flags

Method Details

findAllMatchingOptions

public static Set<DescribedOption> findAllMatchingOptions(Collection<Role> roles)

section

public String section()

optionName

public String optionName()

description

public String description()

repeats

public boolean repeats()

requiresTomlQuoting

public boolean requiresTomlQuoting()

example

public String[] example()

example

public String example(Config config,
 String example)

flags

public Set<String> flags()

compareTo

public int compareTo(DescribedOption o)

Specified by:

compareTo in interface Comparable<DescribedOption>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getType

public String getType(Type type)