Record Class NuggetIntrospection.Query

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetIntrospection.Query

Record Components:

offset - zero-based offset

limit - maximum returned items

sortBy - stable sort field

direction - sort direction

filters - safe exact-match filters

Enclosing class:

NuggetIntrospection

public static record NuggetIntrospection.Query(int offset, int limit, String sortBy, NuggetIntrospection.SortDirection direction, Map<String,String> filters)
extends Record

Page, filter, and sort request for bounded collections.

Constructor Summary

Constructors

Constructor	Description
Query(int offset, int limit, String sortBy, NuggetIntrospection.SortDirection direction, Map<String,String> filters)	Creates bounded immutable query metadata.

Method Summary

Modifier and Type	Method	Description
static NuggetIntrospection.Query	all()	Creates the default query.
NuggetIntrospection.SortDirection	direction()	Returns the value of the direction record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,String>	filters()	Returns the value of the filters record component.
final int	hashCode()	Returns a hash code value for this object.
int	limit()	Returns the value of the limit record component.
int	offset()	Returns the value of the offset record component.
String	sortBy()	Returns the value of the sortBy 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

Query

public Query(int offset,
 int limit,
 String sortBy,
 NuggetIntrospection.SortDirection direction,
 Map<String,String> filters)

Creates bounded immutable query metadata.

Method Details

all

public static NuggetIntrospection.Query all()

Creates the default query.

Returns:

default query

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.

offset

public int offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

limit

public int limit()

Returns the value of the limit record component.

Returns:

the value of the limit record component

sortBy

public String sortBy()

Returns the value of the sortBy record component.

Returns:

the value of the sortBy record component

direction

public NuggetIntrospection.SortDirection direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component

filters

public Map<String,String> filters()

Returns the value of the filters record component.

Returns:

the value of the filters record component