A B C D E F G H I K L M N O P R S T U V

A

AbstractInvokeListener - Class in com.sk89q.intake.parametric.handler

An abstract implementation of InvokeListener with some no-operation methods implemented to assist in creating subclasses.

AbstractInvokeListener() - Constructor for class com.sk89q.intake.parametric.handler.AbstractInvokeListener

AbstractModule - Class in com.sk89q.intake.parametric

Modules should extend this class and call the bind() functions to add bindings.

AbstractModule() - Constructor for class com.sk89q.intake.parametric.AbstractModule

AbstractParametricCallable - Class in com.sk89q.intake.parametric

A base class for commands that use ArgumentParser.

AbstractParametricCallable(ParametricBuilder, ArgumentParser) - Constructor for class com.sk89q.intake.parametric.AbstractParametricCallable

Create a new instance.

addExceptionConverter(ExceptionConverter) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Attach an exception converter to this builder in order to wrap unknown Throwables into known CommandExceptions.

addInvokeListener(InvokeListener) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Attach an invocation listener.

addParameter(Type) - Method in class com.sk89q.intake.parametric.ArgumentParser.Builder

Add a parameter to parse.

addParameter(Type, List<? extends Annotation>) - Method in class com.sk89q.intake.parametric.ArgumentParser.Builder

Add a parameter to parse.

annotatedWith(Class<? extends Annotation>) - Method in interface com.sk89q.intake.parametric.binder.BindingBuilder

Indicates a classifier that the binding will listen for.

argsLength() - Method in class com.sk89q.intake.argument.CommandContext

ArgumentException - Exception in com.sk89q.intake.argument

Argument exceptions occur when there is a problem with user-provided arguments, whether it be because of incorrect arguments, missing arguments, or excess arguments.

ArgumentException() - Constructor for exception com.sk89q.intake.argument.ArgumentException

ArgumentException(String) - Constructor for exception com.sk89q.intake.argument.ArgumentException

ArgumentException(String, Throwable) - Constructor for exception com.sk89q.intake.argument.ArgumentException

ArgumentException(Throwable) - Constructor for exception com.sk89q.intake.argument.ArgumentException

ArgumentParseException - Exception in com.sk89q.intake.argument

Thrown when an argument has been provided that is incorrect.

ArgumentParseException(String) - Constructor for exception com.sk89q.intake.argument.ArgumentParseException

ArgumentParseException(String, Parameter) - Constructor for exception com.sk89q.intake.argument.ArgumentParseException

ArgumentParseException(String, Throwable) - Constructor for exception com.sk89q.intake.argument.ArgumentParseException

ArgumentParseException(String, Throwable, Parameter) - Constructor for exception com.sk89q.intake.argument.ArgumentParseException

ArgumentParser - Class in com.sk89q.intake.parametric

An argument parser takes in a list of tokenized arguments and parses them, converting them into appropriate Java objects using a provided Injector.

ArgumentParser.Builder - Class in com.sk89q.intake.parametric

Builds instances of ArgumentParser.

Arguments - Class in com.sk89q.intake.argument

Builds instances of CommandArgs.

AuthorizationException - Exception in com.sk89q.intake.util.auth

Thrown when not enough permissions are satisfied.

AuthorizationException() - Constructor for exception com.sk89q.intake.util.auth.AuthorizationException

AuthorizationException(String) - Constructor for exception com.sk89q.intake.util.auth.AuthorizationException

AuthorizationException(String, Throwable) - Constructor for exception com.sk89q.intake.util.auth.AuthorizationException

AuthorizationException(Throwable) - Constructor for exception com.sk89q.intake.util.auth.AuthorizationException

Authorizer - Interface in com.sk89q.intake.util.auth

Tests whether permission is granted.

B

bind(Class<T>) - Method in class com.sk89q.intake.parametric.AbstractModule

bind(Key<T>) - Method in class com.sk89q.intake.parametric.AbstractModule

bind(Class<T>) - Method in interface com.sk89q.intake.parametric.binder.Binder

Start a binding with a class type.

bind(Key<T>) - Method in interface com.sk89q.intake.parametric.binder.Binder

Start a binding with a key.

Binder - Interface in com.sk89q.intake.parametric.binder

A binder is a fluent interface for creating bindings.

Binding<T> - Interface in com.sk89q.intake.parametric

Maps a Provider to a type.

BindingBuilder<T> - Interface in com.sk89q.intake.parametric.binder

Part of the fluent binding creation interface.

build() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Build an instance of the description.

build() - Method in class com.sk89q.intake.ImmutableParameter.Builder

Create an instance.

build() - Method in class com.sk89q.intake.parametric.ArgumentParser.Builder

Create a new argument parser.

builder(ParametricBuilder) - Method in class com.sk89q.intake.fluent.CommandGraph

Set the ParametricBuilder used for calls to DispatcherNode.registerMethods(Object).

Builder() - Constructor for class com.sk89q.intake.ImmutableDescription.Builder

Builder() - Constructor for class com.sk89q.intake.ImmutableParameter.Builder

Builder(Injector) - Constructor for class com.sk89q.intake.parametric.ArgumentParser.Builder

Create a new instance.

C

call(String, Namespace, List<String>) - Method in interface com.sk89q.intake.CommandCallable

Execute the command.

call(String, Namespace, List<String>) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

call(String, Namespace, List<String>) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

call(Object[]) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Called with parsed arguments to execute the command.

checkPermission(String) - Method in interface com.sk89q.intake.util.auth.Subject

Check whether this subject has been granted the given permission and throw an exception on error.

Classifier - Annotation Type in com.sk89q.intake.parametric.annotation

Marks other annotations as a "classifier."

com.sk89q.intake - package com.sk89q.intake

com.sk89q.intake.argument - package com.sk89q.intake.argument

com.sk89q.intake.completion - package com.sk89q.intake.completion

com.sk89q.intake.dispatcher - package com.sk89q.intake.dispatcher

com.sk89q.intake.fluent - package com.sk89q.intake.fluent

com.sk89q.intake.internal.parametric - package com.sk89q.intake.internal.parametric

com.sk89q.intake.parametric - package com.sk89q.intake.parametric

com.sk89q.intake.parametric.annotation - package com.sk89q.intake.parametric.annotation

com.sk89q.intake.parametric.binder - package com.sk89q.intake.parametric.binder

com.sk89q.intake.parametric.handler - package com.sk89q.intake.parametric.handler

com.sk89q.intake.parametric.provider - package com.sk89q.intake.parametric.provider

com.sk89q.intake.util - package com.sk89q.intake.util

com.sk89q.intake.util.auth - package com.sk89q.intake.util.auth

Command - Annotation Type in com.sk89q.intake

Annotates a method that is to be registered as a command.

CommandArgs - Interface in com.sk89q.intake.argument

Provides access to provided user arguments as a stack.

CommandCallable - Interface in com.sk89q.intake

A command that can be executed.

CommandCompleter - Interface in com.sk89q.intake.completion

Provides a method that can provide tab completion for commands.

CommandContext - Class in com.sk89q.intake.argument

CommandContext(String) - Constructor for class com.sk89q.intake.argument.CommandContext

CommandContext(String[]) - Constructor for class com.sk89q.intake.argument.CommandContext

CommandContext(String, Set<Character>) - Constructor for class com.sk89q.intake.argument.CommandContext

CommandContext(String, Set<Character>, boolean) - Constructor for class com.sk89q.intake.argument.CommandContext

CommandContext(String[], Set<Character>) - Constructor for class com.sk89q.intake.argument.CommandContext

CommandContext(String[], Set<Character>, boolean, Namespace) - Constructor for class com.sk89q.intake.argument.CommandContext

Parse the given array of arguments.

CommandException - Exception in com.sk89q.intake

Thrown when an executed command raises an error or when execution of the command failed.

CommandException() - Constructor for exception com.sk89q.intake.CommandException

CommandException(String) - Constructor for exception com.sk89q.intake.CommandException

CommandException(String, Throwable) - Constructor for exception com.sk89q.intake.CommandException

CommandException(Throwable) - Constructor for exception com.sk89q.intake.CommandException

CommandGraph - Class in com.sk89q.intake.fluent

A fluent interface to creating a command graph.

CommandGraph() - Constructor for class com.sk89q.intake.fluent.CommandGraph

Create a new command graph.

CommandMapping - Interface in com.sk89q.intake

Provides information about a mapping between a command and its aliases.

commands() - Method in class com.sk89q.intake.fluent.CommandGraph

Get the root dispatcher node.

compare(CommandMapping, CommandMapping) - Method in class com.sk89q.intake.util.PrimaryAliasComparator

compareTo(Key<?>) - Method in class com.sk89q.intake.parametric.Key

configure(Binder) - Method in class com.sk89q.intake.parametric.AbstractModule

configure() - Method in class com.sk89q.intake.parametric.AbstractModule

configure(Binder) - Method in interface com.sk89q.intake.parametric.Module

configure() - Method in class com.sk89q.intake.parametric.provider.PrimitivesModule

contains(String) - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Returns whether the dispatcher contains a registered command for the given alias.

contains(String) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

containsKey(Object) - Method in class com.sk89q.intake.argument.Namespace

Test whether the given key exists.

containsValue(Object) - Method in class com.sk89q.intake.argument.Namespace

Test whether the given value exists.

convert(Throwable) - Method in interface com.sk89q.intake.parametric.handler.ExceptionConverter

Attempt to convert the given throwable into a friendly CommandException.

convert(Throwable) - Method in class com.sk89q.intake.parametric.handler.ExceptionConverterHelper

copyOf(List<String>) - Static method in class com.sk89q.intake.argument.Arguments

Create an argument stack from a list of string arguments using an empty namespace.

copyOf(List<String>, Map<Character, String>) - Static method in class com.sk89q.intake.argument.Arguments

Create an argument stack from a list of string arguments.

copyOf(List<String>, Map<Character, String>, Namespace) - Static method in class com.sk89q.intake.argument.Arguments

Create an argument stack from a list of string arguments.

createInjector() - Static method in class com.sk89q.intake.Intake

Create a new injector.

createInvokeHandler() - Method in interface com.sk89q.intake.parametric.handler.InvokeListener

Create a new invocation handler.

createInvokeHandler() - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

D

Description - Interface in com.sk89q.intake

A description of a command, providing information on the command's parameters, a short description, a help text, and usage information.

Dispatcher - Interface in com.sk89q.intake.dispatcher

Executes a command based on user input.

DispatcherNode - Class in com.sk89q.intake.fluent

A collection of commands.

E

ExceptionConverter - Interface in com.sk89q.intake.parametric.handler

This class converts input Throwables into an appropriate CommandException, throwing InvocationCommandException if the exception cannot be converted into a friendlier exception.

ExceptionConverterHelper - Class in com.sk89q.intake.parametric.handler

An implementation of an ExceptionConverter that calls methods defined in subclasses that have been annotated with ExceptionMatch.

ExceptionConverterHelper() - Constructor for class com.sk89q.intake.parametric.handler.ExceptionConverterHelper

ExceptionMatch - Annotation Type in com.sk89q.intake.parametric.handler

Denotes a match of an exception.

F

flag(Character) - Static method in class com.sk89q.intake.argument.SuggestionContext

flag(Character) - Static method in class com.sk89q.intake.OptionType

Get the non-value boolean flag type of parameter.

forFlag() - Method in class com.sk89q.intake.argument.SuggestionContext

forHangingValue() - Method in class com.sk89q.intake.argument.SuggestionContext

forLastValue() - Method in class com.sk89q.intake.argument.SuggestionContext

G

get(Object) - Method in class com.sk89q.intake.argument.Namespace

Returns the value specified by the given key.

get(Class<T>) - Method in class com.sk89q.intake.argument.Namespace

Get an object whose key will be the object's class.

get(String) - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Get the CommandCallable associated with an alias.

get(String) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

get(Class<T>) - Static method in class com.sk89q.intake.parametric.Key

get(Class<T>, Class<? extends Annotation>) - Static method in class com.sk89q.intake.parametric.Key

get(Type) - Static method in class com.sk89q.intake.parametric.Key

get(Type, Class<? extends Annotation>) - Static method in class com.sk89q.intake.parametric.Key

get(CommandArgs, List<? extends Annotation>) - Method in interface com.sk89q.intake.parametric.Provider

Provide a value given the arguments.

getAliases() - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Get a list of all the command aliases, which includes the primary alias.

getAliases() - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

getAllAliases() - Method in interface com.sk89q.intake.CommandMapping

Get a list of all aliases.

getAllAliases() - Method in class com.sk89q.intake.ImmutableCommandMapping

getAuthorizer() - Method in class com.sk89q.intake.parametric.ParametricBuilder

Get the authorizer.

getBinding(Key<T>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getBinding(Class<T>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getBinding(Key<T>) - Method in interface com.sk89q.intake.parametric.Injector

Get the binding for the given key, if one exists.

getBinding(Class<T>) - Method in interface com.sk89q.intake.parametric.Injector

Get the binding for the given class, if one exists.

getBuilder() - Method in class com.sk89q.intake.fluent.CommandGraph

Get the ParametricBuilder.

getBuilder() - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Get the parametric builder.

getCallable() - Method in interface com.sk89q.intake.CommandMapping

Get the callable

getCallable() - Method in class com.sk89q.intake.ImmutableCommandMapping

getClassifier() - Method in class com.sk89q.intake.parametric.Key

getCommand() - Method in class com.sk89q.intake.argument.CommandContext

getCommand() - Method in exception com.sk89q.intake.InvalidUsageException

Get the command.

getCommandAnnotations() - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Get the annotations on the command.

getCommandExecutor() - Method in class com.sk89q.intake.parametric.ParametricBuilder

Get the executor service used to invoke the actual command.

getCommands() - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Get a list of commands.

getCommands() - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

getCommandUsed(String, String) - Method in exception com.sk89q.intake.CommandException

getDefaultCompleter() - Method in class com.sk89q.intake.parametric.ParametricBuilder

Get the default command suggestions provider that will be used if no suggestions are available.

getDefaultValue() - Method in class com.sk89q.intake.ImmutableParameter.Builder

Get the default value as a list of arguments.

getDefaultValue() - Method in class com.sk89q.intake.ImmutableParameter

getDefaultValue() - Method in interface com.sk89q.intake.Parameter

The default value as a list of tokenized strings (but one single value).

getDescription() - Method in interface com.sk89q.intake.CommandCallable

Get the object describing the command.

getDescription() - Method in interface com.sk89q.intake.CommandMapping

Get the Description form the callable.

getDescription() - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

getDescription() - Method in class com.sk89q.intake.ImmutableCommandMapping

getDispatcher() - Method in class com.sk89q.intake.fluent.CommandGraph

Get the root dispatcher.

getDispatcher() - Method in class com.sk89q.intake.fluent.DispatcherNode

Get the underlying dispatcher of this object.

getDouble(int) - Method in class com.sk89q.intake.argument.CommandContext

getDouble(int, double) - Method in class com.sk89q.intake.argument.CommandContext

getFlag(char) - Method in class com.sk89q.intake.argument.CommandContext

getFlag(char, String) - Method in class com.sk89q.intake.argument.CommandContext

getFlag() - Method in class com.sk89q.intake.argument.SuggestionContext

getFlag() - Method in class com.sk89q.intake.OptionType

Get the flag associated with this parameter.

getFlagDouble(char) - Method in class com.sk89q.intake.argument.CommandContext

getFlagDouble(char, double) - Method in class com.sk89q.intake.argument.CommandContext

getFlagInteger(char) - Method in class com.sk89q.intake.argument.CommandContext

getFlagInteger(char, int) - Method in class com.sk89q.intake.argument.CommandContext

getFlags() - Method in interface com.sk89q.intake.argument.CommandArgs

Get a map of defined flags.

getFlags() - Method in class com.sk89q.intake.argument.CommandContext

getFlagsMap() - Method in class com.sk89q.intake.argument.CommandContext

getGroups() - Method in interface com.sk89q.intake.util.auth.Subject

Get a list of groups that this subject is a part of.

getHelp() - Method in interface com.sk89q.intake.Description

Get a longer help text about this command.

getHelp() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Get the help text.

getHelp() - Method in class com.sk89q.intake.ImmutableDescription

getInjector() - Method in class com.sk89q.intake.parametric.ParametricBuilder

getInstance(Key<T>, CommandArgs, List<? extends Annotation>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getInstance(Class<T>, CommandArgs, List<? extends Annotation>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getInstance(Key<T>, CommandArgs, List<? extends Annotation>) - Method in interface com.sk89q.intake.parametric.Injector

Attempt to provide a value for the given key using the given arguments.

getInstance(Class<T>, CommandArgs, List<? extends Annotation>) - Method in interface com.sk89q.intake.parametric.Injector

Attempt to provide a value for the given class using the given arguments.

getInteger(int) - Method in class com.sk89q.intake.argument.CommandContext

getInteger(int, int) - Method in class com.sk89q.intake.argument.CommandContext

getJoinedStrings(int) - Method in class com.sk89q.intake.argument.CommandContext

getKey() - Method in interface com.sk89q.intake.parametric.Binding

Get the key representing the type.

getName() - Method in class com.sk89q.intake.ImmutableParameter.Builder

Get the name of the parameter.

getName() - Method in class com.sk89q.intake.ImmutableParameter

getName() - Method in interface com.sk89q.intake.Parameter

The name of the parameter.

getNamespace() - Method in interface com.sk89q.intake.argument.CommandArgs

Get the map of provided values.

getNamespace() - Method in class com.sk89q.intake.argument.CommandContext

getOptionType() - Method in class com.sk89q.intake.ImmutableParameter.Builder

Get the type of parameter.

getOptionType() - Method in class com.sk89q.intake.ImmutableParameter

getOptionType() - Method in interface com.sk89q.intake.Parameter

The type of parameter.

getPaddedSlice(int, int) - Method in class com.sk89q.intake.argument.CommandContext

getParameter() - Method in exception com.sk89q.intake.argument.ArgumentParseException

getParameter() - Method in exception com.sk89q.intake.argument.MissingArgumentException

getParameters() - Method in interface com.sk89q.intake.Description

Get the list of parameters for this command.

getParameters() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Get the list of parameters.

getParameters() - Method in class com.sk89q.intake.ImmutableDescription

getParsedPaddedSlice(int, int) - Method in class com.sk89q.intake.argument.CommandContext

getParsedSlice(int) - Method in class com.sk89q.intake.argument.CommandContext

getParser() - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Get the argument parser.

getPermissions() - Method in interface com.sk89q.intake.Description

Get a list of permissions that the player may have to have permission.

getPermissions() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Get a list of permissions.

getPermissions() - Method in class com.sk89q.intake.ImmutableDescription

getPrimaryAlias() - Method in interface com.sk89q.intake.CommandMapping

Get the primary alias.

getPrimaryAlias() - Method in class com.sk89q.intake.ImmutableCommandMapping

getPrimaryAliases() - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Get a list of primary aliases.

getPrimaryAliases() - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

getProvider(Key<T>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getProvider(Class<T>) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

getProvider() - Method in interface com.sk89q.intake.parametric.Binding

Get the provider

getProvider(Key<T>) - Method in interface com.sk89q.intake.parametric.Injector

Get the provider for the given key, if one exists.

getProvider(Class<T>) - Method in interface com.sk89q.intake.parametric.Injector

Get the provider for the given class, if one exists.

getRemainingString(int) - Method in class com.sk89q.intake.argument.CommandContext

getShortDescription() - Method in interface com.sk89q.intake.Description

Get a short one-line description of this command.

getShortDescription() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Get the short description.

getShortDescription() - Method in class com.sk89q.intake.ImmutableDescription

getSimpleUsageString(String) - Method in exception com.sk89q.intake.InvalidUsageException

Get a simple usage string.

getSlice(int) - Method in class com.sk89q.intake.argument.CommandContext

getString(int) - Method in class com.sk89q.intake.argument.CommandContext

getString(int, String) - Method in class com.sk89q.intake.argument.CommandContext

getString(int, int) - Method in class com.sk89q.intake.argument.CommandContext

getSuggestionContext() - Method in class com.sk89q.intake.argument.CommandContext

getSuggestions(String, Namespace) - Method in interface com.sk89q.intake.completion.CommandCompleter

Get a list of suggestions based on input.

getSuggestions(String, Namespace) - Method in class com.sk89q.intake.completion.NullCompleter

getSuggestions(String, Namespace) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

getSuggestions(String, Namespace) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

getSuggestions(String) - Method in interface com.sk89q.intake.parametric.Provider

Get a list of suggestions for the given parameter and user arguments.

getType() - Method in class com.sk89q.intake.parametric.Key

getUnconsumed() - Method in exception com.sk89q.intake.argument.UnusedArgumentException

Get the unconsumed arguments.

getUnusedFlags() - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Get a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.

getUsage() - Method in interface com.sk89q.intake.Description

Get the usage string of this command.

getUsage() - Method in class com.sk89q.intake.ImmutableDescription

getUsageOverride() - Method in class com.sk89q.intake.ImmutableDescription.Builder

Get the usage override string.

getUserParameters() - Method in class com.sk89q.intake.parametric.ArgumentParser

Get a list of parameters that are user-provided and not provided.

getValueFlags() - Method in class com.sk89q.intake.argument.CommandContext

getValueFlags() - Method in class com.sk89q.intake.parametric.ArgumentParser

Get a list of value flags that have been requested by the parameters.

graph() - Method in class com.sk89q.intake.fluent.DispatcherNode

Get the root command graph.

group(String...) - Method in class com.sk89q.intake.fluent.DispatcherNode

Create a new command that will contain sub-commands.

H

hangingValue() - Static method in class com.sk89q.intake.argument.SuggestionContext

hasFlag(char) - Method in class com.sk89q.intake.argument.CommandContext

hasNext() - Method in interface com.sk89q.intake.argument.CommandArgs

Tests whether there are additional arguments that can be read.

hasPermission(String) - Method in interface com.sk89q.intake.util.auth.Subject

Return whether this subject has the given permission.

I

IllegalParameterException - Exception in com.sk89q.intake.parametric

Thrown if there is an error with a parameter.

IllegalParameterException() - Constructor for exception com.sk89q.intake.parametric.IllegalParameterException

IllegalParameterException(String, Throwable) - Constructor for exception com.sk89q.intake.parametric.IllegalParameterException

IllegalParameterException(String) - Constructor for exception com.sk89q.intake.parametric.IllegalParameterException

IllegalParameterException(Throwable) - Constructor for exception com.sk89q.intake.parametric.IllegalParameterException

ImmutableCommandMapping - Class in com.sk89q.intake

An immutable command mapping instance.

ImmutableCommandMapping(CommandCallable, String...) - Constructor for class com.sk89q.intake.ImmutableCommandMapping

Create a new instance.

ImmutableDescription - Class in com.sk89q.intake

An immutable implementation of a Description.

ImmutableDescription.Builder - Class in com.sk89q.intake

Builds instances of ImmutableDescription.

ImmutableParameter - Class in com.sk89q.intake

An immutable implementation of Parameter.

ImmutableParameter.Builder - Class in com.sk89q.intake

Creates instances of ImmutableParameter.

Injector - Interface in com.sk89q.intake.parametric

An injector knows a list of "bindings" that map types to a provider.

install(Module) - Method in class com.sk89q.intake.internal.parametric.InternalInjector

install(Module) - Method in interface com.sk89q.intake.parametric.Injector

Install a module into the injector.

INSTANCE - Static variable in class com.sk89q.intake.util.PrimaryAliasComparator

An instance of this class.

Intake - Class in com.sk89q.intake

The starting point to using parts of Intake.

InternalInjector - Class in com.sk89q.intake.internal.parametric

InternalInjector() - Constructor for class com.sk89q.intake.internal.parametric.InternalInjector

InvalidUsageException - Exception in com.sk89q.intake

Thrown when a command is not used properly.

InvalidUsageException(CommandCallable) - Constructor for exception com.sk89q.intake.InvalidUsageException

Create a new instance with no error message and with no suggestion that full and complete help for the command should be shown.

InvalidUsageException(String, CommandCallable) - Constructor for exception com.sk89q.intake.InvalidUsageException

Create a new instance with a message and with no suggestion that full and complete help for the command should be shown.

InvalidUsageException(String, CommandCallable, boolean) - Constructor for exception com.sk89q.intake.InvalidUsageException

Create a new instance with a message.

InvocationCommandException - Exception in com.sk89q.intake

Thrown when invocation of a command fails, wrapping the exception that is thrown.

InvocationCommandException(Throwable) - Constructor for exception com.sk89q.intake.InvocationCommandException

InvocationCommandException(String, Throwable) - Constructor for exception com.sk89q.intake.InvocationCommandException

InvokeHandler - Interface in com.sk89q.intake.parametric.handler

An invoke handler can be registered on a ParametricBuilder to listen in on commands being executed.

InvokeListener - Interface in com.sk89q.intake.parametric.handler

Listens to events related to ParametricBuilder.

isFullHelpSuggested() - Method in exception com.sk89q.intake.InvalidUsageException

Return whether the full usage of the command should be shown.

isIgnoreUnusedFlags() - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Get whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.

isOptional() - Method in class com.sk89q.intake.OptionType

Get whether this parameter is optional.

isProvided() - Method in interface com.sk89q.intake.parametric.Provider

Gets whether this provider does not actually consume values from the argument stack and instead generates them otherwise.

isValueFlag() - Method in class com.sk89q.intake.OptionType

Return whether the flag is a value flag.

K

Key<T> - Class in com.sk89q.intake.parametric

Represents a parameter that a binding can provide a value for.

L

lastValue() - Static method in class com.sk89q.intake.argument.SuggestionContext

LegacyCommandsHandler - Class in com.sk89q.intake.parametric.handler

Handles legacy properties on Command such as Command.min() and Command.max().

LegacyCommandsHandler() - Constructor for class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

M

markConsumed() - Method in interface com.sk89q.intake.argument.CommandArgs

Move the pointer to the end so that there are no unconsumed arguments.

matches(String) - Method in class com.sk89q.intake.argument.CommandContext

matches(Key<T>) - Method in class com.sk89q.intake.parametric.Key

MissingArgumentException - Exception in com.sk89q.intake.argument

Thrown when the user has not provided a sufficient number of arguments, which may include positional arguments and/or flag arguments.

MissingArgumentException() - Constructor for exception com.sk89q.intake.argument.MissingArgumentException

MissingArgumentException(Parameter) - Constructor for exception com.sk89q.intake.argument.MissingArgumentException

MissingArgumentException(Throwable, Parameter) - Constructor for exception com.sk89q.intake.argument.MissingArgumentException

Module - Interface in com.sk89q.intake.parametric

N

Namespace - Class in com.sk89q.intake.argument

This object holds contextual data for a command execution.

Namespace() - Constructor for class com.sk89q.intake.argument.Namespace

next() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument.

nextBoolean() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as a boolean.

nextByte() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as a byte.

nextDouble() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as a double.

nextFloat() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as a float.

nextInt() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as an integer.

nextShort() - Method in interface com.sk89q.intake.argument.CommandArgs

Read the next argument as a short.

NullAuthorizer - Class in com.sk89q.intake.util.auth

An implementation of Authorizer that always returns false for tests of permissions.

NullAuthorizer() - Constructor for class com.sk89q.intake.util.auth.NullAuthorizer

NullCompleter - Class in com.sk89q.intake.completion

Always returns an empty list of suggestions.

NullCompleter() - Constructor for class com.sk89q.intake.completion.NullCompleter

O

of(String...) - Static method in class com.sk89q.intake.argument.Arguments

Create an argument stack from a list of string arguments using an empty namespace.

Optional - Annotation Type in com.sk89q.intake.parametric.annotation

Indicates an optional parameter.

optionalPositional() - Static method in class com.sk89q.intake.OptionType

Get the optional positional type of parameter.

OptionType - Class in com.sk89q.intake

Defines the type of parameter, whether it is positional, a flag, optional, or required.

P

Parameter - Interface in com.sk89q.intake

Defines a parameter for a command.

ParametricBuilder - Class in com.sk89q.intake.parametric

Keeps a mapping of types to bindings and generates commands from classes with appropriate annotations.

ParametricBuilder(Injector) - Constructor for class com.sk89q.intake.parametric.ParametricBuilder

ParametricException - Exception in com.sk89q.intake.parametric

Thrown if the ParametricBuilder can't build commands from an object for whatever reason.

ParametricException() - Constructor for exception com.sk89q.intake.parametric.ParametricException

ParametricException(String, Throwable) - Constructor for exception com.sk89q.intake.parametric.ParametricException

ParametricException(String) - Constructor for exception com.sk89q.intake.parametric.ParametricException

ParametricException(Throwable) - Constructor for exception com.sk89q.intake.parametric.ParametricException

parent() - Method in class com.sk89q.intake.fluent.DispatcherNode

Return the parent node.

parseArguments(CommandArgs) - Method in class com.sk89q.intake.parametric.ArgumentParser

Parse the given arguments into Java objects.

parseArguments(CommandArgs, boolean, Set<Character>) - Method in class com.sk89q.intake.parametric.ArgumentParser

Parse the given arguments into Java objects.

peek() - Method in interface com.sk89q.intake.argument.CommandArgs

Return the next argument without moving the pointer.

position() - Method in interface com.sk89q.intake.argument.CommandArgs

Get the current position of the pointer in the stack of arguments.

positional() - Static method in class com.sk89q.intake.OptionType

Get the required positional type of parameter.

postInvoke(List<? extends Annotation>, ArgumentParser, Object[], CommandArgs) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called after the command has been executed.

postInvoke(List<? extends Annotation>, ArgumentParser, Object[], CommandArgs) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

preInvoke(List<? extends Annotation>, ArgumentParser, Object[], CommandArgs) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called after arguments have been parsed but the command has yet to be executed.

preInvoke(List<? extends Annotation>, ArgumentParser, Object[], CommandArgs) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

prependStack(String) - Method in exception com.sk89q.intake.CommandException

preProcess(List<? extends Annotation>, ArgumentParser, CommandArgs) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called before arguments have been parsed.

preProcess(List<? extends Annotation>, ArgumentParser, CommandArgs) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

PrimaryAliasComparator - Class in com.sk89q.intake.util

Compares the primary aliases of two CommandMapping using String.compareTo(String).

PrimaryAliasComparator(Pattern) - Constructor for class com.sk89q.intake.util.PrimaryAliasComparator

Create a new instance.

PrimitivesModule - Class in com.sk89q.intake.parametric.provider

Provides values for primitives as well as Strings.

PrimitivesModule() - Constructor for class com.sk89q.intake.parametric.provider.PrimitivesModule

Provider<T> - Interface in com.sk89q.intake.parametric

An object that provides instances given a key and some arguments.

ProvisionException - Exception in com.sk89q.intake.parametric

Thrown when the value for a parameter cannot be provisioned due to errors that are not related to the parsing of user-provided arguments.

ProvisionException() - Constructor for exception com.sk89q.intake.parametric.ProvisionException

ProvisionException(String) - Constructor for exception com.sk89q.intake.parametric.ProvisionException

ProvisionException(String, Throwable) - Constructor for exception com.sk89q.intake.parametric.ProvisionException

ProvisionException(Throwable) - Constructor for exception com.sk89q.intake.parametric.ProvisionException

put(Object, Object) - Method in class com.sk89q.intake.argument.Namespace

Set an contextual value.

R

Range - Annotation Type in com.sk89q.intake.parametric.annotation

Specifies a range of values for numbers.

register(CommandCallable, String...) - Method in class com.sk89q.intake.fluent.DispatcherNode

Register a command with this dispatcher.

registerCommand(CommandCallable, String...) - Method in interface com.sk89q.intake.dispatcher.Dispatcher

Register a command with this dispatcher.

registerCommand(CommandCallable, String...) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

registerMethods(Object) - Method in class com.sk89q.intake.fluent.DispatcherNode

Build and register a command with this dispatcher using the ParametricBuilder assigned on the root CommandGraph.

registerMethodsAsCommands(Dispatcher, Object) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Build a list of commands from methods specially annotated with Command (and other relevant annotations) and register them all with the given Dispatcher.

Require - Annotation Type in com.sk89q.intake

Annotates a method that requires a permission check to be satisfied before it can be executed by the caller.

S

setAuthorizer(Authorizer) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Set the authorizer.

setClassifier(Class<? extends Annotation>) - Method in class com.sk89q.intake.parametric.Key

setCommandAnnotations(List<? extends Annotation>) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Set the annotations on the command.

setCommandExecutor(ExecutorService) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Set the executor service used to invoke the actual command.

setDefaultCompleter(CommandCompleter) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Set the default command suggestions provider that will be used if no suggestions are available.

setDefaultValue(List<String>) - Method in class com.sk89q.intake.ImmutableParameter.Builder

Set the default value as a list of arguments.

setHelp(String) - Method in class com.sk89q.intake.ImmutableDescription.Builder

Set the help text.

setIgnoreUnusedFlags(boolean) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Set whether flags that are not used by any parameter should be ignored so that an UnusedArgumentException is not thrown.

setName(String) - Method in class com.sk89q.intake.ImmutableParameter.Builder

Set the name of the parameter.

setOptionType(OptionType) - Method in class com.sk89q.intake.ImmutableParameter.Builder

Set the type of parameter.

setParameters(List<Parameter>) - Method in class com.sk89q.intake.ImmutableDescription.Builder

Set the list of parameters.

setPermissions(List<String>) - Method in class com.sk89q.intake.ImmutableDescription.Builder

Set the list of permissions.

setShortDescription(String) - Method in class com.sk89q.intake.ImmutableDescription.Builder

Set the short description.

setUnusedFlags(Set<Character>) - Method in class com.sk89q.intake.parametric.AbstractParametricCallable

Set a list of flags that should not cause an UnusedArgumentException to be thrown if they are not consumed by a parameter.

setUsageOverride(String) - Method in class com.sk89q.intake.ImmutableDescription.Builder

Set the usage override string.

SimpleDispatcher - Class in com.sk89q.intake.dispatcher

A simple implementation of Dispatcher.

SimpleDispatcher() - Constructor for class com.sk89q.intake.dispatcher.SimpleDispatcher

Create a new instance.

size() - Method in interface com.sk89q.intake.argument.CommandArgs

Return the number of arguments in total.

split(String) - Static method in class com.sk89q.intake.argument.CommandContext

Subject - Interface in com.sk89q.intake.util.auth

A subject has authorization attached to it.

SuggestionContext - Class in com.sk89q.intake.argument

Switch - Annotation Type in com.sk89q.intake.parametric.annotation

Indicates a command flag, such as /command -f.

T

testPermission(Namespace) - Method in interface com.sk89q.intake.CommandCallable

Test whether the user is permitted to use the command.

testPermission(Namespace) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

testPermission(Namespace, String) - Method in interface com.sk89q.intake.util.auth.Authorizer

Tests whether permission is granted for the given context.

testPermission(Namespace, String) - Method in class com.sk89q.intake.util.auth.NullAuthorizer

Text - Annotation Type in com.sk89q.intake.parametric.annotation

Indicates a String parameter will use up all remaining arguments.

toInstance(T) - Method in interface com.sk89q.intake.parametric.binder.BindingBuilder

Creates a binding that is provided by the given static instance.

toProvider(Provider<T>) - Method in interface com.sk89q.intake.parametric.binder.BindingBuilder

Creates a binding that is provided by the given provider class.

toString() - Method in class com.sk89q.intake.argument.SuggestionContext

toString() - Method in class com.sk89q.intake.ImmutableCommandMapping

toString() - Method in class com.sk89q.intake.ImmutableDescription

toString() - Method in class com.sk89q.intake.parametric.Key

transform(CommandArgs) - Method in class com.sk89q.intake.OptionType

Create a new list of command arguments for the given arguments that is appropriate for this type of parameter.

U

UnusedArgumentException - Exception in com.sk89q.intake.argument

Thrown when there are unused arguments because the user has provided excess arguments.

UnusedArgumentException(String) - Constructor for exception com.sk89q.intake.argument.UnusedArgumentException

Create a new instance with the unconsumed argument data.

updateDescription(Set<Annotation>, ArgumentParser, ImmutableDescription.Builder) - Method in class com.sk89q.intake.parametric.handler.AbstractInvokeListener

updateDescription(Set<Annotation>, ArgumentParser, ImmutableDescription.Builder) - Method in interface com.sk89q.intake.parametric.handler.InvokeListener

Called to update the description of a command.

updateDescription(Set<Annotation>, ArgumentParser, ImmutableDescription.Builder) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

V

Validate - Annotation Type in com.sk89q.intake.parametric.annotation

Used to validate a string.

valueFlag(Character) - Static method in class com.sk89q.intake.OptionType

Get the value flag type of parameter.

viewOf(CommandContext) - Static method in class com.sk89q.intake.argument.Arguments

Create an argument stack from a CommandContext.

A B C D E F G H I K L M N O P R S T U V