Record Class TupleMapping

java.lang.Object
java.lang.Record
jakarta.persistence.sql.TupleMapping
Record Components:
elements - Mappings for the elements of the tuple
All Implemented Interfaces:
ResultSetMapping<Tuple>
public record TupleMapping(@Nonnull MappingElement<?>[] elements) extends Record implements ResultSetMapping<Tuple>
Map columns of a JDBC ResultSet to entries in a tuple of values packaged as an instance of Tuple. 

import static jakarta.persistence.sql.ResultSetMapping.*;

...

var isbn = column("isbn", String.class);
var title = column("title", String.class);
var pages = column("pages", int.class);

entityManager.createNativeQuery("select isbn, title, pages from Book",
                                tuple(isbn, title, pages))
    .getResultList().forEach(tuple -> {
        String bookIsbn = tuple.get(isbn);
        String bookTitle = tuple.get(title);
        int bookPages = tuple.get(pages);
        ...
    });

Each result Tuple contains an entry for each element of the TupleMapping. The index and alias of a tuple entry are determined by the position of the element in TupleMapping and the alias of the element, respectively.

Since:
4.0
See Also:

  • Constructor Details

    • TupleMapping

      public TupleMapping(@Nonnull MappingElement<?>[] elements)
      Creates an instance of a TupleMapping record class.
      Parameters:
      elements - the value for the elements record component

  • Method Details

    • elements

      @Nonnull public MappingElement<?>[] elements()
      Returns the value of the elements record component.
      Returns:
      the value of the elements record component

    • of

      @Nonnull public static TupleMapping of(@Nonnull MappingElement<?>... elements)
      Construct a new instance.
      Parameters:
      elements - Mappings for the elements of the tuple

    • type

      @Nonnull public Class<Tuple> type()
      Always returns Tuple.class.
      Specified by:
      type in interface ResultSetMapping<Tuple>

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.