Package org.faktorips.runtime.productswitch

Class ProductSwitchResults

java.lang.Object

org.faktorips.runtime.productswitch.ProductSwitchResults

public class ProductSwitchResults
extends Object

This class represents the results of a product switch operation. It provides methods to retrieve the switch result for a specific IConfigurableModelObject as well as views of successful and failed switch results.

Since:

23.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductSwitchResults.FailedProductSwitch	Represents the result of a failed product switch operation.
static interface	ProductSwitchResults.ProductSwitchResult	This interface represents the result of a product switch operation for a single model object.
static class	ProductSwitchResults.SuccessfulProductSwitch	Represents the result of a successful product switch operation.

Constructor Summary

Constructors

Constructor	Description
ProductSwitchResults(Map<IConfigurableModelObject,ProductSwitchResults.ProductSwitchResult> result)	Constructs a new instance of ProductSwitchResults with the specified map of product switch results.

Method Summary

Modifier and Type	Method	Description
Map<IConfigurableModelObject,ProductSwitchResults.ProductSwitchResult>	asMap()	Returns an unmodifiable view of all switch results.
boolean	containsFailures()
Map<IConfigurableModelObject,ProductSwitchResults.FailedProductSwitch>	failureAsMap()	Returns an unmodifiable view of all failed switch results.
ProductSwitchResults.ProductSwitchResult	getResultFor(IConfigurableModelObject modelObject)	Returns the switch result for the given model object or null if the model object was not switched, for example if it isn't part of the original object tree or no switch target was found for a parent model object.
int	size()
Map<IConfigurableModelObject,ProductSwitchResults.SuccessfulProductSwitch>	successfulAsMap()	Returns an unmodifiable view of all successful switch results.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSwitchResults

public ProductSwitchResults(Map<IConfigurableModelObject,ProductSwitchResults.ProductSwitchResult> result)

Constructs a new instance of ProductSwitchResults with the specified map of product switch results.

Parameters:

result - the map of switch results

Method Details

asMap

public Map<IConfigurableModelObject,ProductSwitchResults.ProductSwitchResult> asMap()

Returns an unmodifiable view of all switch results.

Returns:

the map of switch results

getResultFor

public ProductSwitchResults.ProductSwitchResult getResultFor(IConfigurableModelObject modelObject)

Returns the switch result for the given model object or null if the model object was not switched, for example if it isn't part of the original object tree or no switch target was found for a parent model object.

Parameters:

modelObject - the model object

Returns:

the switch result for the model object

successfulAsMap

public Map<IConfigurableModelObject,ProductSwitchResults.SuccessfulProductSwitch> successfulAsMap()

Returns an unmodifiable view of all successful switch results.

Returns:

the map of successful switch results

failureAsMap

public Map<IConfigurableModelObject,ProductSwitchResults.FailedProductSwitch> failureAsMap()

Returns an unmodifiable view of all failed switch results.

Returns:

the map of failed switch results

containsFailures

public boolean containsFailures()

Returns:

true if at least one failed switch result is contained in the result; otherwise false

size

public int size()

Returns:

the number of all results