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

Interface UniConstraintStream<A>

Type Parameters:

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

All Superinterfaces:

ConstraintStream

All Known Subinterfaces:

InnerUniConstraintStream<A>

All Known Implementing Classes:

BavetAbstractUniConstraintStream, BavetAftBridgeUniConstraintStream, BavetForEachUniConstraintStream, BavetForeBridgeUniConstraintStream, BavetUniConcatUniConstraintStream

public interface UniConstraintStream<A>
extends ConstraintStream

A ConstraintStream that matches one fact.

See Also:

• ConstraintStream

Method Summary

Modifier and Type	Method	Description
default @NonNull UniConstraintStream<A>	complement(@NonNull Class<A> otherClass)	Adds to the stream all instances of a given class which are not yet present in it.
default <B> @NonNull BiConstraintStream<A,B>	concat(@NonNull BiConstraintStream<A,B> otherStream)	Returns a new BiConstraintStream containing all the tuples of both this UniConstraintStream and the provided BiConstraintStream.
<B> @NonNull BiConstraintStream<A,B>	concat(@NonNull BiConstraintStream<A,B> otherStream, @NonNull Function<A,B> paddingFunctionB)	Returns a new BiConstraintStream containing all the tuples of both this UniConstraintStream and the provided BiConstraintStream.
default <B, C, D> @NonNull QuadConstraintStream<A,B,C,D>	concat(@NonNull QuadConstraintStream<A,B,C,D> otherStream)	Returns a new QuadConstraintStream containing all the tuples of both this UniConstraintStream and the provided QuadConstraintStream.
<B, C, D> @NonNull QuadConstraintStream<A,B,C,D>	concat(@NonNull QuadConstraintStream<A,B,C,D> otherStream, @NonNull Function<A,B> paddingFunctionB, @NonNull Function<A,C> paddingFunctionC, @NonNull Function<A,D> paddingFunctionD)	Returns a new QuadConstraintStream containing all the tuples of both this UniConstraintStream and the provided QuadConstraintStream.
default <B, C> @NonNull TriConstraintStream<A,B,C>	concat(@NonNull TriConstraintStream<A,B,C> otherStream)	Returns a new TriConstraintStream containing all the tuples of both this UniConstraintStream and the provided TriConstraintStream.
<B, C> @NonNull TriConstraintStream<A,B,C>	concat(@NonNull TriConstraintStream<A,B,C> otherStream, @NonNull Function<A,B> paddingFunctionB, @NonNull Function<A,C> paddingFunctionC)	Returns a new TriConstraintStream containing all the tuples of both this UniConstraintStream and the provided TriConstraintStream.
@NonNull UniConstraintStream<A>	concat(@NonNull UniConstraintStream<A> otherStream)	Returns a new UniConstraintStream containing all the tuples of both this UniConstraintStream and the provided UniConstraintStream.
@NonNull UniConstraintStream<A>	distinct()	Transforms the stream in such a way that all the tuples going through it are distinct.
<ResultB_> @NonNull BiConstraintStream<A,ResultB_>	expand(@NonNull Function<A,ResultB_> mapping)	Adds a fact to the end of the tuple, increasing the cardinality of the stream.
<ResultB_, ResultC_> @NonNull TriConstraintStream<A,ResultB_,ResultC_>	expand(@NonNull Function<A,ResultB_> mappingB, @NonNull Function<A,ResultC_> mappingC)	Adds two facts to the end of the tuple, increasing the cardinality of the stream.
<ResultB_, ResultC_, ResultD_> @NonNull QuadConstraintStream<A,ResultB_,ResultC_,ResultD_>	expand(@NonNull Function<A,ResultB_> mappingB, @NonNull Function<A,ResultC_> mappingC, @NonNull Function<A,ResultD_> mappingD)	Adds three facts to the end of the tuple, increasing the cardinality of the stream.
@NonNull UniConstraintStream<A>	filter(@NonNull Predicate<A> predicate)	Exhaustively test each fact against the Predicate and match if Predicate.test(Object) returns true.
<ResultA_> @NonNull UniConstraintStream<ResultA_>	flattenLast(@NonNull Function<A,Iterable<ResultA_>> mapping)	Takes each tuple and applies a mapping on it, which turns the tuple into a Iterable.
<ResultContainer_, Result_> @NonNull UniConstraintStream<Result_>	groupBy(@NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)	Convert the UniConstraintStream to a different UniConstraintStream, containing only a single tuple, the result of applying UniConstraintCollector.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_> @NonNull BiConstraintStream<ResultA_,ResultB_>	groupBy(@NonNull UniConstraintCollector<A,ResultContainerA_,ResultA_> collectorA, @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB)	Convert the UniConstraintStream to a BiConstraintStream, containing only a single tuple, the result of applying two UniConstraintCollectors.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_> @NonNull TriConstraintStream<ResultA_,ResultB_,ResultC_>	groupBy(@NonNull UniConstraintCollector<A,ResultContainerA_,ResultA_> collectorA, @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB, @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC)	Convert the UniConstraintStream to a TriConstraintStream, containing only a single tuple, the result of applying three UniConstraintCollectors.
<ResultContainerA_, ResultA_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> @NonNull QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_>	groupBy(@NonNull UniConstraintCollector<A,ResultContainerA_,ResultA_> collectorA, @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB, @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC, @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)	Convert the UniConstraintStream to a QuadConstraintStream, containing only a single tuple, the result of applying four UniConstraintCollectors.
<GroupKey_> @NonNull UniConstraintStream<GroupKey_>	groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping)	Convert the UniConstraintStream to a different UniConstraintStream, containing the set of tuples resulting from applying the group key mapping function on all tuples of the original stream.
<GroupKey_, ResultContainer_, Result_> @NonNull BiConstraintStream<GroupKey_,Result_>	groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping, @NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)	Convert the UniConstraintStream to a BiConstraintStream, consisting of unique tuples with two facts.
<GroupKey_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_> @NonNull TriConstraintStream<GroupKey_,ResultB_,ResultC_>	groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping, @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB, @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC)	Convert the UniConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.
<GroupKey_, ResultContainerB_, ResultB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> @NonNull QuadConstraintStream<GroupKey_,ResultB_,ResultC_,ResultD_>	groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping, @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB, @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC, @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)	Convert the UniConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.
<GroupKeyA_, GroupKeyB_> @NonNull BiConstraintStream<GroupKeyA_,GroupKeyB_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping)	Convert the UniConstraintStream to a BiConstraintStream, consisting of unique tuples with two facts.
<GroupKeyA_, GroupKeyB_, ResultContainer_, Result_> @NonNull TriConstraintStream<GroupKeyA_,GroupKeyB_,Result_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping, @NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)	Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector).
<GroupKeyA_, GroupKeyB_, ResultContainerC_, ResultC_, ResultContainerD_, ResultD_> @NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,ResultC_,ResultD_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping, @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC, @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)	Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector).
<GroupKeyA_, GroupKeyB_, GroupKeyC_> @NonNull TriConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping, @NonNull Function<A,GroupKeyC_> groupKeyCMapping)	Convert the UniConstraintStream to a TriConstraintStream, consisting of unique tuples with three facts.
<GroupKeyA_, GroupKeyB_, GroupKeyC_, ResultContainerD_, ResultD_> @NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,ResultD_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping, @NonNull Function<A,GroupKeyC_> groupKeyCMapping, @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)	Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector).
<GroupKeyA_, GroupKeyB_, GroupKeyC_, GroupKeyD_> @NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,GroupKeyD_>	groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping, @NonNull Function<A,GroupKeyB_> groupKeyBMapping, @NonNull Function<A,GroupKeyC_> groupKeyCMapping, @NonNull Function<A,GroupKeyD_> groupKeyDMapping)	Convert the UniConstraintStream to a QuadConstraintStream, consisting of unique tuples with four facts.
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B>... joiners)	As defined by ifExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by ifExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifExists(Class, BiJoiner).
default <B> UniConstraintStream<A>	ifExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, BiJoiner).
default <B> UniConstraintStream<A>	ifExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, BiJoiner...).
default <B> UniConstraintStream<A>	ifExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner).
default <B> UniConstraintStream<A>	ifExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2, BiJoiner<A,B> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).
default <B> UniConstraintStream<A>	ifExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2, BiJoiner<A,B> joiner3, BiJoiner<A,B> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by ifExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifExistsIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass)	Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first.
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner)	Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A>... joiners)	As defined by ifExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)	As defined by ifExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)	As defined by ifExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)	As defined by ifExistsOther(Class, BiJoiner).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner...).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).
default UniConstraintStream<A>	ifExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3, BiJoiner<A,A> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass)	Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first.
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner)	Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A>... joiners)	As defined by ifExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)	As defined by ifExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)	As defined by ifExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)	As defined by ifExistsOtherIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B>... joiners)	As defined by ifNotExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifNotExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifNotExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifNotExists(UniConstraintStream, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by ifNotExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifNotExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifNotExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifNotExists(Class, BiJoiner).
default <B> UniConstraintStream<A>	ifNotExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner)
default <B> UniConstraintStream<A>	ifNotExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner...)
default <B> UniConstraintStream<A>	ifNotExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner)
default <B> UniConstraintStream<A>	ifNotExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2, BiJoiner<A,B> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner)
default <B> UniConstraintStream<A>	ifNotExistsIncludingNullVars(Class<B> otherClass, BiJoiner<A,B> joiner1, BiJoiner<A,B> joiner2, BiJoiner<A,B> joiner3, BiJoiner<A,B> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner)
default <B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner)	Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by ifNotExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by ifNotExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by ifNotExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by ifNotExistsIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass)	Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first.
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner)	Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A>... joiners)	As defined by ifNotExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)	As defined by ifNotExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)	As defined by ifNotExistsOther(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOther(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)	As defined by ifNotExistsOther(Class, BiJoiner).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner...).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).
default UniConstraintStream<A>	ifNotExistsOtherIncludingNullVars(Class<A> otherClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3, BiJoiner<A,A> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass)	Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first.
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner)	Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A>... joiners)	As defined by ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)	As defined by ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)	As defined by ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).
default @NonNull UniConstraintStream<A>	ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)	As defined by ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	impact(@NonNull 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_>> @NonNull UniConstraintBuilder<A,Score_>	impact(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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	impact(String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntFunction).
default Constraint	impact(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntFunction).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	impactBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by impact(Score, ToIntFunction), with an impact of type BigDecimal.
default Constraint	impactBigDecimal(String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, Function).
default Constraint	impactBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, Function).
default UniConstraintBuilder<A,?>	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, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurable(String constraintName, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntFunction) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	impactConfigurable(ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impact(Score, ToIntFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableBigDecimal(String constraintPackage, String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	impactConfigurableBigDecimal(String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, Function) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	impactConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	impactConfigurableLong(String constraintPackage, String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongFunction) and ConstraintWeightOverrides.
default Constraint	impactConfigurableLong(String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongFunction) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	impactConfigurableLong(ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongFunction) and ConstraintWeightOverrides.
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	impactLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by impact(Score, ToIntFunction), with an impact of type long.
default Constraint	impactLong(String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongFunction).
default Constraint	impactLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer impactLong(Score, ToLongFunction).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream)	Create a new BiConstraintStream for every combination of A and B.
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner)	Create a new BiConstraintStream for every combination of A and B for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B>... joiners)	As defined by join(UniConstraintStream, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by join(UniConstraintStream, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by join(UniConstraintStream, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull UniConstraintStream<B> otherStream, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by join(UniConstraintStream, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass)	Create a new BiConstraintStream for every combination of A and B.
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner)	Create a new BiConstraintStream for every combination of A and B for which the BiJoiner is true (for the properties it extracts from both facts).
<B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by join(Class, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2)	As defined by join(Class, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3)	As defined by join(Class, BiJoiner).
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B> joiner1, @NonNull BiJoiner<A,B> joiner2, @NonNull BiJoiner<A,B> joiner3, @NonNull BiJoiner<A,B> joiner4)	As defined by join(Class, BiJoiner).
<ResultA_> @NonNull UniConstraintStream<ResultA_>	map(@NonNull Function<A,ResultA_> mapping)	Transforms the stream in such a way that tuples are remapped using the given function.
<ResultA_, ResultB_> @NonNull BiConstraintStream<ResultA_,ResultB_>	map(@NonNull Function<A,ResultA_> mappingA, @NonNull Function<A,ResultB_> mappingB)	As defined by map(Function), only resulting in BiConstraintStream.
<ResultA_, ResultB_, ResultC_> @NonNull TriConstraintStream<ResultA_,ResultB_,ResultC_>	map(@NonNull Function<A,ResultA_> mappingA, @NonNull Function<A,ResultB_> mappingB, @NonNull Function<A,ResultC_> mappingC)	As defined by map(Function), only resulting in TriConstraintStream.
<ResultA_, ResultB_, ResultC_, ResultD_> @NonNull QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_>	map(@NonNull Function<A,ResultA_> mappingA, @NonNull Function<A,ResultB_> mappingB, @NonNull Function<A,ResultC_> mappingC, @NonNull Function<A,ResultD_> mappingD)	As defined by map(Function), only resulting in QuadConstraintStream.
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalize(@NonNull Score_ constraintWeight)	As defined by penalize(Score, ToIntFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalize(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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	penalize(String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntFunction).
default Constraint	penalize(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntFunction).
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalizeBigDecimal(@NonNull Score_ constraintWeight)	As defined by penalizeBigDecimal(Score, Function), where the match weight is one (1).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalizeBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by penalize(Score, ToIntFunction), with a penalty of type BigDecimal.
default Constraint	penalizeBigDecimal(String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, Function).
default Constraint	penalizeBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, Function).
default UniConstraintBuilder<A,?>	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, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurable(String constraintName, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	penalizeConfigurable(ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalize(Score, ToIntFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableBigDecimal(String constraintPackage, String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableBigDecimal(String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, Function) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	penalizeConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableLong(String constraintPackage, String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongFunction) and ConstraintWeightOverrides.
default Constraint	penalizeConfigurableLong(String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongFunction) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	penalizeConfigurableLong(ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongFunction) and ConstraintWeightOverrides.
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalizeLong(@NonNull Score_ constraintWeight)	As defined by penalizeLong(Score, ToLongFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalizeLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by penalize(Score, ToIntFunction), with a penalty of type long.
default Constraint	penalizeLong(String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongFunction).
default Constraint	penalizeLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer penalizeLong(Score, ToLongFunction).
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	reward(@NonNull Score_ constraintWeight)	As defined by reward(Score, ToIntFunction), where the match weight is one (1).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	reward(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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	reward(String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntFunction).
default Constraint	reward(String constraintPackage, String constraintName, Score<?> constraintWeight, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntFunction).
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	rewardBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by reward(Score, ToIntFunction), with a penalty of type BigDecimal.
default Constraint	rewardBigDecimal(String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, Function).
default Constraint	rewardBigDecimal(String constraintPackage, String constraintName, Score<?> constraintWeight, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, Function).
default UniConstraintBuilder<A,?>	rewardConfigurable()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score) and ConstraintWeightOverrides.
default Constraint	rewardConfigurable(String constraintPackage, String constraintName, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurable(String constraintName, ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntFunction) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	rewardConfigurable(ToIntFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer reward(Score, ToIntFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableBigDecimal(String constraintPackage, String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableBigDecimal(String constraintName, Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, Function) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	rewardConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardBigDecimal(Score, Function) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableLong(String constraintPackage, String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongFunction) and ConstraintWeightOverrides.
default Constraint	rewardConfigurableLong(String constraintName, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongFunction) and ConstraintWeightOverrides.
UniConstraintBuilder<A,?>	rewardConfigurableLong(ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongFunction) and ConstraintWeightOverrides.
<Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	rewardLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by reward(Score, ToIntFunction), with a penalty of type long.
default Constraint	rewardLong(String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongFunction).
default Constraint	rewardLong(String constraintPackage, String constraintName, Score<?> constraintWeight, ToLongFunction<A> matchWeigher)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer rewardLong(Score, ToLongFunction).

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

@NonNull UniConstraintStream<A> filter(@NonNull Predicate<A> predicate)

Exhaustively test each fact against the Predicate and match if Predicate.test(Object) returns true.

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream)

Create a new BiConstraintStream for every combination of A and B.

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner)

Create a new BiConstraintStream for every combination of A and B for which the BiJoiner 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 and B.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which the BiJoiner is true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

<B> @NonNull BiConstraintStream<A,B> join(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B>... joiners)

As defined by join(UniConstraintStream, BiJoiner). If multiple BiJoiners are provided, for performance reasons, the 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:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass)

Create a new BiConstraintStream for every combination of A and B.

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

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 and B.

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

This method is syntactic sugar for join(UniConstraintStream).

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner)

Create a new BiConstraintStream for every combination of A and B for which the BiJoiner 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 and B.

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

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

This method has overloaded methods with multiple BiJoiner parameters.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which the BiJoiner is true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

default <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

join

<B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

As defined by join(Class, BiJoiner). For performance reasons, the 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:

B - the type of the second matched fact

Returns:

a stream that matches every combination of A and B for which all the joiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which the BiJoiner is true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

<B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifExists(Class, BiJoiner). 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner parameters.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which the BiJoiner is true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExists

<B> @NonNull UniConstraintStream<A> ifExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifExists(UniConstraintStream, BiJoiner). 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B exists for which the BiJoiner is true (for the properties it extracts from both 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 BiJoiner parameters.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which the BiJoiner is true

ifExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsIncludingUnassigned

<B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifExistsIncludingUnassigned(Class, BiJoiner). 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass)

Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first.

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.)

Returns:

a stream that matches every A where a different A exists

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner)

Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner 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.)

Returns:

a stream that matches every A where a different A exists for which the BiJoiner is true

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3,
 @NonNull BiJoiner<A,A> joiner4)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOther

default @NonNull UniConstraintStream<A> ifExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A>... joiners)

As defined by ifExistsOther(Class, BiJoiner). For performance reasons, the 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.

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass)

Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first. For classes annotated with PlanningEntity, this method also includes entities with null variables, or entities that are not assigned to any list variable.

Returns:

a stream that matches every A where a different A exists

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner)

Create a new UniConstraintStream for every A, if another A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both 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 BiJoiner parameters.

Returns:

a stream that matches every A where a different A exists for which the BiJoiner is true

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3,
 @NonNull BiJoiner<A,A> joiner4)

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

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A>... joiners)

As defined by ifExistsOtherIncludingUnassigned(Class, BiJoiner). If multiple BiJoiners are provided, for performance reasons, the 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.

Returns:

a stream that matches every A where a different A exists for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which the BiJoiner is true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

<B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifNotExists(Class, BiJoiner). 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner parameters.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which the BiJoiner is true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

never null, a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExists

<B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull UniConstraintStream<B> otherStream,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifNotExists(UniConstraintStream, BiJoiner). 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:

B - the type of the second matched fact

Parameters:

otherStream - never null

joiners - never null

Returns:

never null, a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner)

Create a new UniConstraintStream for every A where B does not exist for which the BiJoiner is true (for the properties it extracts from both 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 BiJoiner parameters.

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which the BiJoiner is true

ifNotExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B> joiner1,
 @NonNull BiJoiner<A,B> joiner2,
 @NonNull BiJoiner<A,B> joiner3,
 @NonNull BiJoiner<A,B> joiner4)

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

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsIncludingUnassigned

<B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

As defined by ifNotExistsIncludingUnassigned(Class, BiJoiner). 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:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass)

Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first.

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.)

Returns:

a stream that matches every A where a different A does not exist

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner)

Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both facts).

This method has overloaded methods with multiple BiJoiner 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.)

Returns:

a stream that matches every A where a different A does not exist for which the BiJoiner is true

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3,
 @NonNull BiJoiner<A,A> joiner4)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOther

default @NonNull UniConstraintStream<A> ifNotExistsOther(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A>... joiners)

As defined by ifNotExistsOther(Class, BiJoiner). For performance reasons, the 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.

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass)

Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first. For classes annotated with PlanningEntity, this method also includes entities with null variables, or entities that are not assigned to any list variable.

Returns:

a stream that matches every A where a different A does not exist

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner)

Create a new UniConstraintStream for every A, if no other A exists that does not Object.equals(Object) the first, and for which the BiJoiner is true (for the properties it extracts from both 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 BiJoiner parameters.

Returns:

a stream that matches every A where a different A does not exist for which the BiJoiner is true

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A> joiner1,
 @NonNull BiJoiner<A,A> joiner2,
 @NonNull BiJoiner<A,A> joiner3,
 @NonNull BiJoiner<A,A> joiner4)

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

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOtherIncludingUnassigned

default @NonNull UniConstraintStream<A> ifNotExistsOtherIncludingUnassigned(@NonNull Class<A> otherClass,
 @NonNull BiJoiner<A,A>... joiners)

As defined by ifNotExistsOtherIncludingUnassigned(Class, BiJoiner). If multiple BiJoiners are provided, for performance reasons, the 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.

Returns:

a stream that matches every A where a different A does not exist for which all the BiJoiners are true

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class).

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner).

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner).

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2,
 BiJoiner<A,A> joiner3)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2,
 BiJoiner<A,A> joiner3,
 BiJoiner<A,A> joiner4)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).

ifNotExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifNotExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A>... joiners)

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

Prefer ifNotExistsOtherIncludingUnassigned(Class, BiJoiner...).

groupBy

<ResultContainer_,
Result_>
@NonNull UniConstraintStream<Result_> groupBy(@NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)

Convert the UniConstraintStream to a different UniConstraintStream, containing only a single tuple, the result of applying UniConstraintCollector.

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 - the collector to perform the grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

groupBy

<ResultContainerA_,
ResultA_,
ResultContainerB_,
ResultB_>
@NonNull BiConstraintStream<ResultA_,ResultB_> groupBy(@NonNull UniConstraintCollector<A,ResultContainerA_,ResultA_> collectorA,
 @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB)

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

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 - the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

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

groupBy

<ResultContainerA_,
ResultA_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_>
@NonNull TriConstraintStream<ResultA_,ResultB_,ResultC_> groupBy(@NonNull UniConstraintCollector<A,ResultContainerA_,ResultA_> collectorA,
 @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB,
 @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC)

Convert the UniConstraintStream to a TriConstraintStream, containing only a single tuple, the result of applying three UniConstraintCollectors.

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 - the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

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

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

groupBy

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

Convert the UniConstraintStream to a QuadConstraintStream, containing only a single tuple, the result of applying four UniConstraintCollectors.

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 - the collector to perform the first grouping operation with See ConstraintCollectors for common operations, such as count(), sum() and others.

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

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

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

groupBy

<GroupKey_> @NonNull UniConstraintStream<GroupKey_> groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping)

Convert the UniConstraintStream to a different 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; must honor the general contract of hashCode.

Parameters:

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

groupBy

<GroupKey_,
ResultContainer_,
Result_>
@NonNull BiConstraintStream<GroupKey_,Result_> groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping,
 @NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)

Convert the UniConstraintStream to a BiConstraintStream, consisting of unique tuples with two facts.

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 UniConstraintCollector 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 - function to convert the fact in the original tuple to a different fact

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

groupBy

<GroupKey_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_>
@NonNull TriConstraintStream<GroupKey_,ResultB_,ResultC_> groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping,
 @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB,
 @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC)

Convert the UniConstraintStream 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 UniConstraintCollector 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 - function to convert the fact in the original tuple to a different fact

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

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

groupBy

<GroupKey_,
ResultContainerB_,
ResultB_,
ResultContainerC_,
ResultC_,
ResultContainerD_,
ResultD_>
@NonNull QuadConstraintStream<GroupKey_,ResultB_,ResultC_,ResultD_> groupBy(@NonNull Function<A,GroupKey_> groupKeyMapping,
 @NonNull UniConstraintCollector<A,ResultContainerB_,ResultB_> collectorB,
 @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC,
 @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)

Convert the UniConstraintStream 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 UniConstraintCollector 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 - function to convert the fact in the original tuple to a different fact

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

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

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

groupBy

<GroupKeyA_,
GroupKeyB_>
@NonNull BiConstraintStream<GroupKeyA_,GroupKeyB_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping)

Convert the UniConstraintStream to a BiConstraintStream, consisting of unique tuples with two 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.

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 - function to convert the original tuple into a first fact

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

groupBy

<GroupKeyA_,
GroupKeyB_,
ResultContainer_,
Result_>
@NonNull TriConstraintStream<GroupKeyA_,GroupKeyB_,Result_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping,
 @NonNull UniConstraintCollector<A,ResultContainer_,Result_> collector)

Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector). That is, the first and second facts in the tuple follow the groupBy(Function, Function) semantics, and the third fact is the result of applying UniConstraintCollector.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 - function to convert the original tuple into a first fact

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

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

groupBy

<GroupKeyA_,
GroupKeyB_,
ResultContainerC_,
ResultC_,
ResultContainerD_,
ResultD_>
@NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,ResultC_,ResultD_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping,
 @NonNull UniConstraintCollector<A,ResultContainerC_,ResultC_> collectorC,
 @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)

Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector). That is, the first and second facts in the tuple follow the groupBy(Function, Function) semantics. The third fact is the result of applying the first UniConstraintCollector.finisher() on all the tuples of the original UniConstraintStream that belong to the group. The fourth fact is the result of applying the second UniConstraintCollector.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 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 - function to convert the original tuple into a first fact

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

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

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

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_>
@NonNull TriConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping,
 @NonNull Function<A,GroupKeyC_> groupKeyCMapping)

Convert the UniConstraintStream 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 - function to convert the original tuple into a first fact

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

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

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_,
ResultContainerD_,
ResultD_>
@NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,ResultD_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping,
 @NonNull Function<A,GroupKeyC_> groupKeyCMapping,
 @NonNull UniConstraintCollector<A,ResultContainerD_,ResultD_> collectorD)

Combines the semantics of groupBy(Function, Function) and groupBy(UniConstraintCollector). That is, the first three facts in the tuple follow the groupBy(Function, Function) semantics. The final fact is the result of applying the first UniConstraintCollector.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 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 - function to convert the original tuple into a first fact

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

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

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

groupBy

<GroupKeyA_,
GroupKeyB_,
GroupKeyC_,
GroupKeyD_>
@NonNull QuadConstraintStream<GroupKeyA_,GroupKeyB_,GroupKeyC_,GroupKeyD_> groupBy(@NonNull Function<A,GroupKeyA_> groupKeyAMapping,
 @NonNull Function<A,GroupKeyB_> groupKeyBMapping,
 @NonNull Function<A,GroupKeyC_> groupKeyCMapping,
 @NonNull Function<A,GroupKeyD_> groupKeyDMapping)

Convert the UniConstraintStream 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 - * calling map(Person::getAge) on such stream will produce a stream of Integers * [20, 25, 30],

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

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

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

map

<ResultA_> @NonNull UniConstraintStream<ResultA_> map(@NonNull Function<A,ResultA_> mapping)

Transforms the stream in such a way that tuples are remapped using the given function. This may produce a stream with duplicate tuples. See distinct() for details.

There are several recommendations for implementing the mapping function:

• Purity. The mapping function should only depend on its input. That is, given the same input, it always returns the same output.
• Bijectivity. No two input tuples should map to the same output tuple, or to tuples that are equal. Not following this recommendation creates a constraint stream with duplicate tuples, and may force you to use distinct() later, which comes at a performance cost.
• Immutable data carriers. The objects returned by the mapping function should be identified by their contents and nothing else. If two of them have contents which equal, then they should likewise equal and preferably be the same instance. The objects returned by the mapping function should also be immutable, meaning their contents should not be allowed to change.

Simple example: assuming a constraint stream of tuples of Persons [Ann(age = 20), Beth(age = 25), Cathy(age = 30)], calling map(Person::getAge) on such stream will produce a stream of Integers [20, 25, 30],

Example with a non-bijective mapping function: assuming a constraint stream of tuples of Persons [Ann(age = 20), Beth(age = 25), Cathy(age = 30), David(age = 30), Eric(age = 20)], calling map(Person::getAge) on such stream will produce a stream of Integers [20, 25, 30, 30, 20].

Use with caution, as the increased memory allocation rates coming from tuple creation may negatively affect performance.

Type Parameters:

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

Parameters:

mapping - function to convert the original tuple into the new tuple

map

<ResultA_,
ResultB_>
@NonNull BiConstraintStream<ResultA_,ResultB_> map(@NonNull Function<A,ResultA_> mappingA,
 @NonNull Function<A,ResultB_> mappingB)

As defined by map(Function), 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 - function to convert the original tuple into the first fact of a new tuple

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

map

<ResultA_,
ResultB_,
ResultC_>
@NonNull TriConstraintStream<ResultA_,ResultB_,ResultC_> map(@NonNull Function<A,ResultA_> mappingA,
 @NonNull Function<A,ResultB_> mappingB,
 @NonNull Function<A,ResultC_> mappingC)

As defined by map(Function), 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 - function to convert the original tuple into the first fact of a new tuple

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

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

map

<ResultA_,
ResultB_,
ResultC_,
ResultD_>
@NonNull QuadConstraintStream<ResultA_,ResultB_,ResultC_,ResultD_> map(@NonNull Function<A,ResultA_> mappingA,
 @NonNull Function<A,ResultB_> mappingB,
 @NonNull Function<A,ResultC_> mappingC,
 @NonNull Function<A,ResultD_> mappingD)

As defined by map(Function), 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 - function to convert the original tuple into the first fact of a new tuple

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

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

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

flattenLast

<ResultA_> @NonNull UniConstraintStream<ResultA_> flattenLast(@NonNull Function<A,Iterable<ResultA_>> mapping)

Takes each tuple and applies a mapping on it, which turns the tuple into a Iterable. Returns a constraint stream consisting of contents of those iterables. This may produce a stream with duplicate tuples. See distinct() for details.

In cases where the original tuple is already an Iterable, use Function.identity() as the argument.

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

Type Parameters:

ResultA_ - the type of facts 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 - function to convert the original tuple into Iterable. For performance, returning an implementation of Collection is preferred.

distinct

@NonNull UniConstraintStream<A> distinct()

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

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

concat

@NonNull UniConstraintStream<A> concat(@NonNull UniConstraintStream<A> otherStream)

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

For instance, if this stream consists of [A, B, C] and the other stream consists of [C, D, E], this.concat(other) will consist of [A, B, C, C, D, E]. This operation can be thought of as an or between streams.

concat

default <B> @NonNull BiConstraintStream<A,B> concat(@NonNull BiConstraintStream<A,B> otherStream)

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

For instance, if this stream consists of [A, B, C] and the other stream consists of [(C1, C2), (D1, D2), (E1, E2)], this.concat(other) will consist of [(A, null), (B, null), (C, null), (C1, C2), (D1, D2), (E1, E2)].

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

concat

<B> @NonNull BiConstraintStream<A,B> concat(@NonNull BiConstraintStream<A,B> otherStream,
 @NonNull Function<A,B> paddingFunctionB)

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

For instance, if this stream consists of [A, B, C] and the other stream consists of [(C1, C2), (D1, D2), (E1, E2)], this.concat(other, a -> null) will consist of [(A, null), (B, null), (C, null), (C1, C2), (D1, D2), (E1, E2)].

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

Parameters:

paddingFunctionB - function to find the padding for the second fact

concat

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

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

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

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

concat

<B,
C> @NonNull TriConstraintStream<A,B,C> concat(@NonNull TriConstraintStream<A,B,C> otherStream,
 @NonNull Function<A,B> paddingFunctionB,
 @NonNull Function<A,C> paddingFunctionC)

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

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

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

Parameters:

paddingFunctionB - function to find the padding for the second fact

paddingFunctionC - function to find the padding for the third fact

concat

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

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

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

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

concat

<B,
C,
D> @NonNull QuadConstraintStream<A,B,C,D> concat(@NonNull QuadConstraintStream<A,B,C,D> otherStream,
 @NonNull Function<A,B> paddingFunctionB,
 @NonNull Function<A,C> paddingFunctionC,
 @NonNull Function<A,D> paddingFunctionD)

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

For instance, if this stream consists of [A, B, C] and the other stream consists of [(C1, C2, C3, C4), (D1, D2, D3, D4), (E1, E2, E3, E4)], this.concat(other, a -> null, a -> null, a -> null) will consist of [(A, null), (B, null), (C, 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:

paddingFunctionB - function to find the padding for the second fact

paddingFunctionC - function to find the padding for the third fact

paddingFunctionD - function to find the padding for the fourth fact

expand

<ResultB_> @NonNull BiConstraintStream<A,ResultB_> expand(@NonNull Function<A,ResultB_> 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 one fact is to be added, prefer expand(Function, Function) or expand(Function, Function, Function).

Type Parameters:

ResultB_ - type of the final fact of the new tuple

Parameters:

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

expand

<ResultB_,
ResultC_>
@NonNull TriConstraintStream<A,ResultB_,ResultC_> expand(@NonNull Function<A,ResultB_> mappingB,
 @NonNull Function<A,ResultC_> mappingC)

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. If more than two facts are to be added, prefer expand(Function, Function, Function).

Type Parameters:

ResultB_ - type of the second fact of the new tuple

ResultC_ - type of the third fact of the new tuple

Parameters:

mappingB - function to produce the new second fact from the original tuple

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

expand

<ResultB_,
ResultC_,
ResultD_>
@NonNull QuadConstraintStream<A,ResultB_,ResultC_,ResultD_> expand(@NonNull Function<A,ResultB_> mappingB,
 @NonNull Function<A,ResultC_> mappingC,
 @NonNull Function<A,ResultD_> mappingD)

Adds three 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:

ResultB_ - type of the second fact of the new tuple

ResultC_ - type of the third fact of the new tuple

ResultD_ - type of the final fact of the new tuple

Parameters:

mappingB - function to produce the new second fact from the original tuple

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

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

complement

default @NonNull UniConstraintStream<A> complement(@NonNull Class<A> otherClass)

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.

penalize

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalize(@NonNull Score_ constraintWeight)

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

penalizeLong

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeLong(@NonNull Score_ constraintWeight)

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

penalizeBigDecimal

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeBigDecimal(@NonNull Score_ constraintWeight)

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

penalize

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalize(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> 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, ToLongFunction) or penalizeBigDecimal(Score, Function) instead.

Parameters:

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

penalizeLong

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

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

penalizeBigDecimal

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

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

penalizeConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
default UniConstraintBuilder<A,?> 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")
UniConstraintBuilder<A,?> penalizeConfigurable(ToIntFunction<A> matchWeigher)

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

Prefer penalize(Score, ToIntFunction) 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")
UniConstraintBuilder<A,?> penalizeConfigurableLong(ToLongFunction<A> matchWeigher)

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

Prefer penalizeLong(Score, ToLongFunction) and ConstraintWeightOverrides.

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

penalizeConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
UniConstraintBuilder<A,?> penalizeConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

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

Prefer penalizeBigDecimal(Score, Function) and ConstraintWeightOverrides.

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

reward

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> reward(@NonNull Score_ constraintWeight)

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

reward

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> reward(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> 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, ToLongFunction) or rewardBigDecimal(Score, Function) instead.

Parameters:

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

rewardLong

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> rewardLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

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

rewardBigDecimal

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> rewardBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

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

rewardConfigurable

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

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

Prefer reward(Score) 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")
UniConstraintBuilder<A,?> rewardConfigurable(ToIntFunction<A> matchWeigher)

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

Prefer reward(Score, ToIntFunction) 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")
UniConstraintBuilder<A,?> rewardConfigurableLong(ToLongFunction<A> matchWeigher)

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

Prefer rewardLong(Score, ToLongFunction) and ConstraintWeightOverrides.

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

rewardConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
UniConstraintBuilder<A,?> rewardConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

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

Prefer rewardBigDecimal(Score, Function) and ConstraintWeightOverrides.

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

impact

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impact(@NonNull 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.

impact

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impact(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> 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:

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

impactLong

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impactLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

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

impactBigDecimal

<Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impactBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

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

impactConfigurable

@Deprecated(forRemoval=true,
            since="1.13.0")
default UniConstraintBuilder<A,?> 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")
UniConstraintBuilder<A,?> impactConfigurable(ToIntFunction<A> matchWeigher)

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

Prefer impact(Score, ToIntFunction) 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")
UniConstraintBuilder<A,?> impactConfigurableLong(ToLongFunction<A> matchWeigher)

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

Prefer impactLong(Score, ToLongFunction) and ConstraintWeightOverrides.

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

impactConfigurableBigDecimal

@Deprecated(forRemoval=true,
            since="1.13.0")
UniConstraintBuilder<A,?> impactConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

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

Prefer impactBigDecimal(Score, Function) and ConstraintWeightOverrides.

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

ifExistsIncludingNullVars

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

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

Prefer ifExistsIncludingUnassigned(Class, BiJoiner).

ifExistsIncludingNullVars

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

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

Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner).

ifExistsIncludingNullVars

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

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

Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).

ifExistsIncludingNullVars

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

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

Prefer ifExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).

ifExistsIncludingNullVars

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

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

Prefer ifExistsIncludingUnassigned(Class, BiJoiner...).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass)

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

Prefer ifExistsOtherIncludingUnassigned(Class).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner)

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

Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2)

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

Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2,
 BiJoiner<A,A> joiner3)

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

Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A> joiner1,
 BiJoiner<A,A> joiner2,
 BiJoiner<A,A> joiner3,
 BiJoiner<A,A> joiner4)

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

Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner).

ifExistsOtherIncludingNullVars

@Deprecated(forRemoval=true,
            since="1.8.0")
default UniConstraintStream<A> ifExistsOtherIncludingNullVars(Class<A> otherClass,
 BiJoiner<A,A>... joiners)

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

Prefer ifExistsOtherIncludingUnassigned(Class, BiJoiner...).

ifNotExistsIncludingNullVars

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

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

Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner)

ifNotExistsIncludingNullVars

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

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

Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner)

ifNotExistsIncludingNullVars

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

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

Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner)

ifNotExistsIncludingNullVars

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

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

Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner)

ifNotExistsIncludingNullVars

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

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

Prefer ifNotExistsIncludingUnassigned(Class, BiJoiner...)

penalize

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

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

Prefer penalize(Score, ToIntFunction).

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, ToLongFunction) or penalizeBigDecimal(String, Score, Function) 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,
 ToIntFunction<A> matchWeigher)

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

Prefer penalize(Score, ToIntFunction).

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

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,
 ToLongFunction<A> matchWeigher)

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

Prefer penalizeLong(Score, ToLongFunction).

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,
 ToLongFunction<A> matchWeigher)

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

Prefer penalizeLong(Score, ToLongFunction).

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

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer penalizeBigDecimal(Score, Function).

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer penalizeBigDecimal(Score, Function).

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

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,
 ToIntFunction<A> matchWeigher)

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

Prefer penalize(Score) 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, ToLongFunction) or penalizeConfigurableBigDecimal(String, Function) 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,
 ToIntFunction<A> matchWeigher)

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

Prefer penalize(Score) and ConstraintWeightOverrides.

As defined by penalizeConfigurable(String, ToIntFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

penalizeConfigurableLong

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

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

Prefer penalizeLong(Score, ToLongFunction) 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,
 ToLongFunction<A> matchWeigher)

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

Prefer penalizeLong(Score, ToLongFunction) and ConstraintWeightOverrides.

As defined by penalizeConfigurableLong(String, ToLongFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

penalizeConfigurableBigDecimal

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

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

Prefer penalizeBigDecimal(Score, Function) 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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer penalizeBigDecimal(Score, Function) and ConstraintWeightOverrides.

As defined by penalizeConfigurableBigDecimal(String, Function).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

reward

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

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

Prefer reward(Score, ToIntFunction).

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, ToLongFunction) or rewardBigDecimal(String, Score, Function) 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,
 ToIntFunction<A> matchWeigher)

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

Prefer reward(Score, ToIntFunction).

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

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,
 ToLongFunction<A> matchWeigher)

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

Prefer rewardLong(Score, ToLongFunction).

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,
 ToLongFunction<A> matchWeigher)

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

Prefer rewardLong(Score, ToLongFunction).

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

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer rewardBigDecimal(Score, Function).

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer rewardBigDecimal(Score, Function).

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

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,
 ToIntFunction<A> matchWeigher)

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

Prefer reward(Score, ToIntFunction) 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, ToLongFunction) or rewardConfigurableBigDecimal(String, Function) 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(forRemoval=true)
default Constraint rewardConfigurable(String constraintPackage,
 String constraintName,
 ToIntFunction<A> matchWeigher)

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

Prefer reward(Score, ToIntFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurable(String, ToIntFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

rewardConfigurableLong

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

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

Prefer rewardLong(Score, ToLongFunction) 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,
 ToLongFunction<A> matchWeigher)

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

Prefer rewardLong(Score, ToLongFunction) and ConstraintWeightOverrides.

As defined by rewardConfigurableLong(String, ToLongFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

rewardConfigurableBigDecimal

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

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

Prefer rewardBigDecimal(Score, Function) 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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer rewardBigDecimal(Score, Function) and ConstraintWeightOverrides.

As defined by rewardConfigurableBigDecimal(String, Function).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impact

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

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

Prefer impact(Score, ToIntFunction).

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, ToLongFunction) or impactBigDecimal(String, Score, Function) 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,
 ToIntFunction<A> matchWeigher)

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

Prefer impact(Score, ToIntFunction).

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

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,
 ToLongFunction<A> matchWeigher)

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

Prefer impactLong(Score, ToLongFunction).

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,
 ToLongFunction<A> matchWeigher)

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

Prefer impactLong(Score, ToLongFunction).

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

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer impactBigDecimal(Score, Function).

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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer impactBigDecimal(Score, Function).

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

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,
 ToIntFunction<A> matchWeigher)

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

Prefer impact(Score, ToIntFunction) 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.

For non-int Score types use impactConfigurableLong(String, ToLongFunction) or impactConfigurableBigDecimal(String, Function) instead.

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,
 ToIntFunction<A> matchWeigher)

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

Prefer impact(Score, ToIntFunction) and ConstraintWeightOverrides.

As defined by impactConfigurable(String, ToIntFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impactConfigurableLong

@Deprecated(forRemoval=true,
            since="1.13.0")
default Constraint impactConfigurableLong(String constraintName,
 ToLongFunction<A> matchWeigher)

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

Prefer impactLong(Score, ToLongFunction) 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,
 ToLongFunction<A> matchWeigher)

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

Prefer impactLong(Score, ToLongFunction) and ConstraintWeightOverrides.

As defined by impactConfigurableLong(String, ToLongFunction).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null

impactConfigurableBigDecimal

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

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

Prefer impactBigDecimal(Score, Function) 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,
 Function<A,BigDecimal> matchWeigher)

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

Prefer impactBigDecimal(Score, Function) and ConstraintWeightOverrides.

As defined by impactConfigurableBigDecimal(String, Function).

Parameters:

constraintPackage - never null

constraintName - never null

matchWeigher - never null

Returns:

never null