Package org.yamcs

Class Spec.WhenCondition

java.lang.Object

org.yamcs.Spec.WhenCondition

Enclosing class:

Spec

public static final class Spec.WhenCondition
extends Object

Constructor Summary

Constructors

Constructor	Description
WhenCondition(Spec spec, String key, Object value)

Method Summary

Modifier and Type	Method	Description
Spec.Option	addOption(String name, Spec.OptionType type)	Add an Spec.Option when the condition is satisfied.
String	getKey()
Collection<Spec.Option>	getOptions()
List<String>	getRequiredKeys()
Object	getValue()
Spec.WhenCondition	mergeSpec(Spec spec)	Apply options from the given spec into the current spec when the condition is satisfied.
Spec.WhenCondition	requireAll(String... keys)
void	requireTogether(String... keys)	Specify a set of keys that must appear together.

Methods inherited from class java.lang.Object

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

Constructor Details

WhenCondition

public WhenCondition(Spec spec,
 String key,
 Object value)

Method Details

addOption

public Spec.Option addOption(String name,
 Spec.OptionType type)

Add an Spec.Option when the condition is satisfied.

Throws:

IllegalArgumentException - if an option with this name is already defined.

mergeSpec

public Spec.WhenCondition mergeSpec(Spec spec)

Apply options from the given spec into the current spec when the condition is satisfied.

Throws:

IllegalArgumentException - if an option with the same name is already defined.

getOptions

public Collection<Spec.Option> getOptions()

requireAll

public Spec.WhenCondition requireAll(String... keys)

requireTogether

public void requireTogether(String... keys)

Specify a set of keys that must appear together. This check only applies as soon as at least one of these keys has been specified.

getKey

public String getKey()

getValue

public Object getValue()

getRequiredKeys

public List<String> getRequiredKeys()