Record Class SessionCreationOption.EffectiveAt

java.lang.Object
java.lang.Record
org.hibernate.SessionCreationOption.EffectiveAt
All Implemented Interfaces:
EntityAgent.CreationOption, EntityManager.CreationOption
Enclosing interface:
SessionCreationOption
public static record SessionCreationOption.EffectiveAt(Instant instant) extends Record implements EntityManager.CreationOption, EntityAgent.CreationOption
Specify the instant for reading temporal entity data. Instances of temporal entities retrieved in the created session represent the revisions effective at the given instant.
Since:
8.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EffectiveAt(Instant instant)
    Creates an instance of a EffectiveAt record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    Instant
    instant()
    Returns the value of the instant record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • EffectiveAt

      public EffectiveAt(Instant instant)
      Creates an instance of a EffectiveAt record class.
      Parameters:
      instant - the value for the instant record component

  • Method Details

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

    • instant

      public Instant instant()
      Returns the value of the instant record component.
      Returns:
      the value of the instant record component