Package ai.timefold.solver.core.config.phase.custom

Class CustomPhaseConfig

java.lang.Object

ai.timefold.solver.core.config.AbstractConfig<Config_>

ai.timefold.solver.core.config.phase.PhaseConfig<CustomPhaseConfig>

ai.timefold.solver.core.config.phase.custom.CustomPhaseConfig

@NullMarked
public class CustomPhaseConfig
extends PhaseConfig<CustomPhaseConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable List<Class<? extends PhaseCommand>>	customPhaseCommandClassList
protected @Nullable List<? extends PhaseCommand>	customPhaseCommandList
protected @Nullable Map<String,String>	customProperties
static final String	XML_ELEMENT_NAME

Fields inherited from class ai.timefold.solver.core.config.phase.PhaseConfig

terminationConfig

Constructor Summary

Constructors

Constructor	Description
CustomPhaseConfig()

Method Summary

Modifier and Type	Method	Description
CustomPhaseConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@Nullable List<Class<? extends PhaseCommand>>	getCustomPhaseCommandClassList()
@Nullable List<? extends PhaseCommand>	getCustomPhaseCommandList()
@Nullable Map<String,String>	getCustomProperties()
CustomPhaseConfig	inherit(CustomPhaseConfig inheritedConfig)	Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).
void	setCustomPhaseCommandClassList(@Nullable List<Class<? extends PhaseCommand>> customPhaseCommandClassList)
void	setCustomPhaseCommandList(@Nullable List<? extends PhaseCommand> customPhaseCommandList)
void	setCustomProperties(@Nullable Map<String,String> customProperties)
void	visitReferencedClasses(Consumer<Class<?>> classVisitor)	Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs).
CustomPhaseConfig	withCustomPhaseCommandClassList(List<Class<? extends PhaseCommand>> customPhaseCommandClassList)
CustomPhaseConfig	withCustomPhaseCommandList(List<? extends PhaseCommand> customPhaseCommandList)
<Solution_> CustomPhaseConfig	withCustomPhaseCommands(PhaseCommand<Solution_>... customPhaseCommands)
CustomPhaseConfig	withCustomProperties(Map<String,String> customProperties)

Methods inherited from class ai.timefold.solver.core.config.phase.PhaseConfig

getTerminationConfig, setTerminationConfig, toString, withTerminationConfig

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

See Also:

• Constant Field Values

customPhaseCommandClassList

protected @Nullable List<Class<? extends PhaseCommand>> customPhaseCommandClassList

customProperties

protected @Nullable Map<String,String> customProperties

customPhaseCommandList

protected @Nullable List<? extends PhaseCommand> customPhaseCommandList

Constructor Details

CustomPhaseConfig

public CustomPhaseConfig()

Method Details

getCustomPhaseCommandClassList

public @Nullable List<Class<? extends PhaseCommand>> getCustomPhaseCommandClassList()

setCustomPhaseCommandClassList

public void setCustomPhaseCommandClassList(@Nullable List<Class<? extends PhaseCommand>> customPhaseCommandClassList)

getCustomProperties

public @Nullable Map<String,String> getCustomProperties()

setCustomProperties

public void setCustomProperties(@Nullable Map<String,String> customProperties)

getCustomPhaseCommandList

public @Nullable List<? extends PhaseCommand> getCustomPhaseCommandList()

setCustomPhaseCommandList

public void setCustomPhaseCommandList(@Nullable List<? extends PhaseCommand> customPhaseCommandList)

withCustomPhaseCommandClassList

public CustomPhaseConfig withCustomPhaseCommandClassList(List<Class<? extends PhaseCommand>> customPhaseCommandClassList)

withCustomProperties

public CustomPhaseConfig withCustomProperties(Map<String,String> customProperties)

withCustomPhaseCommandList

public CustomPhaseConfig withCustomPhaseCommandList(List<? extends PhaseCommand> customPhaseCommandList)

withCustomPhaseCommands

public <Solution_> CustomPhaseConfig withCustomPhaseCommands(PhaseCommand<Solution_>... customPhaseCommands)

inherit

public CustomPhaseConfig inherit(CustomPhaseConfig inheritedConfig)

Description copied from class: AbstractConfig

Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).

After the inheritance, if a property on this AbstractConfig composition is replaced, it should not affect the inherited composition instance.

Overrides:

inherit in class PhaseConfig<CustomPhaseConfig>

Returns:

this

copyConfig

public CustomPhaseConfig copyConfig()

Description copied from class: AbstractConfig

Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.

Specified by:

copyConfig in class AbstractConfig<CustomPhaseConfig>

Returns:

new instance

visitReferencedClasses

public void visitReferencedClasses(Consumer<Class<?>> classVisitor)

Description copied from class: AbstractConfig

Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs). Required to create the bean factory in Quarkus.

Specified by:

visitReferencedClasses in class AbstractConfig<CustomPhaseConfig>

Parameters:

classVisitor - The visitor of classes. Can accept null instances of Class.