Package io.github.mqzn.commands.utilities.text

Record Class TextPage<S,T extends TextConvertible<S>>

java.lang.Object
java.lang.Record
io.github.mqzn.commands.utilities.text.TextPage<S,T>
All Implemented Interfaces:
Iterable<T>
public record TextPage<S,T extends TextConvertible<S>>(int pageIndex, int capacity, List<T extends TextConvertible<S>> pageItems) extends Record implements Iterable<T>

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextPage(int pageIndex, int capacity, List<T> pageItems)
    Creates an instance of a TextPage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(T obj)
     
    void
    addAll(List<T> otherItems)
     
    int
    capacity()
    Returns the value of the capacity record component.
    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.
    @NonNull Iterator<T>
    iterator()
     
    int
    pageIndex()
    Returns the value of the pageIndex record component.
    List<T>
    pageItems()
    Returns the value of the pageItems record component.
    void
    remove(T obj)
     
    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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • TextPage

      public TextPage(int pageIndex, int capacity, List<T> pageItems)
      Creates an instance of a TextPage record class.
      Parameters:
      pageIndex - the value for the pageIndex record component
      capacity - the value for the capacity record component
      pageItems - the value for the pageItems record component

  • Method Details

    • add

      public void add(T obj)

    • remove

      public void remove(T obj)

    • addAll

      public void addAll(List<T> otherItems)

    • iterator

      @NonNull public @NonNull Iterator<T> iterator()
      Specified by:
      iterator in interface Iterable<S>

    • 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.

    • pageIndex

      public int pageIndex()
      Returns the value of the pageIndex record component.
      Returns:
      the value of the pageIndex record component

    • capacity

      public int capacity()
      Returns the value of the capacity record component.
      Returns:
      the value of the capacity record component

    • pageItems

      public List<T> pageItems()
      Returns the value of the pageItems record component.
      Returns:
      the value of the pageItems record component