Record Class NuggetIntrospection.CollectionResult<T>

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<T>

Type Parameters:

T - item type

Record Components:

items - returned items

offset - applied offset

limit - applied limit

returned - returned item count

totalAvailable - total authorized count, or -1 when hidden

totalAvailableAuthorized - whether totalAvailable is authorized

sortedBy - applied sort field

direction - applied sort direction

filters - applied filters

collectedAt - collection timestamp

partial - whether provider data was partial

metadata - safe metadata

Enclosing class:

NuggetIntrospection

public static record NuggetIntrospection.CollectionResult<T>(List<T> items, int offset, int limit, int returned, int totalAvailable, boolean totalAvailableAuthorized, String sortedBy, NuggetIntrospection.SortDirection direction, Map<String,String> filters, Instant collectedAt, boolean partial, Map<String,String> metadata)
extends Record

Bounded collection result.

Constructor Summary

Constructors

Constructor	Description
CollectionResult(List<T> items, int offset, int limit, int returned, int totalAvailable, boolean totalAvailableAuthorized, String sortedBy, NuggetIntrospection.SortDirection direction, Map<String,String> filters, Instant collectedAt, boolean partial, Map<String,String> metadata)	Creates immutable collection metadata.

Method Summary

Modifier and Type	Method	Description
Instant	collectedAt()	Returns the value of the collectedAt record component.
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.
List<T>	items()	Returns the value of the items record component.
int	limit()	Returns the value of the limit record component.
Map<String,String>	metadata()	Returns the value of the metadata record component.
int	offset()	Returns the value of the offset record component.
boolean	partial()	Returns the value of the partial record component.
int	returned()	Returns the value of the returned record component.
String	sortedBy()	Returns the value of the sortedBy record component.
final String	toString()	Returns a string representation of this record class.
int	totalAvailable()	Returns the value of the totalAvailable record component.
boolean	totalAvailableAuthorized()	Returns the value of the totalAvailableAuthorized record component.

Methods inherited from class Object

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

Constructor Details

CollectionResult

public CollectionResult(List<T> items,
 int offset,
 int limit,
 int returned,
 int totalAvailable,
 boolean totalAvailableAuthorized,
 String sortedBy,
 NuggetIntrospection.SortDirection direction,
 Map<String,String> filters,
 Instant collectedAt,
 boolean partial,
 Map<String,String> metadata)

Creates immutable collection metadata.

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.

items

public List<T> items()

Returns the value of the items record component.

Returns:

the value of the items record component

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

returned

public int returned()

Returns the value of the returned record component.

Returns:

the value of the returned record component

totalAvailable

public int totalAvailable()

Returns the value of the totalAvailable record component.

Returns:

the value of the totalAvailable record component

totalAvailableAuthorized

public boolean totalAvailableAuthorized()

Returns the value of the totalAvailableAuthorized record component.

Returns:

the value of the totalAvailableAuthorized record component

sortedBy

public String sortedBy()

Returns the value of the sortedBy record component.

Returns:

the value of the sortedBy 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

collectedAt

public Instant collectedAt()

Returns the value of the collectedAt record component.

Returns:

the value of the collectedAt record component

partial

public boolean partial()

Returns the value of the partial record component.

Returns:

the value of the partial record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component