Uses of Class
org.yamcs.Spec.Option

Packages that use Spec.Option

Package	Description
org.yamcs

Uses of Spec.Option in org.yamcs

Methods in org.yamcs that return Spec.Option

Modifier and Type	Method	Description
Spec.Option	Spec.addOption(String name, Spec.OptionType type)	Add an Spec.Option to this spec.
Spec.Option	Spec.getOption(String key)
Spec.Option	Spec.Option.withAliases(String... aliases)	Add aliases for this option.
Spec.Option	Spec.Option.withApplySpecDefaults(boolean applySpecDefaults)	In case the type is set to Spec.OptionType.MAP, setting this property to true will cause defaults within elements of that type to be applied even if the option itself is not defined.
<T extends Enum<T>> Spec.Option	Spec.Option.withChoices(Class<T> enumClass)	Sets the allowed values of this option based on the states of an Enum.
Spec.Option	Spec.Option.withChoices(Object... choices)	Sets the allowed values of this option.
Spec.Option	Spec.Option.withDefault(Object defaultValue)	Sets the default value.
Spec.Option	Spec.Option.withDeprecationMessage(String deprecationMessage)	Attach a deprecation message to this option.
Spec.Option	Spec.Option.withDescription(String... description)
Spec.Option	Spec.Option.withElementType(Spec.OptionType elementType)	In case the type is set to Spec.OptionType.LIST or Spec.OptionType.LIST_OR_ELEMENT the element type indicates the type of each element of that list.
Spec.Option	Spec.Option.withHidden(boolean hidden)	Hint that this option should be hidden from UIs.
Spec.Option	Spec.Option.withRequired(boolean required)	Set whether this option is required.
Spec.Option	Spec.Option.withSecret(boolean secret)	Set whether this option is secret.
Spec.Option	Spec.Option.withSpec(Spec spec)	In case the type or the elementType is set to Spec.OptionType.MAP this specifies the options within that map.
Spec.Option	Spec.Option.withTitle(String title)
Spec.Option	Spec.Option.withVersionAdded(String versionAdded)	Which version of the software this specific option was added.

Methods in org.yamcs that return types with arguments of type Spec.Option

Modifier and Type	Method	Description
Collection<Spec.Option>	Spec.getOptions()

Methods in org.yamcs with parameters of type Spec.Option

Modifier and Type	Method	Description
List<String>	Spec.getAliases(Spec.Option option)