Package org.apache.nifi.database.dialect.service.api

Record Class StandardPageRequest

java.lang.Object

java.lang.Record

org.apache.nifi.database.dialect.service.api.StandardPageRequest

Record Components:

offset - Offset starting index of requested page of results

limit - Limit total number of results

indexColumnName - Column Name for indexing results or empty

All Implemented Interfaces:

PageRequest

public record StandardPageRequest(long offset, OptionalLong limit, Optional<String> indexColumnName)
extends Record
implements PageRequest

Standard record implementation of Page Request

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<String>	indexColumnName	The field for the indexColumnName record component.
private final OptionalLong	limit	The field for the limit record component.
private final long	offset	The field for the offset record component.

Constructor Summary

Constructors

Constructor	Description
StandardPageRequest(long offset, OptionalLong limit, Optional<String> indexColumnName)	Creates an instance of a StandardPageRequest 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.
Optional<String>	indexColumnName()	Returns the value of the indexColumnName record component.
OptionalLong	limit()	Returns the value of the limit record component.
long	offset()	Returns the value of the offset 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

Field Details

offset

private final long offset

The field for the offset record component.

limit

private final OptionalLong limit

The field for the limit record component.

indexColumnName

private final Optional<String> indexColumnName

The field for the indexColumnName record component.

Constructor Details

StandardPageRequest

public StandardPageRequest(long offset,
 OptionalLong limit,
 Optional<String> indexColumnName)

Creates an instance of a StandardPageRequest record class.

Parameters:

offset - the value for the offset record component

limit - the value for the limit record component

indexColumnName - the value for the indexColumnName 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 '=='.

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.

offset

public long offset()

Returns the value of the offset record component.

Specified by:

offset in interface PageRequest

Returns:

the value of the offset record component

limit

public OptionalLong limit()

Returns the value of the limit record component.

Specified by:

limit in interface PageRequest

Returns:

the value of the limit record component

indexColumnName

public Optional<String> indexColumnName()

Returns the value of the indexColumnName record component.

Specified by:

indexColumnName in interface PageRequest

Returns:

the value of the indexColumnName record component