Annotation Interface ListIndexBase


@Retention(RUNTIME) public @interface ListIndexBase
Specifies the base value for the order column of a persistent list or array, that is, the order column value of the first element of the list or array.
  • When a row is read from the database, this base value is subtracted from the order column value to determine an index in the list or array.
  • When an element is written to the database, the base value is added to the list or array index to determine the order column value.

By default, the base value for an order column is zero, as required by JPA.

This annotation is usually used in conjunction with the JPA-defined OrderColumn.

See Also:
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    The list index base.
  • Element Details

    • value

      int value
      The list index base. Default is 0.
      Default:
      0