Package org.faktorips.runtime.productswitch

Class ProductFinderResult

java.lang.Object

org.faktorips.runtime.productswitch.ProductFinderResult

public class ProductFinderResult
extends Object

Represents the result of a product finder operation, which contains the correct replacement of an IProductComponent for the given IConfigurableModelObject.

Since:

23.6

Method Summary

Modifier and Type	Method	Description
static ProductFinderResult	empty(String message)	A new ProductFinderResult that no replacement was found.
static ProductFinderResult	error(String message)	A new ProductFinderResult indicating an error while switching, for example when more than one product component was found.
String	getMessage()
IProductComponent	getProductComponent()	Returns the IProductComponent for the replacement.
boolean	isEmpty()	Returns true if the result is an empty result.
boolean	isError()	Returns true if the result is an error(String).
boolean	isPresent()	If a IProductComponent is present, returns true, otherwise false.
static ProductFinderResult	of(IProductComponent productComponent)	Constructs a new ProductFinderResult with the specified product component.

Methods inherited from class java.lang.Object

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

Method Details

of

public static ProductFinderResult of(IProductComponent productComponent)

Constructs a new ProductFinderResult with the specified product component.

Parameters:

productComponent - the correct replacement

Returns:

a ProductFinderResult with the correct replacement

error

public static ProductFinderResult error(String message)

A new ProductFinderResult indicating an error while switching, for example when more than one product component was found.

If more than one finder is chained with the MatchingProductFinder.or(MatchingProductFinder) or AdvancedProductFinder.or(AdvancedProductFinder) method, the error result will stop the evaluation.

Parameters:

message - an error message explaining why the switch failed

Returns:

a ProductFinderResult indicating an error

empty

public static ProductFinderResult empty(String message)

A new ProductFinderResult that no replacement was found.

If more than one finder is chained with the MatchingProductFinder.or(MatchingProductFinder) or AdvancedProductFinder.or(AdvancedProductFinder) method, the empty result will continue to evaluate the chained product finders.

Parameters:

message - a message explaining why no replacement was found

Returns:

a ProductFinderResult indicating that no replacement was found

getProductComponent

public IProductComponent getProductComponent()

Returns the IProductComponent for the replacement.

Returns:

the product component

isError

public boolean isError()

Returns true if the result is an error(String).

Returns:

true if the result is an error

isEmpty

public boolean isEmpty()

Returns true if the result is an empty result.

Returns:

true if the result is empty

isPresent

public boolean isPresent()

If a IProductComponent is present, returns true, otherwise false.

Returns:

true if a value is present, otherwise false

getMessage

public String getMessage()

Returns:

the message explaining why this result isError() or isEmpty()