Record Class QueryOption.Comment

java.lang.Object

java.lang.Record

org.hibernate.query.QueryOption.Comment

Record Components:

comment - The text of the comment

All Implemented Interfaces:

Statement.Option, TypedQuery.Option

Enclosing interface:

QueryOption

public static record QueryOption.Comment(String comment)
extends Record
implements TypedQuery.Option, Statement.Option

Specifies a comment for the SQL query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

Since:

8.0

Constructor Summary

Constructors

Constructor	Description
Comment(String comment)	Creates an instance of a Comment record class.

Method Summary

Modifier and Type	Method	Description
String	comment()	Returns the value of the comment record component.
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.
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

Comment

public Comment(String comment)

Creates an instance of a Comment record class.

Parameters:

comment - the value for the comment 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.

comment

public String comment()

Returns the value of the comment record component.

Returns:

the value of the comment record component