Package org.openqa.selenium.grid.config

Class DescribedOption

java.lang.Object

org.openqa.selenium.grid.config.DescribedOption

All Implemented Interfaces:

java.lang.Comparable<DescribedOption>

public class DescribedOption
extends java.lang.Object
implements java.lang.Comparable<DescribedOption>

Represents a configurable attribute of the Selenium Grid.

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

section

public final java.lang.String section

optionName

public final java.lang.String optionName

description

public final java.lang.String description

type

public final java.lang.String type

example

public final java.lang.String[] example

defaultValue

public final java.lang.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 java.util.Set<java.lang.String> flags

Method Detail

findAllMatchingOptions

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

section

public java.lang.String section()

optionName

public java.lang.String optionName()

description

public java.lang.String description()

repeats

public boolean repeats()

requiresTomlQuoting

public boolean requiresTomlQuoting()

example

public java.lang.String[] example()

example

public java.lang.String example(Config config,
                                java.lang.String example)

flags

public java.util.Set<java.lang.String> flags()

compareTo

public int compareTo(DescribedOption o)

Specified by:

compareTo in interface java.lang.Comparable<DescribedOption>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getType

public java.lang.String getType(java.lang.reflect.Type type)