org.ops4j.pax.exam.options

Class OptionalCompositeOption

java.lang.Object

org.ops4j.pax.exam.options.OptionalCompositeOption

All Implemented Interfaces:

Option, CompositeOption

public class OptionalCompositeOption
extends 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

Nested Classes

Modifier and Type	Class and Description
static class	OptionalCompositeOption.BooleanCondition Boolean based OptionalCompositeOption.Condition implementation.
static interface	OptionalCompositeOption.Condition Condition to be evaluated.

Constructor Summary

Constructors

Constructor and Description
OptionalCompositeOption(boolean condition) Convenience constructor.
OptionalCompositeOption(OptionalCompositeOption.Condition condition) Constructor.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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.

Specified by:

getOptions in interface CompositeOption

Returns:

composed options (cannot be null)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object