Package org.faktorips.runtime.productswitch

Class ProductSwitch.ProductSwitchCondition

java.lang.Object

org.faktorips.runtime.productswitch.ProductSwitch.ProductSwitchCondition

Enclosing class:

ProductSwitch

public static class ProductSwitch.ProductSwitchCondition
extends Object

This builder class configures the conditions used for finding the correct replacement IProductComponent.

Method Summary

Modifier and Type	Method	Description
ProductSwitch.MatchingProductFinderSwitch	matchingBy(String attributeName)	This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given attribute name of a ProductComponent if more than one suitable replacement is found in the product configuration.
ProductSwitch.MatchingProductFinderSwitch	matchingBy(ProductCmptType productCmptType, String attributeName)	This method will return a ProductSwitch.MatchingProductFinderSwitch that uses a ProductComponent and an attribute name of the given ProductCmptType if more than one suitable replacement is found in the product configuration.
ProductSwitch.MultipleProductSwitchCondition	switchAt(PolicyAssociation association, AdvancedProductFinder finder)	This method allows to register an AdvancedProductFinder with a specific PolicyAssociation.
ProductSwitchResults	to(IProductComponent newProduct)	The new IProductComponent that should be used for the switch.
ProductSwitch.MatchingProductFinderSwitch	with(BiPredicate<IProductComponent,IProductComponent> howToMatch)	This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given predicate if more than one suitable replacement is found in the product configuration.
ProductSwitch.AdvancedProductFinderSwitch	with(AdvancedProductFinder finder)	This method uses the given AdvancedProductFinder for all PolicyAssociations.
ProductSwitch.MatchingProductFinderSwitch	with(MatchingProductFinder productFinder)	This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given MatchingProductFinder.

Methods inherited from class java.lang.Object

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

Method Details

with

public ProductSwitch.MatchingProductFinderSwitch with(BiPredicate<IProductComponent,IProductComponent> howToMatch)

This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given predicate if more than one suitable replacement is found in the product configuration.

Parameters:

howToMatch - the predicate how the IProductComponents determine if they are suitable for a switch e.g. a configured enum that is used on all switchable IProductComponents

Returns:

the MatchingProductFinderSwitchBuilder

matchingBy

public ProductSwitch.MatchingProductFinderSwitch matchingBy(String attributeName)

This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given attribute name of a ProductComponent if more than one suitable replacement is found in the product configuration.

Parameters:

attributeName - the attribute with the given name declared in a ProductCmptType

Returns:

the MatchingProductFinderSwitchBuilder

with

public ProductSwitch.MatchingProductFinderSwitch with(MatchingProductFinder productFinder)

This method will return a ProductSwitch.MatchingProductFinderSwitch that uses the given MatchingProductFinder.

Parameters:

productFinder - the MatchingProductFinder that returns an Optional with an IProductComponent that should be used for the switch, or Optional.empty() if no suitable replacement is found in the product configuration

Returns:

the MatchingProductFinderSwitchBuilder

matchingBy

public ProductSwitch.MatchingProductFinderSwitch matchingBy(ProductCmptType productCmptType,
 String attributeName)

This method will return a ProductSwitch.MatchingProductFinderSwitch that uses a ProductComponent and an attribute name of the given ProductCmptType if more than one suitable replacement is found in the product configuration.

Parameters:

productCmptType - the ProductCmptType used to switch

attributeName - the attribute with the given name declared in the ProductCmptType

Returns:

the MatchingProductFinderSwitchBuilder

to

public ProductSwitchResults to(IProductComponent newProduct)

The new IProductComponent that should be used for the switch.

Parameters:

newProduct - the new IProductComponent

Returns:

an Map with all switched IConfigurableModelObjects and their status determined by either ProductSwitchResults.FailedProductSwitch or ProductSwitchResults.SuccessfulProductSwitch.

switchAt

public ProductSwitch.MultipleProductSwitchCondition switchAt(PolicyAssociation association,
 AdvancedProductFinder finder)

This method allows to register an AdvancedProductFinder with a specific PolicyAssociation.

Parameters:

association - the association for which the product finder should be used

finder - the product finder that should be used

Returns:

the MultipleProductSwitchConditionBuilder

with

public ProductSwitch.AdvancedProductFinderSwitch with(AdvancedProductFinder finder)

This method uses the given AdvancedProductFinder for all PolicyAssociations.

Parameters:

finder - the AdvancedProductFinder to use

Returns:

the AdvancedProductFinderSwitchBuilder