Package org.hibernate

Record Class EnabledFetchProfile

java.lang.Object
java.lang.Record
org.hibernate.EnabledFetchProfile
Record Components:
profileName - the profile name
All Implemented Interfaces:
FindOption
public record EnabledFetchProfile(String profileName) extends Record implements FindOption
A FindOption which requests a named fetch profile.

An instance of this class may be obtained in a type safe way from the static metamodel for the class annotated @FetchProfile.

For example, this class defines a fetch profile: 

 @Entity
 @FetchProfile(name = "WithAuthors")
 class Book {
     ...

     @ManyToMany
     @FetchProfileOverride(profile = Book_.PROFILE_WITH_AUTHORS)
     Set<Author> authors;
 }

An EnabledFetchProfile may be obtained from the static metamodel for the entity Book and passed as an option to find(). 

 Book bookWithAuthors =
         session.find(Book.class, isbn, Book_._WithAuthors)
Alternatively, it may be applied to a Session or Query. 
 Book_._WithAuthors.enable(session);
 Book bookWithAuthors = session.find(Book.class, isbn);

When the static metamodel is not used, an EnabledFetchProfile may be instantiated directly, passing the name of the fetch profile as a string. 

 Book bookWithAuthors =
         session.find(Book.class, isbn,
                      new EnabledFetchProfile("WithAuthors"))
Since:
7.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EnabledFetchProfile(String profileName)
    Creates an instance of a EnabledFetchProfile record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enable(SelectionQuery<?> query)
    Enable the fetch profile represented by this object during execution of the given query.
    void
    enable(Session session)
    Enable the fetch profile represented by this object in the given session.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    profileName()
    Returns the value of the profileName record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EnabledFetchProfile

      public EnabledFetchProfile(String profileName)
      Creates an instance of a EnabledFetchProfile record class.
      Parameters:
      profileName - the value for the profileName record component

  • Method Details

    • enable

      public void enable(Session session)
      Enable the fetch profile represented by this object in the given session.

    • enable

      public void enable(SelectionQuery<?> query)
      Enable the fetch profile represented by this object during execution of the given query.

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

    • profileName

      public String profileName()
      Returns the value of the profileName record component.
      Returns:
      the value of the profileName record component