Package org.optaplanner.core.impl.heuristic.selector.value.mimic

## Class MimicRecordingValueSelector

- java.lang.Object
- - org.optaplanner.core.impl.heuristic.selector.AbstractSelector
  - - org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector
    - - org.optaplanner.core.impl.heuristic.selector.value.mimic.MimicRecordingValueSelector

- All Implemented Interfaces:
    `Iterable<Object>`, `EventListener`, `IterableSelector<Object>`, `Selector`, `EntityIndependentValueSelector`, `ValueMimicRecorder`, `ValueSelector`, `PhaseLifecycleListener`, `SolverLifecycleListener`

      public class MimicRecordingValueSelector
      extends AbstractValueSelector
      implements ValueMimicRecorder, EntityIndependentValueSelector

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected EntityIndependentValueSelector` | `childValueSelector` |
    `protected List<MimicReplayingValueSelector>` | `replayingValueSelectorList` |

    - ### Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

      `logger, phaseLifecycleSupport, workingRandom`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `MimicRecordingValueSelector​(EntityIndependentValueSelector childValueSelector)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | `addMimicReplayingValueSelector​(MimicReplayingValueSelector replayingEntitySelector)` |
    `Iterator<Object>` | `endingIterator​(Object entity)` | If `Selector.isNeverEnding()` is true, then `ValueSelector.iterator(Object)` will never end.
    `long` | `getSize()` | A random JIT `Selector` with `Selector.isNeverEnding()` true should return a size as if it would be able to return each distinct element only once, because the size can be used in `SelectionProbabilityWeightFactory`.
    `long` | `getSize​(Object entity)` | Similar to `IterableSelector.getSize()`, but requires an entity.
    `GenuineVariableDescriptor` | `getVariableDescriptor()` |
    `boolean` | `isCountable()` | If false, then `Selector.isNeverEnding()` is true.
    `boolean` | `isNeverEnding()` | Is true if `Selector.isCountable()` is false or if this selector is in random order (for most cases).
    `Iterator<Object>` | `iterator()` |
    `Iterator<Object>` | `iterator​(Object entity)` | Similar to `Iterable.iterator()`, but requires an entity.
    `String` | `toString()` |

    - ### Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

      `getCacheType, phaseEnded, phaseStarted, solvingEnded, solvingStarted, stepEnded, stepStarted`

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

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

    - ### Methods inherited from interface java.lang.Iterable

      `forEach, spliterator`

    - ### Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

      `phaseEnded, phaseStarted, stepEnded, stepStarted`

    - ### Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.Selector

      `getCacheType`

    - ### Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener

      `solvingEnded, solvingStarted`

- - ### Field Detail

    - #### childValueSelector

          protected final EntityIndependentValueSelector childValueSelector

    - #### replayingValueSelectorList

          protected final List<MimicReplayingValueSelector> replayingValueSelectorList

  - ### Constructor Detail

    - #### MimicRecordingValueSelector

          public MimicRecordingValueSelector​(EntityIndependentValueSelector childValueSelector)

  - ### Method Detail

    - #### addMimicReplayingValueSelector

          public void addMimicReplayingValueSelector​(MimicReplayingValueSelector replayingEntitySelector)

      Specified by:
        `addMimicReplayingValueSelector` in interface `ValueMimicRecorder`
      Parameters:
        `replayingEntitySelector` - never null

    - #### getVariableDescriptor

          public GenuineVariableDescriptor getVariableDescriptor()

      Specified by:
        `getVariableDescriptor` in interface `ValueMimicRecorder`
      Specified by:
        `getVariableDescriptor` in interface `ValueSelector`
      Returns:
        As defined by `ValueSelector.getVariableDescriptor()`
      See Also:
        `ValueSelector.getVariableDescriptor()`

    - #### isCountable

          public boolean isCountable()

      Description copied from interface: `Selector`
      If false, then `Selector.isNeverEnding()` is true.
      Specified by:
        `isCountable` in interface `Selector`
      Specified by:
        `isCountable` in interface `ValueMimicRecorder`
      Returns:
        As defined by `Selector.isCountable()`
      See Also:
        `Selector.isCountable()`

    - #### isNeverEnding

          public boolean isNeverEnding()

      Description copied from interface: `Selector`
      Is true if `Selector.isCountable()` is false or if this selector is in random order (for most cases). Is never true when this selector is in shuffled order (which is less scalable but more exact).
      Specified by:
        `isNeverEnding` in interface `Selector`
      Specified by:
        `isNeverEnding` in interface `ValueMimicRecorder`
      Returns:
        As defined by `Selector.isNeverEnding()`
      See Also:
        `Selector.isNeverEnding()`

    - #### getSize

          public long getSize​(Object entity)

      Description copied from interface: `ValueSelector`
      Similar to `IterableSelector.getSize()`, but requires an entity.
      Specified by:
        `getSize` in interface `ValueMimicRecorder`
      Specified by:
        `getSize` in interface `ValueSelector`
      Parameters:
        `entity` - never null
      Returns:
        As defined by `ValueSelector.getSize(Object)`
      See Also:
        `ValueSelector.getSize(Object)`

    - #### getSize

          public long getSize()

      Description copied from interface: `IterableSelector`
      A random JIT `Selector` with `Selector.isNeverEnding()` true should return a size as if it would be able to return each distinct element only once, because the size can be used in `SelectionProbabilityWeightFactory`.
      Specified by:
        `getSize` in interface `IterableSelector<Object>`
      Specified by:
        `getSize` in interface `ValueMimicRecorder`
      Returns:
        As defined by `IterableSelector.getSize()`
      See Also:
        `IterableSelector.getSize()`

    - #### iterator

          public Iterator<Object> iterator​(Object entity)

      Description copied from interface: `ValueSelector`
      Similar to `Iterable.iterator()`, but requires an entity.
      Specified by:
        `iterator` in interface `ValueSelector`
      Parameters:
        `entity` - never null
      Returns:
        never null

    - #### iterator

          public Iterator<Object> iterator()

      Specified by:
        `iterator` in interface `Iterable<Object>`

    - #### endingIterator

          public Iterator<Object> endingIterator​(Object entity)

      Description copied from interface: `ValueSelector`
      If `Selector.isNeverEnding()` is true, then `ValueSelector.iterator(Object)` will never end. This returns an ending `Iterator`, that tries to match `ValueSelector.iterator(Object)` as much as possible, but return each distinct element only once and therefore it might not respect the configuration of this `ValueSelector` entirely.
      Specified by:
        `endingIterator` in interface `ValueMimicRecorder`
      Specified by:
        `endingIterator` in interface `ValueSelector`
      Parameters:
        `entity` - never null
      Returns:
        As defined by `ValueSelector.endingIterator(Object)`
      See Also:
        `ValueSelector.endingIterator(Object)`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`