Record Class ScalarResultSegment

java.lang.Object

java.lang.Record

org.apache.cayenne.query.ScalarResultSegment

Record Components:

column - the ResultSet column label

type - the Java type the column value is converted to, or null when the segment declares none and the value is read with the type determined for the column by the query (a SQLTemplate "#result" directive, or the type the driver reports)

columnOffset - a zero-based column index of this segment's column in the ResultSet

All Implemented Interfaces:

ResultSegment

public record ScalarResultSegment(String column, Class<?> type, int columnOffset)
extends Record
implements ResultSegment

A result set segment mapped to a single scalar value.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
ScalarResultSegment(String column, Class<?> type, int columnOffset)	Creates an instance of a ScalarResultSegment record class.

Method Summary

Modifier and Type	Method	Description
String	column()	Returns the value of the column record component.
int	columnOffset()	Returns the value of the columnOffset 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.
Class<?>	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

ScalarResultSegment

public ScalarResultSegment(String column,
 Class<?> type,
 int columnOffset)

Creates an instance of a ScalarResultSegment record class.

Parameters:

column - the value for the column record component

type - the value for the type record component

columnOffset - the value for the columnOffset 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

column

public String column()

Returns the value of the column record component.

Returns:

the value of the column record component

type

public Class<?> type()

Returns the value of the type record component.

Returns:

the value of the type record component

columnOffset

public int columnOffset()

Returns the value of the columnOffset record component.

Specified by:

columnOffset in interface ResultSegment

Returns:

the value of the columnOffset record component