revxrsal.commands.help

Interface Help.CommandList<A extends CommandActor>

Type Parameters:

A - The actor type

All Superinterfaces:

java.lang.Iterable<ExecutableCommand<A>>

All Known Subinterfaces:

Help.ChildrenCommands<A>, Help.RelatedCommands<A>, Help.SiblingCommands<A>

Enclosing interface:

Help

public static interface Help.CommandList<A extends CommandActor>
extends java.lang.Iterable<ExecutableCommand<A>>

Represents a generic list of ExecutableCommands that can be split into pages

Method Summary

Modifier and Type	Method and Description
@Unmodifiable java.util.List<ExecutableCommand<A>>	all() Returns all the commands that belong to this list.
@Range(from=1L,to=2147483647L) int	numberOfPages(@Range(from=1L,to=2147483647L) int elementsPerPage) Returns the number of pages this list would generate if it were to be split pages where each page contains elementsPerPage elements.
@Unmodifiable java.util.List<ExecutableCommand<A>>	paginate(@Range(from=1L,to=2147483647L) int pageNumber, @Range(from=1L,to=2147483647L) int elementsPerPage) Returns the list of commands that belong to a specific page after paginating this list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

all

@Unmodifiable java.util.List<ExecutableCommand<A>> all()

Returns all the commands that belong to this list. This does not respect pages.

Note that the returned list is immutable.

Returns:

All the commands

numberOfPages

@Range(from=1L,to=2147483647L) int numberOfPages(@Range(from=1L,to=2147483647L) int elementsPerPage)

Returns the number of pages this list would generate if it were to be split pages where each page contains elementsPerPage elements.

Parameters:

elementsPerPage - Maximum number of elements to include in each page. Note that the last page may contain less than this number (it will be the remainder)

Returns:

The number of pages

paginate

@Unmodifiable java.util.List<ExecutableCommand<A>> paginate(@Range(from=1L,to=2147483647L) int pageNumber,
                                                            @Range(from=1L,to=2147483647L) int elementsPerPage)
                                                     throws InvalidHelpPageException

Returns the list of commands that belong to a specific page after paginating this list.

Note that the list returned by this method is immutable.

Parameters:

pageNumber - The page number

elementsPerPage - The elements to include in each page

Returns:

The pages list.

Throws:

InvalidHelpPageException - if pageNumber is greater than numberOfPages(int) or less than 1