public class

OptionalCompositeOption

extends Object
implements CompositeOption
java.lang.Object
   ↳ org.ops4j.pax.exam.options.OptionalCompositeOption

Class Overview

Composite option that will include the options that makes up the composite only in case that a boolean condition is true.

Summary

Nested Classes
class OptionalCompositeOption.BooleanCondition Boolean based OptionalCompositeOption.Condition implementation. 
interface OptionalCompositeOption.Condition Condition to be evaluated. 
Public Constructors
OptionalCompositeOption(OptionalCompositeOption.Condition condition)
Constructor.
OptionalCompositeOption(boolean condition)
Convenience constructor.
Public Methods
boolean equals(Object obj)
Option[] getOptions()
If condition is true will return the composite options.
int hashCode()
OptionalCompositeOption useOptions(Option... options)
Adds options to be used in case that condition evaluates to true.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.ops4j.pax.exam.options.CompositeOption

Public Constructors

public OptionalCompositeOption (OptionalCompositeOption.Condition condition)

Constructor.

Parameters
condition condition to evaluate

public OptionalCompositeOption (boolean condition)

Convenience constructor.

Parameters
condition boolean condition to evaluate

Public Methods

public boolean equals (Object obj)

public Option[] getOptions ()

If condition is true will return the composite options. Otherwise will return an empty array of options.

Returns
  • composed options (cannot be null)

public int hashCode ()

public OptionalCompositeOption useOptions (Option... options)

Adds options to be used in case that condition evaluates to true.

Parameters
options to use
Returns
  • this for fluent api