Package org.optaplanner.core.config.heuristic.selector.value.chained

## Class SubChainSelectorConfig

- java.lang.Object
- - org.optaplanner.core.config.AbstractConfig<C>
  - - org.optaplanner.core.config.heuristic.selector.SelectorConfig<SubChainSelectorConfig>
    - - org.optaplanner.core.config.heuristic.selector.value.chained.SubChainSelectorConfig

-     public class SubChainSelectorConfig
      extends SelectorConfig<SubChainSelectorConfig>

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Integer` | `maximumSubChainSize` |
    `protected Integer` | `minimumSubChainSize` |
    `protected ValueSelectorConfig` | `valueSelectorConfig` |

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `SubChainSelectorConfig()` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `SubChainSelector` | `buildSubChainSelector​(HeuristicConfigPolicy configPolicy, EntityDescriptor entityDescriptor, SelectionCacheType minimumCacheType, SelectionOrder inheritedSelectionOrder)` |
    `SubChainSelectorConfig` | `copyConfig()` | Typically implemented by constructing a new instance and calling `AbstractConfig.inherit(AbstractConfig)` on it
    `Integer` | `getMaximumSubChainSize()` |
    `Integer` | `getMinimumSubChainSize()` |
    `ValueSelectorConfig` | `getValueSelectorConfig()` |
    `SubChainSelectorConfig` | `inherit​(SubChainSelectorConfig 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` | `setMaximumSubChainSize​(Integer maximumSubChainSize)` |
    `void` | `setMinimumSubChainSize​(Integer minimumSubChainSize)` |
    `void` | `setValueSelectorConfig​(ValueSelectorConfig valueSelectorConfig)` |
    `String` | `toString()` |

    - ### Methods inherited from class org.optaplanner.core.config.heuristic.selector.SelectorConfig

      `validateCacheTypeVersusSelectionOrder`

    - ### Methods inherited from class org.optaplanner.core.config.AbstractConfig

      `deduceEntityDescriptor, deduceVariableDescriptor, deduceVariableDescriptorList`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### valueSelectorConfig

          protected ValueSelectorConfig valueSelectorConfig

    - #### minimumSubChainSize

          protected Integer minimumSubChainSize

    - #### maximumSubChainSize

          protected Integer maximumSubChainSize

  - ### Constructor Detail

    - #### SubChainSelectorConfig

          public SubChainSelectorConfig()

  - ### Method Detail

    - #### getValueSelectorConfig

          public ValueSelectorConfig getValueSelectorConfig()

    - #### setValueSelectorConfig

          public void setValueSelectorConfig​(ValueSelectorConfig valueSelectorConfig)

    - #### getMinimumSubChainSize

          public Integer getMinimumSubChainSize()

      Returns:
        sometimes null

    - #### setMinimumSubChainSize

          public void setMinimumSubChainSize​(Integer minimumSubChainSize)

    - #### getMaximumSubChainSize

          public Integer getMaximumSubChainSize()

    - #### setMaximumSubChainSize

          public void setMaximumSubChainSize​(Integer maximumSubChainSize)

    - #### buildSubChainSelector

          public SubChainSelector buildSubChainSelector​(HeuristicConfigPolicy configPolicy,
                                                        EntityDescriptor entityDescriptor,
                                                        SelectionCacheType minimumCacheType,
                                                        SelectionOrder inheritedSelectionOrder)

      Parameters:
        `configPolicy` - never null
        `entityDescriptor` - never null
        `minimumCacheType` - never null, If caching is used (different from `SelectionCacheType.JUST_IN_TIME`), then it should be at least this `SelectionCacheType` because an ancestor already uses such caching and less would be pointless.
        `inheritedSelectionOrder` - never null
      Returns:
        never null

    - #### inherit

          public SubChainSelectorConfig inherit​(SubChainSelectorConfig 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.

      Specified by:
        `inherit` in class `AbstractConfig<SubChainSelectorConfig>`
      Parameters:
        `inheritedConfig` - never null
      Returns:
        this

    - #### copyConfig

          public SubChainSelectorConfig 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<SubChainSelectorConfig>`
      Returns:
        new instance

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `AbstractConfig<SubChainSelectorConfig>`