Package org.optaplanner.constraint.streams.bavet.common.index

Interface IndexProperties

  • public interface IndexProperties
    Index properties are cached in tuples and each tuple carries its unique instance.

    Index properties are shallow immutable and implement Object.equals(Object) and Object.hashCode().

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <Type_> Type_ toKey​(int index)
      Retrieves index property at a given position.
      <Type_> Type_ toKey​(int from, int to)
      Retrieves an object to serve as a key in an index.

    • Method Detail

      • toKey

        <Type_> Type_ toKey​(int index)
        Retrieves index property at a given position.
        Type Parameters:
        Type_ - ComparisonIndexer will expect this to implement Comparable.
        Parameters:
        index -
        Returns:
        never null

      • toKey

        <Type_> Type_ toKey​(int from,
                    int to)
        Retrieves an object to serve as a key in an index. Instances retrieved using the same arguments must be equal.
        Type Parameters:
        Type_ - expected type of the key
        Parameters:
        from - index of the first property to use, inclusive
        to - index of the last property to use, exclusive
        Returns:
        never null