Class PaginatedResult<T>

java.lang.Object
com.sk89q.commandbook.util.PaginatedResult<T>

public abstract class PaginatedResult<T>
extends java.lang.Object
Commands that wish to display a paginated list of results can use this class to do the actual pagination, giving a list of items, a page number, and basic formatting information.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected static int PER_PAGE  
  • Constructor Summary

    Constructors 
    Constructor Description
    PaginatedResult​(java.lang.String header)  
  • Method Summary

    Modifier and Type Method Description
    void display​(org.bukkit.command.CommandSender sender, java.util.Collection<? extends T> results, int page)  
    void display​(org.bukkit.command.CommandSender sender, java.util.List<? extends T> results, int page)  
    abstract java.lang.String format​(T entry)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

  • Method Details

    • display

      public void display​(org.bukkit.command.CommandSender sender, java.util.Collection<? extends T> results, int page) throws com.sk89q.minecraft.util.commands.CommandException
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • display

      public void display​(org.bukkit.command.CommandSender sender, java.util.List<? extends T> results, int page) throws com.sk89q.minecraft.util.commands.CommandException
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • format

      public abstract java.lang.String format​(T entry)