org.ops4j.pax.exam.options
Class OptionalCompositeOption

java.lang.Object
  extended by org.ops4j.pax.exam.options.OptionalCompositeOption
All Implemented Interfaces:
Option, CompositeOption

public class OptionalCompositeOption
extends java.lang.Object
implements CompositeOption

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

Since:
0.5.0, April 20, 2009
Author:
Alin Dreghiciu (adreghiciu@gmail.com)

Nested Class Summary
static class OptionalCompositeOption.BooleanCondition
          Boolean based OptionalCompositeOption.Condition implementation.
static interface OptionalCompositeOption.Condition
          Condition to be evaluated.
 
Constructor Summary
OptionalCompositeOption(boolean condition)
          Convenience constructor.
OptionalCompositeOption(OptionalCompositeOption.Condition condition)
          Constructor.
 
Method Summary
 Option[] getOptions()
          If condition is true will return the composite options.
 OptionalCompositeOption useOptions(Option... options)
          Adds options to be used in case that condition evaluates to true.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionalCompositeOption

public OptionalCompositeOption(OptionalCompositeOption.Condition condition)
Constructor.

Parameters:
condition - condition to evaluate

OptionalCompositeOption

public OptionalCompositeOption(boolean condition)
Convenience constructor.

Parameters:
condition - boolean condition to evaluate
Method Detail

useOptions

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

getOptions

public Option[] getOptions()
If condition is true will return the composite options. Otherwise will return an empty array of options. Getter.

Specified by:
getOptions in interface CompositeOption
Returns:
composed options (cannot be null)


Copyright © 2006-2012 OPS4J - Open Participation Software for Java. All Rights Reserved.