Record Class EntityMapping<T>

java.lang.Object
java.lang.Record
jakarta.persistence.sql.EntityMapping<T>
Type Parameters:
T - The entity type
Record Components:
entityClass - The entity class
lockMode - The lock mode acquired by the SQL query
discriminatorColumn - The name of the column holding the discriminator; a null value indicates that there is no discriminator column.
fields - Mappings for fields or properties of the entity and of its entity subclasses
alias - An optional alias
All Implemented Interfaces:
MappingElement<T>, ResultSetMapping<T>, TupleElement<T>
public record EntityMapping<T>(@Nonnull Class<T> entityClass, @Nonnull LockModeType lockMode, @Nullable String discriminatorColumn, @Nonnull MemberMapping<? extends T>[] fields, @Nullable String alias) extends Record implements MappingElement<T>, ResultSetMapping<T>
Maps columns of a JDBC ResultSet to a given entity class.
Since:
4.0
See Also:

  • Constructor Details

    • EntityMapping

      public EntityMapping(@Nonnull Class<T> entityClass, @Nonnull LockModeType lockMode, @Nullable String discriminatorColumn, @Nonnull MemberMapping<? extends T>[] fields, @Nullable String alias)
      Creates an instance of a EntityMapping record class.
      Parameters:
      entityClass - the value for the entityClass record component
      lockMode - the value for the lockMode record component
      discriminatorColumn - the value for the discriminatorColumn record component
      fields - the value for the fields record component
      alias - the value for the alias record component

  • Method Details

    • fields

      @Nonnull public MemberMapping<? extends T>[] fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component

    • getJavaType

      @Nonnull public Class<T> getJavaType()
      The entity class.
      Specified by:
      getJavaType in interface TupleElement<T>
      Returns:
      the Java type of the tuple element

    • getAlias

      @Nullable public String getAlias()
      Return the alias specified via withAlias(String), which may be used to retrieve an entity instance using Tuple.get(String, Class)
      Specified by:
      getAlias in interface TupleElement<T>
      Returns:
      the explicitly specified alias or null

    • withAlias

      @Nonnull public EntityMapping<T> withAlias(@Nonnull String alias)
      Specify an alias for this entity in the result set.
      Specified by:
      withAlias in interface MappingElement<T>
      Parameters:
      alias - The alias

    • withLockMode

      @Nonnull public EntityMapping<T> withLockMode(@Nonnull LockModeType lockMode)
      Specify the lock mode obtained on this entity.
      Parameters:
      lockMode - The lock mode

    • of

      @Nonnull @SafeVarargs public static <T> EntityMapping<T> of(@Nonnull Class<T> entityClass, @Nonnull MemberMapping<T>... fields)
      Construct a new instance.
      Type Parameters:
      T - The entity type
      Parameters:
      entityClass - The entity class
      fields - Mappings for fields or properties of the entity

    • of

      @Nonnull @SafeVarargs public static <T> EntityMapping<T> of(@Nonnull Class<T> entityClass, @Nonnull String discriminatorColumn, @Nonnull MemberMapping<? extends T>... fields)
      Construct a new instance.
      Type Parameters:
      T - The entity type
      Parameters:
      entityClass - The entity class
      discriminatorColumn - The name of the column holding the discriminator; a null value indicates that there is no discriminator column.
      fields - Mappings for fields or properties of the entity and of its entity subclasses

    • type

      @Nonnull public Class<T> type()
      The entity class.
      Specified by:
      type in interface ResultSetMapping<T>

    • 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.

    • entityClass

      @Nonnull public Class<T> entityClass()
      Returns the value of the entityClass record component.
      Returns:
      the value of the entityClass record component

    • lockMode

      @Nonnull public LockModeType lockMode()
      Returns the value of the lockMode record component.
      Returns:
      the value of the lockMode record component

    • discriminatorColumn

      @Nullable public String discriminatorColumn()
      Returns the value of the discriminatorColumn record component.
      Returns:
      the value of the discriminatorColumn record component

    • alias

      @Nullable public String alias()
      Returns the value of the alias record component.
      Returns:
      the value of the alias record component