Package ai.timefold.solver.core.impl.neighborhood.stream.enumerating

Class EnumeratingStreamFactory<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.neighborhood.stream.enumerating.EnumeratingStreamFactory<Solution_>

@NullMarked
public final class EnumeratingStreamFactory<Solution_>
extends Object

Constructor Summary

Constructors

Constructor	Description
EnumeratingStreamFactory(SolutionDescriptor<Solution_> solutionDescriptor, EnvironmentMode environmentMode)

Method Summary

Modifier and Type	Method	Description
<A> void	assertValidForEachType(Class<A> fromType)
<A> UniEnumeratingStream<Solution_,A>	forEachExcludingPinned(Class<A> sourceClass, boolean includeNull)
<A> UniEnumeratingStream<Solution_,A>	forEachNonDiscriminating(Class<A> sourceClass, boolean includeNull)
List<AbstractDataset<Solution_>>	getDatasets()
EnvironmentMode	getEnvironmentMode()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
<Stream_ extends AbstractEnumeratingStream<Solution_>> Stream_	share(Stream_ stream)
<Stream_ extends AbstractEnumeratingStream<Solution_>> Stream_	share(Stream_ stream, Consumer<Stream_> consumer)	Enables node sharing.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumeratingStreamFactory

public EnumeratingStreamFactory(SolutionDescriptor<Solution_> solutionDescriptor,
 EnvironmentMode environmentMode)

Method Details

forEachNonDiscriminating

public <A> UniEnumeratingStream<Solution_,A> forEachNonDiscriminating(Class<A> sourceClass,
 boolean includeNull)

forEachExcludingPinned

public <A> UniEnumeratingStream<Solution_,A> forEachExcludingPinned(Class<A> sourceClass,
 boolean includeNull)

assertValidForEachType

public <A> void assertValidForEachType(Class<A> fromType)

share

public <Stream_ extends AbstractEnumeratingStream<Solution_>>
Stream_ share(Stream_ stream)

share

public <Stream_ extends AbstractEnumeratingStream<Solution_>>
Stream_ share(Stream_ stream,
 Consumer<Stream_> consumer)

Enables node sharing. If a stream already exists in this factory, it replaces it with the old copy. AbstractEnumeratingStream implement equals/hashcode ignoring child streams.

DatasetSessionFactory.buildSession(SessionContext) needs this to happen for all streams.

This must be called before the stream receives child streams.

Type Parameters:

Stream_ - the AbstractEnumeratingStream subclass

Parameters:

stream - never null

consumer - never null

Returns:

never null

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

getEnvironmentMode

public EnvironmentMode getEnvironmentMode()

getDatasets

public List<AbstractDataset<Solution_>> getDatasets()