Skip to content

Commit db30bb6

Browse files
committed
Fix contract
1 parent 1a1909c commit db30bb6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

core/src/main/java/ai/timefold/solver/core/impl/move/streams/maybeapi/stream/MoveStreamFactory.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,21 @@
55
import ai.timefold.solver.core.api.domain.entity.PlanningPinToIndex;
66
import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
77
import ai.timefold.solver.core.api.domain.variable.PlanningListVariable;
8-
import ai.timefold.solver.core.api.score.stream.ConstraintStream;
98
import ai.timefold.solver.core.impl.move.streams.maybeapi.UniDataFilter;
109
import ai.timefold.solver.core.preview.api.domain.metamodel.GenuineVariableMetaModel;
11-
import ai.timefold.solver.core.preview.api.domain.metamodel.PlanningVariableMetaModel;
1210

1311
import org.jspecify.annotations.NullMarked;
1412

1513
@NullMarked
1614
public interface MoveStreamFactory<Solution_> {
1715

1816
/**
19-
* Start a {@link ConstraintStream} of all instances of the sourceClass
20-
* that are known as {@link ProblemFactCollectionProperty problem facts} or {@link PlanningEntity planning entities}.
17+
* Start a {@link DataStream} of all instances of the sourceClass
18+
* that are known as {@link ProblemFactCollectionProperty problem facts}
19+
* or {@link PlanningEntity planning entities}.
2120
* <p>
2221
* If the sourceClass is a {@link PlanningEntity}, then it is automatically
23-
* {@link UniDataStream#filter(UniDataFilter)} filtered} to only contain entities
22+
* {@link UniDataStream#filter(UniDataFilter) filtered} to only contain entities
2423
* which are not pinned.
2524
* <p>
2625
* If the sourceClass is a shadow entity (an entity without any genuine planning variables),
@@ -31,7 +30,7 @@ public interface MoveStreamFactory<Solution_> {
3130
* <p>
3231
* This stream returns genuine entities regardless of whether they have any null genuine planning variables.
3332
* This stream returns shadow entities regardless of whether they are assigned to any genuine entity.
34-
* They can easily be {@link UniDataStream#filter(UniDataFilter)} filtered out}.
33+
* They can easily be {@link UniDataStream#filter(UniDataFilter) filtered out}.
3534
*
3635
* @return A stream containing a tuple for each of the entities as described above.
3736
* @see PlanningPin An annotation to mark the entire entity as pinned.
@@ -42,8 +41,9 @@ public interface MoveStreamFactory<Solution_> {
4241
<A> UniDataStream<Solution_, A> enumerate(Class<A> sourceClass, boolean includeNull);
4342

4443
/**
45-
* Start a {@link ConstraintStream} of all instances of the sourceClass
46-
* that are known as {@link ProblemFactCollectionProperty problem facts} or {@link PlanningEntity planning entities}.
44+
* Start a {@link DataStream} of all instances of the sourceClass
45+
* that are known as {@link ProblemFactCollectionProperty problem facts}
46+
* or {@link PlanningEntity planning entities}.
4747
* If the sourceClass is a genuine or shadow entity,
4848
* it returns instances regardless of their pinning status.
4949
* Otherwise as defined by {@link #enumerate(Class, boolean)}.
@@ -60,7 +60,7 @@ public interface MoveStreamFactory<Solution_> {
6060
* @return data stream with all possible values of a given variable
6161
*/
6262
default <Entity_, Value_> BiDataStream<Solution_, Entity_, Value_> enumerateEntityValuePairs(
63-
PlanningVariableMetaModel<Solution_, Entity_, Value_> variableMetaModel) {
63+
GenuineVariableMetaModel<Solution_, Entity_, Value_> variableMetaModel) {
6464
return enumerateEntityValuePairs(variableMetaModel, enumerate(variableMetaModel.entity().type(), false));
6565
}
6666

0 commit comments

Comments
 (0)