Package org.faktorips.runtime.productswitch

Class ProductSwitch

java.lang.Object

org.faktorips.runtime.productswitch.ProductSwitch

public class ProductSwitch
extends Object

The ProductSwitch class is used to generically and recursively switch the IProductComponent of an IConfigurableModelObject and its children.

By default, it uses the only replacement that is configured in the product configuration. If more than one replacement is found, it uses the IProductComponent.getKindId() to determine the correct replacement.

The default behavior can be changed by providing a BiPredicate that provides a more specific way than the kindId to find a replacement, or by providing a different implementation of the MatchingProductFinder or the AdvancedProductFinder interface.

Since:

23.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductSwitch.AbstractProductFinderSwitch
static class	ProductSwitch.AdvancedProductFinderSwitch	This builder class uses the AdvancedProductFinder to switch to a new IProductComponent
static class	ProductSwitch.MatchingProductFinderSwitch	This builder class uses the MatchingProductFinder to switch to a new IProductComponent
static class	ProductSwitch.MultipleProductSwitchCondition	This builder class configures the conditions used for finding the correct replacement IProductComponent for multiple PolicyAssociations.
static class	ProductSwitch.ProductSwitchCondition	This builder class configures the conditions used for finding the correct replacement IProductComponent.

Field Summary

Fields

Modifier and Type	Field	Description
static final BiPredicate<IProductComponent,IProductComponent>	BY_KIND_ID	This BiPredicate uses the IProductComponent.getKindId() to find a suitable replacement for a product switch.

Method Summary

Modifier and Type	Method	Description
static ProductFinderResult	createEmptyResult(IConfigurableModelObject modelObject)	Creates a ProductFinderResult object with an error message indicating that the switch failed because the specified object has no suitable replacements.
static ProductFinderResult	createErrorResult(IConfigurableModelObject modelObject, List<IProductComponent> matchingProductComponents)	Creates a ProductFinderResult object with an error message indicating that the switch failed because the specified object has multiple replacements.
static ProductSwitch.ProductSwitchCondition	from(IConfigurableModelObject modelObject)	Switches the specified model object and all its configurable children to corresponding objects from the new product component.

Methods inherited from class java.lang.Object

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

Field Details

BY_KIND_ID

public static final BiPredicate<IProductComponent,IProductComponent> BY_KIND_ID

This BiPredicate uses the IProductComponent.getKindId() to find a suitable replacement for a product switch. It can be used as a fallback for the from(IConfigurableModelObject) method.

Example usage:

 
     // fallback after a BiPredicate for a special case
     ProductSwitch.from(modelObject).with(mySpecialBiPredicate.or(ProductSwitch.BY_KIND_ID)).to(otherProductComponent);

     // using only
     ProductSwitch.from(modelObject).with(ProductSwitch.BY_KIND_ID).to(otherProductComponent);

     // is the same as the default behavior of
     ProductSwitch.from(modelObject).to(otherProductComponent);
 
 

Method Details

from

public static ProductSwitch.ProductSwitchCondition from(IConfigurableModelObject modelObject)

Switches the specified model object and all its configurable children to corresponding objects from the new product component.

Example usage:

 
      ProductSwitch.from(modelObject).to(newProductComponent);
      // or
      ProductSwitch.from(modelObject)
          .matchingBy(attributeName)
          .to(newProductComponent);
 
 

Parameters:

modelObject - the model object that should be switched to a different product

Returns:

the ProductSwitchConditionBuilder

createErrorResult

public static ProductFinderResult createErrorResult(IConfigurableModelObject modelObject,
 List<IProductComponent> matchingProductComponents)

Creates a ProductFinderResult object with an error message indicating that the switch failed because the specified object has multiple replacements.

Parameters:

modelObject - the object where the switch failed

matchingProductComponents - the results from the product finder

Returns:

a ProductFinderResult.error(String) object with a message

createEmptyResult

public static ProductFinderResult createEmptyResult(IConfigurableModelObject modelObject)

Creates a ProductFinderResult object with an error message indicating that the switch failed because the specified object has no suitable replacements.

Parameters:

modelObject - the object where the switch failed

Returns:

a ProductFinderResult.error(String) object with a message