Package ai.timefold.solver.core.api.score.stream.bi

Interface BiConstraintStream<A,B>

Type Parameters:

A - the type of the first fact in the tuple.

B - the type of the second fact in the tuple.

All Superinterfaces:

ConstraintStream

All Known Subinterfaces:

InnerBiConstraintStream<A,B>

All Known Implementing Classes:

BavetAbstractBiConstraintStream, BavetAftBridgeBiConstraintStream, BavetBiConcatBiConstraintStream, BavetForeBridgeBiConstraintStream, BavetJoinBiConstraintStream, BavetUniConcatBiConstraintStream

public interface BiConstraintStream<A,B>
extends ConstraintStream

A ConstraintStream that matches two facts.

See Also:

• ConstraintStream

Method Summary

Modifier and Type	Method	Description
default BiConstraintStream<A,B>	complement(Class<A> otherClass)	As defined by complement(Class, Function), where the padding function pads with null.
default BiConstraintStream<A,B>	complement(Class<A> otherClass, Function<A,B> paddingFunction)	Adds to the stream all instances of a given class which are not yet present in it.
BiConstraintStream<A,B>	concat(BiConstraintStream<A,B> otherStream)	Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided BiConstraintStream.
default <C, D> QuadConstraintStream<A,B,C,D>	concat(QuadConstraintStream<A,B,C,D> otherStream)	Returns a new QuadConstraintStream containing all the tuples of both this BiConstraintStream and the provided QuadConstraintStream.
<C, D> QuadConstraintStream<A,B,C,D>	concat(QuadConstraintStream<A,B,C,D> otherStream, BiFunction<A,B,C> paddingFunctionC, BiFunction<A,B,D> paddingFunctionD)	Returns a new QuadConstraintStream containing all the tuples of both this BiConstraintStream and the provided QuadConstraintStream.
default <C> TriConstraintStream<A,B,C>	concat(TriConstraintStream<A,B,C> otherStream)	Returns a new TriConstraintStream containing all the tuples of both this BiConstraintStream and the provided TriConstraintStream.
<C> TriConstraintStream<A,B,C>	concat(TriConstraintStream<A,B,C> otherStream, BiFunction<A,B,C> paddingFunction)	Returns a new TriConstraintStream containing all the tuples of both this BiConstraintStream and the provided TriConstraintStream.
default BiConstraintStream<A,B>	concat(UniConstraintStream<A> otherStream)	Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided UniConstraintStream.
BiConstraintStream<A,B>	concat(UniConstraintStream<A> otherStream, Function<A,B> paddingFunction)	Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided UniConstraintStream.
BiConstraintStream<A,B>	distinct()	Transforms the stream in such a way that all the tuples going through it are distinct.
<ResultC_> TriConstraintStream<A,B,ResultC_>	expand(BiFunction<A,B,ResultC_> mapping)	Adds a fact to the end of the tuple, increasing the cardinality of the stream.
<ResultC_, ResultD_> QuadConstraintStream<A,B,ResultC_,ResultD_>	expand(BiFunction<A,B,ResultC_> mappingC, BiFunction<A,B,ResultD_> mappingD)	Adds two facts to the end of the tuple, increasing the cardinality of the stream.
BiConstraintStream<A,B>	filter(BiPredicate<A,B> predicate)	Exhaustively test each tuple of facts against the BiPredicate and match if BiPredicate.test(Object, Object) returns true.
<ResultB_> BiConstraintStream<A,ResultB_>	flattenLast(Function<B,Iterable<ResultB_>> mapping)	Takes each tuple and applies a mapping on the last fact, which turns it into Iterable.
<ResultContainer_, Result_> UniConstraintStream<Result_>	groupBy(BiConstraintCollector<A,B,ResultContainer_,Result_> collector)	Runs all tuples of the stream through a given @BiConstraintCollector and converts them into a new UniConstraintStream which only has a single tuple, the result of applying BiConstraintCollector.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_> BiConstraintStream<ResultA_,ResultB_>	groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA, BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB)	Convert the BiConstraintStream to a BiConstraintStream, containing only a single tuple, the result of applying two BiConstraintCollectors.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_> TriConstraintStream<ResultA_,ResultB_,ResultC_>	groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA, BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB, BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC)	Convert the BiConstraintStream to a TriConstraintStream, containing only a single tuple, the result of applying three BiConstraintCollectors.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_>	groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA, BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB, BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC, BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)	Convert the BiConstraintStream to a QuadConstraintStream, containing only a single tuple, the result of applying four BiConstraintCollectors.
<GroupKey_> UniConstraintStream<GroupKey_>	groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping)	Convert the BiConstraintStream to a UniConstraintStream, containing the set of tuples resulting from applying the group key mapping function on all tuples of the original stream.
<GroupKey_, ResultContainer_, Result_> BiConstraintStream<GroupKey_,Result_>	groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping, BiConstraintCollector<A,B,ResultContainer_,Result_> collector)	Convert the BiConstraintStream to a different BiConstraintStream, consisting of unique tuples.
<GroupKey_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_> TriConstraintStream<GroupKey_,ResultB_,ResultC_>	groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping, BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB, BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC)	Convert the BiConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.
<GroupKey_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> QuadConstraintStream<GroupKey_,ResultB_,ResultC_,ResultD_>	groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping, BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB, BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC, BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)	Convert the BiConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.
<GroupKeyA_, GroupKeyB_> BiConstraintStream<GroupKeyA_,GroupKeyB_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping)	Convert the BiConstraintStream to a different BiConstraintStream, consisting of unique tuples.
<GroupKeyA_, GroupKeyB_, ResultContainer_, Result_> TriConstraintStream<GroupKeyA_,GroupKeyB_,Result_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping, BiConstraintCollector<A,B,ResultContainer_,Result_> collector)	Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector).
<GroupKeyA_, GroupKeyB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> QuadConstraintStream<GroupKeyA_,GroupKeyB_,ResultC_,ResultD_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping, BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC, BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)	Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector).
<GroupKeyA_, GroupKeyB_, GroupKeyC_> TriConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping, BiFunction<A,B,GroupKeyC_> groupKeyCMapping)	Convert the BiConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.
<GroupKeyA_, GroupKeyB_, GroupKeyC_, ResultContainerD_, ResultD_> QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,ResultD_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping, BiFunction<A,B,GroupKeyC_> groupKeyCMapping, BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)	Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector).
<GroupKeyA_, GroupKeyB_, GroupKeyC_, GroupKeyD_> QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,GroupKeyD_>	groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping, BiFunction<A,B,GroupKeyB_> groupKeyBMapping, BiFunction<A,B,GroupKeyC_> groupKeyCMapping, BiFunction<A,B,GroupKeyD_> groupKeyDMapping)	Convert the BiConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.
default <C> BiConstraintStream<A,B>	ifExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C>... joiners)	As defined by ifExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifExists(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by ifExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, TriJoiner...).
default <C> BiConstraintStream<A,B>	ifExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by ifExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifExistsIncludingNullVars(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifNotExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C>... joiners)	As defined by ifNotExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifNotExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifNotExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifNotExists(UniConstraintStream, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifNotExists(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by ifNotExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifNotExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifNotExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExists(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifNotExists(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner...).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingNullVars(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts).
<C> BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner).
default <C> BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner).
default Constraint	impact(String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntBiFunction).
default Constraint	impact(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntBiFunction).
default <Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	impact(Score_ constraintWeight)	Positively or negatively impacts the Score by the constraintWeight for each match and returns a builder to apply optional constraint properties.
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	impact(Score_ constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Positively or negatively impacts the Score by constraintWeight multiplied by matchWeight for each match and returns a builder to apply optional constraint properties.
default Constraint	impactBigDecimal(String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, BiFunction).
default Constraint	impactBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, BiFunction).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	impactBigDecimal(Score_ constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	As defined by impact(Score, ToIntBiFunction), with an impact of type BigDecimal.
default BiConstraintBuilder<A,B,?>	impactConfigurable()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score) and ConstraintWeightOverrides.
default Constraint	impactConfigurable(String constraintPackage, String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurable(String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	impactConfigurable(ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableBigDecimal(String constraintPackage, String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableBigDecimal(String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	impactConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableLong(String constraintPackage, String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableLong(String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	impactConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	impactLong(String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongBiFunction).
default Constraint	impactLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongBiFunction).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	impactLong(Score_ constraintWeight, ToLongBiFunction<A,B> matchWeigher)	As defined by impact(Score, ToIntBiFunction), with an impact of type long.
default <C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream)	Create a new TriConstraintStream for every combination of [A, B] and C.
default <C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner)	Create a new TriConstraintStream for every combination of [A, B] and C for which the TriJoiner is true (for the properties it extracts from both facts).
<C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream, TriJoiner<A,B,C>... joiners)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(UniConstraintStream<C> otherStream, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(Class<C> otherClass)	Create a new TriConstraintStream for every combination of [A, B] and C.
default <C> TriConstraintStream<A,B,C>	join(Class<C> otherClass, TriJoiner<A,B,C> joiner)	Create a new TriConstraintStream for every combination of [A, B] and C for which the TriJoiner is true (for the properties it extracts from both facts).
<C> TriConstraintStream<A,B,C>	join(Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3)	As defined by join(Class, TriJoiner).
default <C> TriConstraintStream<A,B,C>	join(Class<C> otherClass, TriJoiner<A,B,C> joiner1, TriJoiner<A,B,C> joiner2, TriJoiner<A,B,C> joiner3, TriJoiner<A,B,C> joiner4)	As defined by join(Class, TriJoiner).
<ResultA_> UniConstraintStream<ResultA_>	map(BiFunction<A,B,ResultA_> mapping)	As defined by UniConstraintStream.map(Function).
<ResultA_, ResultB_> BiConstraintStream<ResultA_,ResultB_>	map(BiFunction<A,B,ResultA_> mappingA, BiFunction<A,B,ResultB_> mappingB)	As defined by map(BiFunction), only resulting in BiConstraintStream.
<ResultA_, ResultB_, ResultC_> TriConstraintStream<ResultA_,ResultB_,ResultC_>	map(BiFunction<A,B,ResultA_> mappingA, BiFunction<A,B,ResultB_> mappingB, BiFunction<A,B,ResultC_> mappingC)	As defined by map(BiFunction), only resulting in TriConstraintStream.
<ResultA_, ResultB_, ResultC_, ResultD_> QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_>	map(BiFunction<A,B,ResultA_> mappingA, BiFunction<A,B,ResultB_> mappingB, BiFunction<A,B,ResultC_> mappingC, BiFunction<A,B,ResultD_> mappingD)	As defined by map(BiFunction), only resulting in QuadConstraintStream.
default Constraint	penalize(String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntBiFunction).
default Constraint	penalize(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntBiFunction).
default <Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalize(Score_ constraintWeight)	As defined by penalize(Score, ToIntBiFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalize(Score_ constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Applies a negative Score impact, subtracting the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.
default Constraint	penalizeBigDecimal(String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, BiFunction).
default Constraint	penalizeBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, BiFunction).
default <Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalizeBigDecimal(Score_ constraintWeight)	As defined by penalizeBigDecimal(Score, BiFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalizeBigDecimal(Score_ constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	As defined by penalize(Score, ToIntBiFunction), with a penalty of type BigDecimal.
default BiConstraintBuilder<A,B,?>	penalizeConfigurable()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurable(String constraintPackage, String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurable(String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	penalizeConfigurable(ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableBigDecimal(String constraintPackage, String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableBigDecimal(String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	penalizeConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableLong(String constraintPackage, String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableLong(String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	penalizeConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	penalizeLong(String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongBiFunction).
default Constraint	penalizeLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongBiFunction).
default <Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalizeLong(Score_ constraintWeight)	As defined by penalizeLong(Score, ToLongBiFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	penalizeLong(Score_ constraintWeight, ToLongBiFunction<A,B> matchWeigher)	As defined by penalize(Score, ToIntBiFunction), with a penalty of type long.
default Constraint	reward(String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntBiFunction).
default Constraint	reward(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntBiFunction).
default <Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	reward(Score_ constraintWeight)	As defined by reward(Score, ToIntBiFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	reward(Score_ constraintWeight, ToIntBiFunction<A,B> matchWeigher)	Applies a positive Score impact, adding the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.
default Constraint	rewardBigDecimal(String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, BiFunction).
default Constraint	rewardBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, BiFunction).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	rewardBigDecimal(Score_ constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher)	As defined by reward(Score, ToIntBiFunction), with a penalty of type BigDecimal.
default BiConstraintBuilder<A,B,?>	rewardConfigurable()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurable(String constraintPackage, String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated. Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurable(String constraintName, ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	rewardConfigurable(ToIntBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableBigDecimal(String constraintPackage, String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableBigDecimal(String constraintName, BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	rewardConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableLong(String constraintPackage, String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableLong(String constraintName, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
BiConstraintBuilder<A,B,?>	rewardConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.
default Constraint	rewardLong(String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongBiFunction).
default Constraint	rewardLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongBiFunction<A,B> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongBiFunction).
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	rewardLong(Score_ constraintWeight, ToLongBiFunction<A,B> matchWeigher)	As defined by reward(Score, ToIntBiFunction), with a penalty of type long.

Methods inherited from interface ai.timefold.solver.core.api.score.stream.ConstraintStream

getConstraintFactory, impact, impact, penalize, penalize, penalizeConfigurable, penalizeConfigurable, reward, reward, rewardConfigurable, rewardConfigurable

Method Details

filter

BiConstraintStream<A,B> filter(BiPredicate<A,B> predicate)

Exhaustively test each tuple of facts against the BiPredicate and match if BiPredicate.test(Object, Object) returns true.

Important: This is slower and less scalable than UniConstraintStream.join(UniConstraintStream, BiJoiner) with a proper BiJoiner predicate (such as Joiners.equal(Function, Function), because the latter applies hashing and/or indexing, so it doesn't create every combination just to filter it out.

Parameters:

predicate - never null

Returns:

never null

join

default <C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream)

Create a new TriConstraintStream for every combination of [A, B] and C.

Important: TriConstraintStream.filter(TriPredicate) Filtering} this is slower and less scalable than a join(UniConstraintStream, TriJoiner), because it doesn't apply hashing and/or indexing on the properties, so it creates and checks every combination of [A, B] and C.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

Returns:

never null, a stream that matches every combination of [A, B] and C

join

default <C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner)

Create a new TriConstraintStream for every combination of [A, B] and C for which the TriJoiner is true (for the properties it extracts from both facts).

Important: This is faster and more scalable than a join followed by a filter, because it applies hashing and/or indexing on the properties, so it doesn't create nor checks every combination of [A, B] and C.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which the TriFunction is true

join

default <C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

default <C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

default <C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

<C> TriConstraintStream<A,B,C> join(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C>... joiners)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 BiJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiners - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

default <C> TriConstraintStream<A,B,C> join(Class<C> otherClass)

Create a new TriConstraintStream for every combination of [A, B] and C.

Important: TriConstraintStream.filter(TriPredicate) Filtering} this is slower and less scalable than a join(Class, TriJoiner), because it doesn't apply hashing and/or indexing on the properties, so it creates and checks every combination of [A, B] and C.

Note that, if a legacy constraint stream uses ConstraintFactory.from(Class) as opposed to ConstraintFactory.forEach(Class), a different range of C may be selected. (See ConstraintFactory.from(Class) Javadoc.)

This method is syntactic sugar for join(UniConstraintStream).

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

Returns:

never null, a stream that matches every combination of [A, B] and C

join

default <C> TriConstraintStream<A,B,C> join(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Create a new TriConstraintStream for every combination of [A, B] and C for which the TriJoiner is true (for the properties it extracts from both facts).

Important: This is faster and more scalable than a join followed by a filter, because it applies hashing and/or indexing on the properties, so it doesn't create nor checks every combination of [A, B] and C.

Note that, if a legacy constraint stream uses ConstraintFactory.from(Class) as opposed to ConstraintFactory.forEach(Class), a different range of C may be selected. (See ConstraintFactory.from(Class) Javadoc.)

This method is syntactic sugar for join(UniConstraintStream, TriJoiner).

This method has overloaded methods with multiple TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which the TriJoiner is true

join

default <C> TriConstraintStream<A,B,C> join(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

default <C> TriConstraintStream<A,B,C> join(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

default <C> TriConstraintStream<A,B,C> join(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

join

<C> TriConstraintStream<A,B,C> join(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

As defined by join(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 BiJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every combination of [A, B] and C for which all the joiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts).

This method has overloaded methods with multiple TriJoiner parameters.

Note that, if a legacy constraint stream uses ConstraintFactory.from(Class) as opposed to ConstraintFactory.forEach(Class), a different definition of exists applies. (See ConstraintFactory.from(Class) Javadoc.)

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiner is true

ifExists

default <C> BiConstraintStream<A,B> ifExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

<C> BiConstraintStream<A,B> ifExists(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

As defined by ifExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts).

This method has overloaded methods with multiple TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiner is true

ifExists

default <C> BiConstraintStream<A,B> ifExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

default <C> BiConstraintStream<A,B> ifExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExists

<C> BiConstraintStream<A,B> ifExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C>... joiners)

As defined by ifExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C exists for which the TriJoiner is true (for the properties it extracts from the facts). For classes annotated with PlanningEntity, this method also includes entities with null variables, or entities that are not assigned to any list variable.

This method has overloaded methods with multiple TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiner is true

ifExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifExistsIncludingNullVars(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExistsIncludingUnassigned

<C> BiConstraintStream<A,B> ifExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

As defined by ifExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts).

This method has overloaded methods with multiple TriJoiner parameters.

Note that, if a legacy constraint stream uses ConstraintFactory.from(Class) as opposed to ConstraintFactory.forEach(Class), a different definition of exists applies. (See ConstraintFactory.from(Class) Javadoc.)

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiner is true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifNotExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifNotExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifNotExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

<C> BiConstraintStream<A,B> ifNotExists(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

As defined by ifNotExists(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts).

This method has overloaded methods with multiple TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiner is true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifNotExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifNotExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

default <C> BiConstraintStream<A,B> ifNotExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifNotExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExists

<C> BiConstraintStream<A,B> ifNotExists(UniConstraintStream<C> otherStream,
 TriJoiner<A,B,C>... joiners)

As defined by ifNotExists(UniConstraintStream, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherStream - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Create a new BiConstraintStream for every pair of A and B where C does not exist for which the TriJoiner is true (for the properties it extracts from the facts). For classes annotated with PlanningEntity, this method also includes entities with null variables, or entities that are not assigned to any list variable.

This method has overloaded methods with multiple TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiner is true

ifNotExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExistsIncludingUnassigned

default <C> BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExistsIncludingUnassigned

<C> BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

As defined by ifNotExistsIncludingUnassigned(Class, TriJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 TriJoiner parameters.

Type Parameters:

C - the type of the third matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

groupBy

<ResultContainer_,
Result_>
UniConstraintStream<Result_> groupBy(BiConstraintCollector<A,B,ResultContainer_,Result_> collector)

Runs all tuples of the stream through a given @BiConstraintCollector and converts them into a new UniConstraintStream which only has a single tuple, the result of applying BiConstraintCollector.

Type Parameters:

ResultContainer_ - the mutable accumulation type (often hidden as an implementation detail)

Result_ - the type of a fact in the destination UniConstraintStream's tuple

Parameters:

collector - never null, the collector to perform the grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<ResultContainerA_,
ResultA_,
ResultContainerB_,
ResultB_>
BiConstraintStream<ResultA_,ResultB_> groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA,
 BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB)

Convert the BiConstraintStream to a BiConstraintStream, containing only a single tuple, the result of applying two BiConstraintCollectors.

Type Parameters:

ResultContainerA_ - the mutable accumulation type (often hidden as an implementation detail)

ResultA_ - the type of the first fact in the destination BiConstraintStream's tuple

ResultContainerB_ - the mutable accumulation type (often hidden as an implementation detail)

ResultB_ - the type of the second fact in the destination BiConstraintStream's tuple

Parameters:

collectorA - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorB - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<ResultContainerA_,
ResultA_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_>
TriConstraintStream<ResultA_,ResultB_,ResultC_> groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA,
 BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB,
 BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC)

Convert the BiConstraintStream to a TriConstraintStream, containing only a single tuple, the result of applying three BiConstraintCollectors.

Type Parameters:

ResultContainerA_ - the mutable accumulation type (often hidden as an implementation detail)

ResultA_ - the type of the first fact in the destination TriConstraintStream's tuple

ResultContainerB_ - the mutable accumulation type (often hidden as an implementation detail)

ResultB_ - the type of the second fact in the destination TriConstraintStream's tuple

ResultContainerC_ - the mutable accumulation type (often hidden as an implementation detail)

ResultC_ - the type of the third fact in the destination TriConstraintStream's tuple

Parameters:

collectorA - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorB - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorC - never null, the collector to perform the third grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<ResultContainerA_,
ResultA_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_,
ResultContainerD_,
ResultD_>
QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_> groupBy(BiConstraintCollector<A,B,ResultContainerA_,ResultA_> collectorA,
 BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB,
 BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC,
 BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)

Convert the BiConstraintStream to a QuadConstraintStream, containing only a single tuple, the result of applying four BiConstraintCollectors.

Type Parameters:

ResultContainerA_ - the mutable accumulation type (often hidden as an implementation detail)

ResultA_ - the type of the first fact in the destination QuadConstraintStream's tuple

ResultContainerB_ - the mutable accumulation type (often hidden as an implementation detail)

ResultB_ - the type of the second fact in the destination QuadConstraintStream's tuple

ResultContainerC_ - the mutable accumulation type (often hidden as an implementation detail)

ResultC_ - the type of the third fact in the destination QuadConstraintStream's tuple

ResultContainerD_ - the mutable accumulation type (often hidden as an implementation detail)

ResultD_ - the type of the fourth fact in the destination QuadConstraintStream's tuple

Parameters:

collectorA - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorB - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorC - never null, the collector to perform the third grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorD - never null, the collector to perform the fourth grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKey_> UniConstraintStream<GroupKey_> groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping)

Convert the BiConstraintStream to a UniConstraintStream, containing the set of tuples resulting from applying the group key mapping function on all tuples of the original stream. Neither tuple of the new stream Objects.equals(Object, Object) any other.

Type Parameters:

GroupKey_ - the type of a fact in the destination UniConstraintStream's tuple

Parameters:

groupKeyMapping - never null, mapping function to convert each element in the stream to a different element

Returns:

never null

groupBy

<GroupKey_,
ResultContainer_,
Result_>
BiConstraintStream<GroupKey_,Result_> groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping,
 BiConstraintCollector<A,B,ResultContainer_,Result_> collector)

Convert the BiConstraintStream to a different BiConstraintStream, consisting of unique tuples.

The first fact is the return value of the group key mapping function, applied on the incoming tuple. The second fact is the return value of a given BiConstraintCollector applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKey_ - the type of the first fact in the destination BiConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainer_ - the mutable accumulation type (often hidden as an implementation detail)

Result_ - the type of the second fact in the destination BiConstraintStream's tuple

Parameters:

groupKeyMapping - never null, function to convert the fact in the original tuple to a different fact

collector - never null, the collector to perform the grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKey_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_>
TriConstraintStream<GroupKey_,ResultB_,ResultC_> groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping,
 BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB,
 BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC)

Convert the BiConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.

The first fact is the return value of the group key mapping function, applied on the incoming tuple. The remaining facts are the return value of the respective BiConstraintCollector applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKey_ - the type of the first fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainerB_ - the mutable accumulation type (often hidden as an implementation detail)

ResultB_ - the type of the second fact in the destination TriConstraintStream's tuple

ResultContainerC_ - the mutable accumulation type (often hidden as an implementation detail)

ResultC_ - the type of the third fact in the destination TriConstraintStream's tuple

Parameters:

groupKeyMapping - never null, function to convert the fact in the original tuple to a different fact

collectorB - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorC - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKey_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_,
ResultContainerD_,
ResultD_>
QuadConstraintStream<GroupKey_,ResultB_,ResultC_,ResultD_> groupBy(BiFunction<A,B,GroupKey_> groupKeyMapping,
 BiConstraintCollector<A,B,ResultContainerB_,ResultB_> collectorB,
 BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC,
 BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)

Convert the BiConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.

The first fact is the return value of the group key mapping function, applied on the incoming tuple. The remaining facts are the return value of the respective BiConstraintCollector applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKey_ - the type of the first fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainerB_ - the mutable accumulation type (often hidden as an implementation detail)

ResultB_ - the type of the second fact in the destination QuadConstraintStream's tuple

ResultContainerC_ - the mutable accumulation type (often hidden as an implementation detail)

ResultC_ - the type of the third fact in the destination QuadConstraintStream's tuple

ResultContainerD_ - the mutable accumulation type (often hidden as an implementation detail)

ResultD_ - the type of the fourth fact in the destination QuadConstraintStream's tuple

Parameters:

groupKeyMapping - never null, function to convert the fact in the original tuple to a different fact

collectorB - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorC - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorD - never null, the collector to perform the third grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_>
BiConstraintStream<GroupKeyA_,GroupKeyB_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping)

Convert the BiConstraintStream to a different BiConstraintStream, consisting of unique tuples.

The first fact is the return value of the first group key mapping function, applied on the incoming tuple. The second fact is the return value of the second group key mapping function, applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination BiConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination BiConstraintStream's tuple; must honor the general contract of hashCode.

Parameters:

groupKeyAMapping - never null, function to convert the facts in the original tuple to a new fact

groupKeyBMapping - never null, function to convert the facts in the original tuple to another new fact

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_,
ResultContainer_,
Result_>
TriConstraintStream<GroupKeyA_,GroupKeyB_,Result_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping,
 BiConstraintCollector<A,B,ResultContainer_,Result_> collector)

Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector). That is, the first and second facts in the tuple follow the groupBy(BiFunction, BiFunction) semantics, and the third fact is the result of applying BiConstraintCollector.finisher() on all the tuples of the original UniConstraintStream that belong to the group.

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainer_ - the mutable accumulation type (often hidden as an implementation detail)

Result_ - the type of the third fact in the destination TriConstraintStream's tuple

Parameters:

groupKeyAMapping - never null, function to convert the original tuple into a first fact

groupKeyBMapping - never null, function to convert the original tuple into a second fact

collector - never null, the collector to perform the grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_,
ResultContainerC_,
ResultC_,
ResultContainerD_,
ResultD_>
QuadConstraintStream<GroupKeyA_,GroupKeyB_,ResultC_,ResultD_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping,
 BiConstraintCollector<A,B,ResultContainerC_,ResultC_> collectorC,
 BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)

Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector). That is, the first and second facts in the tuple follow the groupBy(BiFunction, BiFunction) semantics. The third fact is the result of applying the first BiConstraintCollector.finisher() on all the tuples of the original BiConstraintStream that belong to the group. The fourth fact is the result of applying the second BiConstraintCollector.finisher() on all the tuples of the original BiConstraintStream that belong to the group

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainerC_ - the mutable accumulation type (often hidden as an implementation detail)

ResultC_ - the type of the third fact in the destination QuadConstraintStream's tuple

ResultContainerD_ - the mutable accumulation type (often hidden as an implementation detail)

ResultD_ - the type of the fourth fact in the destination QuadConstraintStream's tuple

Parameters:

groupKeyAMapping - never null, function to convert the original tuple into a first fact

groupKeyBMapping - never null, function to convert the original tuple into a second fact

collectorC - never null, the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

collectorD - never null, the collector to perform the second grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_>
TriConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping,
 BiFunction<A,B,GroupKeyC_> groupKeyCMapping)

Convert the BiConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.

The first fact is the return value of the first group key mapping function, applied on the incoming tuple. The second fact is the return value of the second group key mapping function, applied on all incoming tuples with the same first fact. The third fact is the return value of the third group key mapping function, applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyC_ - the type of the third fact in the destination TriConstraintStream's tuple; must honor the general contract of hashCode.

Parameters:

groupKeyAMapping - never null, function to convert the original tuple into a first fact

groupKeyBMapping - never null, function to convert the original tuple into a second fact

groupKeyCMapping - never null, function to convert the original tuple into a third fact

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_,
ResultContainerD_,
ResultD_>
QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,ResultD_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping,
 BiFunction<A,B,GroupKeyC_> groupKeyCMapping,
 BiConstraintCollector<A,B,ResultContainerD_,ResultD_> collectorD)

Combines the semantics of groupBy(BiFunction, BiFunction) and groupBy(BiConstraintCollector). That is, the first three facts in the tuple follow the groupBy(BiFunction, BiFunction) semantics. The final fact is the result of applying the first BiConstraintCollector.finisher() on all the tuples of the original BiConstraintStream that belong to the group.

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyC_ - the type of the third fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

ResultContainerD_ - the mutable accumulation type (often hidden as an implementation detail)

ResultD_ - the type of the fourth fact in the destination QuadConstraintStream's tuple

Parameters:

groupKeyAMapping - never null, function to convert the original tuple into a first fact

groupKeyBMapping - never null, function to convert the original tuple into a second fact

groupKeyCMapping - never null, function to convert the original tuple into a third fact

collectorD - never null, the collector to perform the grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

Returns:

never null

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_,
GroupKeyD_>
QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,GroupKeyD_> groupBy(BiFunction<A,B,GroupKeyA_> groupKeyAMapping,
 BiFunction<A,B,GroupKeyB_> groupKeyBMapping,
 BiFunction<A,B,GroupKeyC_> groupKeyCMapping,
 BiFunction<A,B,GroupKeyD_> groupKeyDMapping)

Convert the BiConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.

The first fact is the return value of the first group key mapping function, applied on the incoming tuple. The second fact is the return value of the second group key mapping function, applied on all incoming tuples with the same first fact. The third fact is the return value of the third group key mapping function, applied on all incoming tuples with the same first fact. The fourth fact is the return value of the fourth group key mapping function, applied on all incoming tuples with the same first fact.

Type Parameters:

GroupKeyA_ - the type of the first fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyB_ - the type of the second fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyC_ - the type of the third fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

GroupKeyD_ - the type of the fourth fact in the destination QuadConstraintStream's tuple; must honor the general contract of hashCode.

Parameters:

groupKeyAMapping - never null, function to convert the original tuple into a first fact

groupKeyBMapping - never null, function to convert the original tuple into a second fact

groupKeyCMapping - never null, function to convert the original tuple into a third fact

groupKeyDMapping - never null, function to convert the original tuple into a fourth fact

Returns:

never null

map

<ResultA_> UniConstraintStream<ResultA_> map(BiFunction<A,B,ResultA_> mapping)

As defined by UniConstraintStream.map(Function).

Type Parameters:

ResultA_ - the type of the only fact in the resulting UniConstraintStream's tuple

Parameters:

mapping - never null, function to convert the original tuple into the new tuple

Returns:

never null

map

<ResultA_,
ResultB_>
BiConstraintStream<ResultA_,ResultB_> map(BiFunction<A,B,ResultA_> mappingA,
 BiFunction<A,B,ResultB_> mappingB)

As defined by map(BiFunction), only resulting in BiConstraintStream.

Type Parameters:

ResultA_ - the type of the first fact in the resulting BiConstraintStream's tuple

ResultB_ - the type of the first fact in the resulting BiConstraintStream's tuple

Parameters:

mappingA - never null, function to convert the original tuple into the first fact of a new tuple

mappingB - never null, function to convert the original tuple into the second fact of a new tuple

Returns:

never null

map

<ResultA_,
ResultB_,
ResultC_>
TriConstraintStream<ResultA_,ResultB_,ResultC_> map(BiFunction<A,B,ResultA_> mappingA,
 BiFunction<A,B,ResultB_> mappingB,
 BiFunction<A,B,ResultC_> mappingC)

As defined by map(BiFunction), only resulting in TriConstraintStream.

Type Parameters:

ResultA_ - the type of the first fact in the resulting TriConstraintStream's tuple

ResultB_ - the type of the first fact in the resulting TriConstraintStream's tuple

ResultC_ - the type of the third fact in the resulting TriConstraintStream's tuple

Parameters:

mappingA - never null, function to convert the original tuple into the first fact of a new tuple

mappingB - never null, function to convert the original tuple into the second fact of a new tuple

mappingC - never null, function to convert the original tuple into the third fact of a new tuple

Returns:

never null

map

<ResultA_,
ResultB_,
ResultC_,
ResultD_>
QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_> map(BiFunction<A,B,ResultA_> mappingA,
 BiFunction<A,B,ResultB_> mappingB,
 BiFunction<A,B,ResultC_> mappingC,
 BiFunction<A,B,ResultD_> mappingD)

As defined by map(BiFunction), only resulting in QuadConstraintStream.

Type Parameters:

ResultA_ - the type of the first fact in the resulting QuadConstraintStream's tuple

ResultB_ - the type of the first fact in the resulting QuadConstraintStream's tuple

ResultC_ - the type of the third fact in the resulting QuadConstraintStream's tuple

ResultD_ - the type of the third fact in the resulting QuadConstraintStream's tuple

Parameters:

mappingA - never null, function to convert the original tuple into the first fact of a new tuple

mappingB - never null, function to convert the original tuple into the second fact of a new tuple

mappingC - never null, function to convert the original tuple into the third fact of a new tuple

mappingD - never null, function to convert the original tuple into the fourth fact of a new tuple

Returns:

never null

flattenLast

<ResultB_> BiConstraintStream<A,ResultB_> flattenLast(Function<B,Iterable<ResultB_>> mapping)

Takes each tuple and applies a mapping on the last fact, which turns it into Iterable. Returns a constraint stream consisting of tuples of the first fact and the contents of the Iterable one after another. In other words, it will replace the current tuple with new tuples, a cartesian product of A and the individual items from the Iterable.

This may produce a stream with duplicate tuples. See distinct() for details.

In cases where the last fact is already Iterable, use Function.identity() as the argument.

Simple example: assuming a constraint stream of (PersonName, Person) [(Ann, (name = Ann, roles = [USER, ADMIN])), (Beth, (name = Beth, roles = [USER])), (Cathy, (name = Cathy, roles = [ADMIN, AUDITOR]))], calling flattenLast(Person::getRoles) on such stream will produce a stream of [(Ann, USER), (Ann, ADMIN), (Beth, USER), (Cathy, ADMIN), (Cathy, AUDITOR)].

Type Parameters:

ResultB_ - the type of the last fact in the resulting tuples. It is recommended that this type be deeply immutable. Not following this recommendation may lead to hard-to-debug hashing issues down the stream, especially if this value is ever used as a group key.

Parameters:

mapping - never null, function to convert the last fact in the original tuple into Iterable. For performance, returning an implementation of Collection is preferred.

Returns:

never null

distinct

BiConstraintStream<A,B> distinct()

Transforms the stream in such a way that all the tuples going through it are distinct. (No two result tuples are equal.)

By default, tuples going through a constraint stream are distinct. However, operations such as map(BiFunction) may create a stream which breaks that promise. By calling this method on such a stream, duplicate copies of the same tuple are omitted at a performance cost.

Returns:

never null

concat

default BiConstraintStream<A,B> concat(UniConstraintStream<A> otherStream)

Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided UniConstraintStream. The UniConstraintStream tuples will be padded from the right by null.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [C, D, E], this.concat(other) will consist of [(A1, A2), (B1, B2), (C1, C2), (C, null), (D, null), (E, null)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

Returns:

never null

concat

BiConstraintStream<A,B> concat(UniConstraintStream<A> otherStream,
 Function<A,B> paddingFunction)

Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided UniConstraintStream. The UniConstraintStream tuples will be padded from the right by the result of the padding function.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [C, D, E], this.concat(other, a -> null) will consist of [(A1, A2), (B1, B2), (C1, C2), (C, null), (D, null), (E, null)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

paddingFunction - never null, function to find the padding for the second fact

Returns:

never null

concat

BiConstraintStream<A,B> concat(BiConstraintStream<A,B> otherStream)

Returns a new BiConstraintStream containing all the tuples of both this BiConstraintStream and the provided BiConstraintStream. Tuples in both this BiConstraintStream and the provided BiConstraintStream will appear at least twice.

For instance, if this stream consists of [(A, 1), (B, 2), (C, 3)] and the other stream consists of [(C, 3), (D, 4), (E, 5)], this.concat(other) will consist of [(A, 1), (B, 2), (C, 3), (C, 3), (D, 4), (E, 5)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

Returns:

never null

concat

default <C> TriConstraintStream<A,B,C> concat(TriConstraintStream<A,B,C> otherStream)

Returns a new TriConstraintStream containing all the tuples of both this BiConstraintStream and the provided TriConstraintStream. The BiConstraintStream tuples will be padded from the right by null.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [(C1, C2, C3), (D1, D2, D3), (E1, E2, E3)], this.concat(other) will consist of [(A1, A2, null), (B1, B2, null), (C1, C2, null), (C1, C2, C3), (D1, D2, D3), (E1, E2, E3)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

Returns:

never null

concat

<C> TriConstraintStream<A,B,C> concat(TriConstraintStream<A,B,C> otherStream,
 BiFunction<A,B,C> paddingFunction)

Returns a new TriConstraintStream containing all the tuples of both this BiConstraintStream and the provided TriConstraintStream. The BiConstraintStream tuples will be padded from the right by the result of the padding function.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [(C1, C2, C3), (D1, D2, D3), (E1, E2, E3)], this.concat(other, (a, b) -> null) will consist of [(A1, A2, null), (B1, B2, null), (C1, C2, null), (C1, C2, C3), (D1, D2, D3), (E1, E2, E3)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

paddingFunction - never null, function to find the padding for the third fact

Returns:

never null

concat

default <C,
D> QuadConstraintStream<A,B,C,D> concat(QuadConstraintStream<A,B,C,D> otherStream)

Returns a new QuadConstraintStream containing all the tuples of both this BiConstraintStream and the provided QuadConstraintStream. The BiConstraintStream tuples will be padded from the right by null.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [(C1, C2, C3, C4), (D1, D2, D3, D4), (E1, E2, E3, E4)], this.concat(other) will consist of [(A1, A2, null, null), (B1, B2, null, null), (C1, C2, null, null), (C1, C2, C3, C4), (D1, D2, D3, D4), (E1, E2, E3, E4)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

Returns:

never null

concat

<C,
D> QuadConstraintStream<A,B,C,D> concat(QuadConstraintStream<A,B,C,D> otherStream,
 BiFunction<A,B,C> paddingFunctionC,
 BiFunction<A,B,D> paddingFunctionD)

Returns a new QuadConstraintStream containing all the tuples of both this BiConstraintStream and the provided QuadConstraintStream. The BiConstraintStream tuples will be padded from the right by the results of the padding functions.

For instance, if this stream consists of [(A1, A2), (B1, B2), (C1, C2)] and the other stream consists of [(C1, C2, C3, C4), (D1, D2, D3, D4), (E1, E2, E3, E4)], this.concat(other, (a, b) -> null, (a, b) -> null) will consist of [(A1, A2, null, null), (B1, B2, null, null), (C1, C2, null, null), (C1, C2, C3, C4), (D1, D2, D3, D4), (E1, E2, E3, E4)].

This operation can be thought of as an or between streams.

Parameters:

otherStream - never null

paddingFunctionC - never null, function to find the padding for the third fact

paddingFunctionD - never null, function to find the padding for the fourth fact

Returns:

never null

expand

<ResultC_> TriConstraintStream<A,B,ResultC_> expand(BiFunction<A,B,ResultC_> mapping)

Adds a fact to the end of the tuple, increasing the cardinality of the stream. Useful for storing results of expensive computations on the original tuple.

Use with caution, as the benefits of caching computation may be outweighed by increased memory allocation rates coming from tuple creation. If more than two facts are to be added, prefer expand(BiFunction, BiFunction).

Type Parameters:

ResultC_ - type of the final fact of the new tuple

Parameters:

mapping - function to produce the new fact from the original tuple

Returns:

never null

expand

<ResultC_,
ResultD_>
QuadConstraintStream<A,B,ResultC_,ResultD_> expand(BiFunction<A,B,ResultC_> mappingC,
 BiFunction<A,B,ResultD_> mappingD)

Adds two facts to the end of the tuple, increasing the cardinality of the stream. Useful for storing results of expensive computations on the original tuple.

Use with caution, as the benefits of caching computation may be outweighed by increased memory allocation rates coming from tuple creation.

Type Parameters:

ResultC_ - type of the third fact of the new tuple

ResultD_ - type of the final fact of the new tuple

Parameters:

mappingC - function to produce the new third fact from the original tuple

mappingD - function to produce the new final fact from the original tuple

Returns:

never null

penalize

default <Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalize(Score_ constraintWeight)

As defined by penalize(Score, ToIntBiFunction), where the match weight is one (1).

Returns:

never null

penalizeLong

default <Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalizeLong(Score_ constraintWeight)

As defined by penalizeLong(Score, ToLongBiFunction), where the match weight is one (1).

Returns:

never null

penalizeBigDecimal

default <Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalizeBigDecimal(Score_ constraintWeight)

As defined by penalizeBigDecimal(Score, BiFunction), where the match weight is one (1).

Returns:

never null

penalize

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalize(Score_ constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Applies a negative Score impact, subtracting the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

For non-int Score types use penalizeLong(Score, ToLongBiFunction) or penalizeBigDecimal(Score, BiFunction) instead.

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeLong

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalizeLong(Score_ constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

As defined by penalize(Score, ToIntBiFunction), with a penalty of type long.

penalizeBigDecimal

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> penalizeBigDecimal(Score_ constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

As defined by penalize(Score, ToIntBiFunction), with a penalty of type BigDecimal.

penalizeConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
default BiConstraintBuilder<A,B,?> penalizeConfigurable()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score) and ConstraintWeightOverrides.

Negatively impacts the Score, subtracting the ConstraintWeight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Returns:

never null

penalizeConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> penalizeConfigurable(ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Negatively impacts the Score, subtracting the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Parameters:

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeConfigurableLong

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> penalizeConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurable(ToIntBiFunction), with a penalty of type long.

penalizeConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> penalizeConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.

reward

default <Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> reward(Score_ constraintWeight)

As defined by reward(Score, ToIntBiFunction), where the match weight is one (1).

Returns:

never null

reward

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> reward(Score_ constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Applies a positive Score impact, adding the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

For non-int Score types use rewardLong(Score, ToLongBiFunction) or rewardBigDecimal(Score, BiFunction) instead.

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardLong

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> rewardLong(Score_ constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

As defined by reward(Score, ToIntBiFunction), with a penalty of type long.

rewardBigDecimal

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> rewardBigDecimal(Score_ constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

As defined by reward(Score, ToIntBiFunction), with a penalty of type BigDecimal.

rewardConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
default BiConstraintBuilder<A,B,?> rewardConfigurable()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Positively impacts the Score, adding the ConstraintWeight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Returns:

never null

rewardConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> rewardConfigurable(ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Positively impacts the Score, adding the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Parameters:

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardConfigurableLong

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> rewardConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurable(ToIntBiFunction), with a penalty of type long.

rewardConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> rewardConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.

impact

default <Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> impact(Score_ constraintWeight)

Positively or negatively impacts the Score by the constraintWeight for each match and returns a builder to apply optional constraint properties.

Use penalize(...) or reward(...) instead, unless this constraint can both have positive and negative weights.

Parameters:

constraintWeight - never null

Returns:

never null

impact

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> impact(Score_ constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Positively or negatively impacts the Score by constraintWeight multiplied by matchWeight for each match and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

Use penalize(...) or reward(...) instead, unless this constraint can both have positive and negative weights.

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactLong

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> impactLong(Score_ constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

As defined by impact(Score, ToIntBiFunction), with an impact of type long.

impactBigDecimal

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> impactBigDecimal(Score_ constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

As defined by impact(Score, ToIntBiFunction), with an impact of type BigDecimal.

impactConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
default BiConstraintBuilder<A,B,?> impactConfigurable()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score) and ConstraintWeightOverrides.

Positively impacts the Score by the ConstraintWeight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Returns:

never null

impactConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> impactConfigurable(ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Positively impacts the Score by the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Returns:

never null

impactConfigurableLong

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> impactConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by impactConfigurable(ToIntBiFunction), with an impact of type long.

impactConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
BiConstraintBuilder<A,B,?> impactConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by impactConfigurable(ToIntBiFunction), with an impact of type BigDecimal.

complement

default BiConstraintStream<A,B> complement(Class<A> otherClass)

As defined by complement(Class, Function), where the padding function pads with null.

complement

default BiConstraintStream<A,B> complement(Class<A> otherClass,
 Function<A,B> paddingFunction)

Adds to the stream all instances of a given class which are not yet present in it. These instances must be present in the solution, which means the class needs to be either a planning entity or a problem fact.

The instances will be read from the first element of the input tuple. When an output tuple needs to be created for the newly inserted instances, the first element will be the new instance. The rest of the tuple will be padded with the result of the padding function, applied on the new instance.

Parameters:

otherClass - never null

paddingFunction - never null, function to find the padding for the second fact

Returns:

never null

ifExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifExistsIncludingUnassigned(Class, TriJoiner).

ifExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner).

ifExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner).

ifExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner, TriJoiner).

ifExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifExistsIncludingUnassigned(Class, TriJoiner...).

ifNotExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifNotExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner).

ifNotExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifNotExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner).

ifNotExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifNotExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner).

ifNotExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifNotExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C> joiner1,
 TriJoiner<A,B,C> joiner2,
 TriJoiner<A,B,C> joiner3,
 TriJoiner<A,B,C> joiner4)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner, TriJoiner, TriJoiner, TriJoiner).

ifNotExistsIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default <C> BiConstraintStream<A,B> ifNotExistsIncludingNullVars(Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ifNotExistsIncludingUnassigned(Class, TriJoiner...).

penalize

@Deprecated(forRemoval=true)
default Constraint penalize(String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score, ToIntBiFunction).

Negatively impact the Score: subtract the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalize(String, Score).

For non-int Score types use penalizeLong(String, Score, ToLongBiFunction) or penalizeBigDecimal(String, Score, BiFunction) instead.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalize

@Deprecated(forRemoval=true)
default Constraint penalize(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score, ToIntBiFunction).

As defined by penalize(String, Score, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

penalizeLong

@Deprecated(forRemoval=true)
default Constraint penalizeLong(String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeLong(Score, ToLongBiFunction).

Negatively impact the Score: subtract the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalize(String, Score).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeLong

@Deprecated(forRemoval=true)
default Constraint penalizeLong(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeLong(Score, ToLongBiFunction).

As defined by penalizeLong(String, Score, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

penalizeBigDecimal

@Deprecated(forRemoval=true)
default Constraint penalizeBigDecimal(String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeBigDecimal(Score, BiFunction).

Negatively impact the Score: subtract the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalize(String, Score).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeBigDecimal

@Deprecated(forRemoval=true)
default Constraint penalizeBigDecimal(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeBigDecimal(Score, BiFunction).

As defined by penalizeBigDecimal(String, Score, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

penalizeConfigurable

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurable(String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Negatively impact the Score: subtract the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalizeConfigurable(String).

For non-int Score types use penalizeConfigurableLong(String, ToLongBiFunction) or penalizeConfigurableBigDecimal(String, BiFunction) instead.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeConfigurable

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurable(String constraintPackage,
 String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalize(Score, ToIntBiFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurable(String, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

penalizeConfigurableLong

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurableLong(String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

Negatively impact the Score: subtract the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalizeConfigurable(String).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeConfigurableLong

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurableLong(String constraintPackage,
 String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurableLong(String, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

penalizeConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurableBigDecimal(String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

Negatively impact the Score: subtract the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.penalizeConfigurable(String).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint penalizeConfigurableBigDecimal(String constraintPackage,
 String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer penalizeBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurableBigDecimal(String, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

reward

@Deprecated(forRemoval=true)
default Constraint reward(String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer reward(Score, ToIntBiFunction).

Positively impact the Score: add the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.reward(String, Score).

For non-int Score types use rewardLong(String, Score, ToLongBiFunction) or rewardBigDecimal(String, Score, BiFunction) instead.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

reward

@Deprecated(forRemoval=true)
default Constraint reward(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer reward(Score, ToIntBiFunction).

As defined by reward(String, Score, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

rewardLong

@Deprecated(forRemoval=true)
default Constraint rewardLong(String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardLong(Score, ToLongBiFunction).

Positively impact the Score: add the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.reward(String, Score).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardLong

@Deprecated(forRemoval=true)
default Constraint rewardLong(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardLong(Score, ToLongBiFunction).

As defined by rewardLong(String, Score, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

rewardBigDecimal

@Deprecated(forRemoval=true)
default Constraint rewardBigDecimal(String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardBigDecimal(Score, BiFunction).

Positively impact the Score: add the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.reward(String, Score).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardBigDecimal

@Deprecated(forRemoval=true)
default Constraint rewardBigDecimal(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardBigDecimal(Score, BiFunction).

As defined by rewardBigDecimal(String, Score, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

rewardConfigurable

@Deprecated(forRemoval=true)
default Constraint rewardConfigurable(String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Positively impact the Score: add the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.rewardConfigurable(String).

For non-int Score types use rewardConfigurableLong(String, ToLongBiFunction) or rewardConfigurableBigDecimal(String, BiFunction) instead.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardConfigurable

@Deprecated
default Constraint rewardConfigurable(String constraintPackage,
 String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated.

Prefer reward(Score, ToIntBiFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurable(String, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

rewardConfigurableLong

@Deprecated(forRemoval=true)
default Constraint rewardConfigurableLong(String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

Positively impact the Score: add the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.rewardConfigurable(String).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardConfigurableLong

@Deprecated(forRemoval=true)
default Constraint rewardConfigurableLong(String constraintPackage,
 String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurableLong(String, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

rewardConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint rewardConfigurableBigDecimal(String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

Positively impact the Score: add the ConstraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.rewardConfigurable(String).

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint rewardConfigurableBigDecimal(String constraintPackage,
 String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer rewardBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurableBigDecimal(String, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impact

@Deprecated(forRemoval=true)
default Constraint impact(String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score, ToIntBiFunction).

Positively or negatively impact the Score by the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.impact(String, Score).

Use penalize(...) or reward(...) instead, unless this constraint can both have positive and negative weights.

For non-int Score types use impactLong(String, Score, ToLongBiFunction) or impactBigDecimal(String, Score, BiFunction) instead.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impact

@Deprecated(forRemoval=true)
default Constraint impact(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score, ToIntBiFunction).

As defined by impact(String, Score, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

impactLong

@Deprecated(forRemoval=true)
default Constraint impactLong(String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactLong(Score, ToLongBiFunction).

Positively or negatively impact the Score by the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.impact(String, Score).

Use penalizeLong(...) or rewardLong(...) instead, unless this constraint can both have positive and negative weights.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactLong

@Deprecated(forRemoval=true)
default Constraint impactLong(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactLong(Score, ToLongBiFunction).

As defined by impactLong(String, Score, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

impactBigDecimal

@Deprecated(forRemoval=true)
default Constraint impactBigDecimal(String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactBigDecimal(Score, BiFunction).

Positively or negatively impact the Score by the constraintWeight multiplied by the match weight. Otherwise as defined by ConstraintStream.impact(String, Score).

Use penalizeBigDecimal(...) or rewardBigDecimal(...) instead, unless this constraint can both have positive and negative weights.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactBigDecimal

@Deprecated(forRemoval=true)
default Constraint impactBigDecimal(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactBigDecimal(Score, BiFunction).

As defined by impactBigDecimal(String, Score, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

matchWeigher - never null

Returns:

never null

impactConfigurable

@Deprecated(forRemoval=true)
default Constraint impactConfigurable(String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.

Positively or negatively impact the Score by the ConstraintWeight multiplied by the match weight.

Use penalizeConfigurable(...) or rewardConfigurable(...) instead, unless this constraint can both have positive and negative weights.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

The constraint package defaults to ConstraintConfiguration.constraintPackage().

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactConfigurable

@Deprecated(forRemoval=true)
default Constraint impactConfigurable(String constraintPackage,
 String constraintName,
 ToIntBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impact(Score, ToIntBiFunction) and ConstraintWeightOverrides.

As defined by impactConfigurable(String, ToIntBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impactConfigurableLong

@Deprecated(forRemoval=true)
default Constraint impactConfigurableLong(String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

Positively or negatively impact the Score by the ConstraintWeight multiplied by the match weight.

Use penalizeConfigurableLong(...) or rewardConfigurableLong(...) instead, unless this constraint can both have positive and negative weights.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

The constraint package defaults to ConstraintConfiguration.constraintPackage().

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactConfigurableLong

@Deprecated(forRemoval=true)
default Constraint impactConfigurableLong(String constraintPackage,
 String constraintName,
 ToLongBiFunction<A,B> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactLong(Score, ToLongBiFunction) and ConstraintWeightOverrides.

As defined by impactConfigurableLong(String, ToLongBiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impactConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint impactConfigurableBigDecimal(String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

Positively or negatively impact the Score by the ConstraintWeight multiplied by the match weight.

Use penalizeConfigurableBigDecimal(...) or rewardConfigurableBigDecimal(...) instead, unless this constraint can both have positive and negative weights.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

The constraint package defaults to ConstraintConfiguration.constraintPackage().

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactConfigurableBigDecimal

@Deprecated(forRemoval=true)
default Constraint impactConfigurableBigDecimal(String constraintPackage,
 String constraintName,
 BiFunction<A,B,BigDecimal> matchWeigher)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer impactBigDecimal(Score, BiFunction) and ConstraintWeightOverrides.

As defined by impactConfigurableBigDecimal(String, BiFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null