Package org.hansken.plugin.extraction.api

Record Class SearchSortOption

java.lang.Object

java.lang.Record

org.hansken.plugin.extraction.api.SearchSortOption

Record Components:

field - the name of the field to sort on.

direction - the sort direction (ascending or descending).

public record SearchSortOption(String field, SearchSortOption.Direction direction)
extends Record

Represents a sort option used in searches, including the field to sort by and the direction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchSortOption.Builder	Builder for creating SearchSortOption instances.
static enum	SearchSortOption.Direction	The sort direction.

Constructor Summary

Constructors

Constructor	Description
SearchSortOption(String field, SearchSortOption.Direction direction)	Creates an instance of a SearchSortOption record class.

Method Summary

Modifier and Type	Method	Description
static SearchSortOption.Builder	builder()	Creates a new SearchSortOption.Builder instance for constructing a SearchSortOption.
SearchSortOption.Direction	direction()	Returns the value of the direction record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	field()	Returns the value of the field record component.
final int	hashCode()	Returns a hash code value for this object.
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

Constructor Details

SearchSortOption

public SearchSortOption(String field,
 SearchSortOption.Direction direction)

Creates an instance of a SearchSortOption record class.

Parameters:

field - the value for the field record component

direction - the value for the direction record component

Method Details

builder

public static SearchSortOption.Builder builder()

Creates a new SearchSortOption.Builder instance for constructing a SearchSortOption.

Returns:

a new Builder.

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.

field

public String field()

Returns the value of the field record component.

Returns:

the value of the field record component

direction

public SearchSortOption.Direction direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component