revxrsal.commands.exception

Class InvalidHelpPageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

revxrsal.commands.exception.InvalidHelpPageException

All Implemented Interfaces:

java.io.Serializable

public class InvalidHelpPageException
extends java.lang.RuntimeException

Thrown when an invalid page is passed to Help.CommandList.paginate(int, int)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidHelpPageException(java.util.List<ExecutableCommand<A>> commands, int page, int elementsPerPage, int numberOfPages)

Method Summary

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

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidHelpPageException

public InvalidHelpPageException(java.util.List<ExecutableCommand<A>> commands,
                                int page,
                                int elementsPerPage,
                                int numberOfPages)

Method Detail

elementsPerPage

public int elementsPerPage()

Returns the elements to include in each page

Returns:

The elements to include in each page

page

public int page()

Returns the page number

Returns:

The page number

numberOfPages

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

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

Returns:

The number of pages

commands

@NotNull
public <A extends CommandActor> @NotNull @Unmodifiable java.util.List<ExecutableCommand<A>> commands()

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