Record Class CommentRequest

java.lang.Object

java.lang.Record

org.hibernate.dialect.schema.spi.CommentRequest

@SPI(USE)
public record CommentRequest(CommentTarget target, String qualifiedName, String comment)
extends Record

Describes a comment attached to one database schema object.

The qualified name is already formatted for the database. The raw comment may be empty and is escaped by the selected SchemaCommentSupport.

Since:

8.0

Constructor Summary

Constructors

Constructor	Description
CommentRequest(CommentTarget target, String qualifiedName, String comment)	Creates an instance of a CommentRequest 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.
String	qualifiedName()	Returns the value of the qualifiedName record component.
CommentTarget	target()	Returns the value of the target 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

CommentRequest

public CommentRequest(CommentTarget target,
 String qualifiedName,
 String comment)

Creates an instance of a CommentRequest record class.

Parameters:

target - the value for the target record component

qualifiedName - the value for the qualifiedName record component

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.

target

public CommentTarget target()

Returns the value of the target record component.

Returns:

the value of the target record component

qualifiedName

public String qualifiedName()

Returns the value of the qualifiedName record component.

Returns:

the value of the qualifiedName record component

comment

public String comment()

Returns the value of the comment record component.

Returns:

the value of the comment record component