Package edu.ntnu.idatt2106_2023_06.backend.dto.items.fridge_items

Record Class FridgeItemSearchDTO

java.lang.Object
java.lang.Record
edu.ntnu.idatt2106_2023_06.backend.dto.items.fridge_items.FridgeItemSearchDTO
public record FridgeItemSearchDTO(@NonNull Long fridgeId, @NonNull String productName, @NonNull String sortField, @NonNull String sortOrder, @NonNull Integer page, @NonNull Integer pageSize) extends Record
Data Transfer Object for searching Fridge items. This record contains information about the fridgeId, productName to search for, the field and order to sort the search results, the page and pageSize of the search results.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FridgeItemSearchDTO(@NonNull Long fridgeId, @NonNull String productName, @NonNull String sortField, @NonNull String sortOrder, @NonNull Integer page, @NonNull Integer pageSize)
    Creates an instance of a FridgeItemSearchDTO record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NonNull Long
    fridgeId()
    Returns the value of the fridgeId record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NonNull Integer
    page()
    Returns the value of the page record component.
    @NonNull Integer
    pageSize()
    Returns the value of the pageSize record component.
    @NonNull String
    productName()
    Returns the value of the productName record component.
    @NonNull String
    sortField()
    Returns the value of the sortField record component.
    @NonNull String
    sortOrder()
    Returns the value of the sortOrder 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

  • Constructor Details

    • FridgeItemSearchDTO

      public FridgeItemSearchDTO(@NonNull @NonNull Long fridgeId, @NonNull @NonNull String productName, @NonNull @NonNull String sortField, @NonNull @NonNull String sortOrder, @NonNull @NonNull Integer page, @NonNull @NonNull Integer pageSize)
      Creates an instance of a FridgeItemSearchDTO record class.
      Parameters:
      fridgeId - the value for the fridgeId record component
      productName - the value for the productName record component
      sortField - the value for the sortField record component
      sortOrder - the value for the sortOrder record component
      page - the value for the page record component
      pageSize - the value for the pageSize 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. 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.

    • fridgeId

      @NonNull public @NonNull Long fridgeId()
      Returns the value of the fridgeId record component.
      Returns:
      the value of the fridgeId record component

    • productName

      @NonNull public @NonNull String productName()
      Returns the value of the productName record component.
      Returns:
      the value of the productName record component

    • sortField

      @NonNull public @NonNull String sortField()
      Returns the value of the sortField record component.
      Returns:
      the value of the sortField record component

    • sortOrder

      @NonNull public @NonNull String sortOrder()
      Returns the value of the sortOrder record component.
      Returns:
      the value of the sortOrder record component

    • page

      @NonNull public @NonNull Integer page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component

    • pageSize

      @NonNull public @NonNull Integer pageSize()
      Returns the value of the pageSize record component.
      Returns:
      the value of the pageSize record component