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

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

addBinding(Binding, Type...) - Method in class com.sk89q.intake.parametric.ParametricBuilder

Add a binding for a given type or classifier (annotation).

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.

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

ArgumentStack - Interface in com.sk89q.intake.parametric.argument

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

Constructs a new exception with null as its detail message.

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

Constructs a new exception with the specified detail message.

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

Constructs a new exception with the specified detail message and cause.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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

Tests whether permission is granted.

B

bind(ParameterData, ArgumentStack, boolean) - Method in interface com.sk89q.intake.parametric.binding.Binding

Attempt to consume values (if required) from the given ArgumentStack in order to instantiate an object for the given parameter.

bind(ParameterData, ArgumentStack, boolean) - Method in class com.sk89q.intake.parametric.binding.BindingHelper

Binding - Interface in com.sk89q.intake.parametric.binding

A binding injects instances of the parameters of methods (that are commands) that were converted into commands using an instance of ParametricBuilder.

BindingBehavior - Enum in com.sk89q.intake.parametric.binding

Determines the type of binding.

BindingHelper - Class in com.sk89q.intake.parametric.binding

A binding helper that uses the BindingMatch annotation to make writing bindings extremely easy.

BindingHelper() - Constructor for class com.sk89q.intake.parametric.binding.BindingHelper

Create a new instance.

BindingMatch - Annotation Type in com.sk89q.intake.parametric.binding

Denotes a match of a binding.

booleanFlags - Variable in class com.sk89q.intake.context.CommandContext

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

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

C

call(String, CommandLocals, String[]) - Method in interface com.sk89q.intake.CommandCallable

Execute the correct command based on the input.

call(String, CommandLocals, String[]) - Method in class com.sk89q.intake.dispatcher.SimpleDispatcher

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.

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

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

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

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

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

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

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

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

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

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

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.

command - Variable in class com.sk89q.intake.context.CommandContext

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

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

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

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

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

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

CommandContext(String[], Set<Character>, boolean, CommandLocals) - Constructor for class com.sk89q.intake.context.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

Constructs a new exception with null as its detail message.

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

Constructs a new exception with the specified detail message.

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

Constructs a new exception with the specified detail message and cause.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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.

CommandLocals - Class in com.sk89q.intake.context

This object holds contextual data for a command execution.

CommandLocals() - Constructor for class com.sk89q.intake.context.CommandLocals

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

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.context.CommandLocals

Test whether the given key exists.

containsValue(Object) - Method in class com.sk89q.intake.context.CommandLocals

Test whether the given value exists.

ContextArgumentStack - Class in com.sk89q.intake.parametric.argument

Makes an instance of a CommandContext into a stack of arguments that can be consumed.

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

Create a new instance using the given context.

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

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

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

Set the description.

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.context.SuggestionContext

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

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

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

G

get(Object) - Method in class com.sk89q.intake.context.CommandLocals

Returns the value specified by the given key.

get(Class<T>) - Method in class com.sk89q.intake.context.CommandLocals

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

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.

getBehavior(ParameterData) - Method in interface com.sk89q.intake.parametric.binding.Binding

Get how this binding consumes from a ArgumentStack.

getBehavior(ParameterData) - Method in class com.sk89q.intake.parametric.binding.BindingHelper

getBinding() - Method in class com.sk89q.intake.parametric.ParameterData

Get the binding associated with this parameter.

getBoolean(ArgumentStack) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

Get the ParametricBuilder.

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

Get the classifier annotation.

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

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

Get the command.

getCommandContext(ArgumentStack) - Method in class com.sk89q.intake.parametric.binding.StandardBindings

Gets a CommandContext from a ArgumentStack.

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

Gets the command that was called, which will include the sub-command (i.e.

getConsumed() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Return the arguments that were consumed between this point and that marked point.

getConsumedCount(ParameterData) - Method in interface com.sk89q.intake.parametric.binding.Binding

Get the number of arguments that this binding will consume, if this information is available.

getConsumedCount(ParameterData) - Method in class com.sk89q.intake.parametric.binding.BindingHelper

getContext() - Method in interface com.sk89q.intake.parametric.argument.ArgumentStack

Get the underlying context.

getContext() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Get the underlying context.

getContext() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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 interface com.sk89q.intake.Parameter

Get the default value as a string to be parsed by the binding.

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

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

Get an object describing this 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.context.CommandContext

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

getDouble(ArgumentStack, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

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

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

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

Get the flag associated with this parameter.

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

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

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

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

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

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

getFloat(ArgumentStack, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

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

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

getInteger(ArgumentStack, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

getLevenshteinDistance(String, String) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Find the Levenshtein distance between two Strings.

getLocals() - Method in class com.sk89q.intake.context.CommandContext

getModifiers() - Method in class com.sk89q.intake.parametric.ParameterData

Get a list of modifier annotations.

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

The name of the parameter.

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

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

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

Get the list of parameters for this command.

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

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

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

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

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

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

getShort(ArgumentStack, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

Get a short one-line description of this command.

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

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

Get a simple usage string.

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

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

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

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

getString(ArgumentStack, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

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

Get a list of suggestions based on input.

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

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

getSuggestions(ParameterData, String) - Method in interface com.sk89q.intake.parametric.binding.Binding

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

getSuggestions(ParameterData, String) - Method in class com.sk89q.intake.parametric.binding.BindingHelper

getText(ArgumentStack, Text, Annotation[]) - Method in class com.sk89q.intake.parametric.binding.PrimitiveBindings

Gets a type from a ArgumentStack.

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

Set the main type of this parameter.

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

Get the types that this binding handles.

getTypes() - Method in class com.sk89q.intake.parametric.binding.BindingHelper

getUnconsumed() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Get the unconsumed arguments left over, without touching the stack.

getUnconsumed() - Method in exception com.sk89q.intake.parametric.UnconsumedParameterException

Get the unconsumed tokens.

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

Get the usage string of this command.

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

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

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.context.SuggestionContext

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

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

Return whether this subject has the given permission.

I

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.

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

An instance of this class.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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

Constructs a new exception with the specified detail message and cause.

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

Called before and after a command is invoked for commands executed by a command created with ParametricBuilder.

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.

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

Get whether this parameter is optional.

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

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

Return whether the flag is a value flag.

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

J

joinQuotedString(String[], String, int, String) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an array of strings into a string.

joinString(String[], String, int) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an array of strings into a string.

joinString(String[], String) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an array of strings into a string.

joinString(Object[], String, int) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an array of strings into a string.

joinString(int[], String, int) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an array of strings into a string.

joinString(Collection<?>, String, int) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Join an list of strings into a string.

L

lastValue() - Static method in class com.sk89q.intake.context.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

locals - Variable in class com.sk89q.intake.context.CommandContext

lookup(Map<String, T>, String, boolean) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

M

mark() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Mark the current position of the stack.

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

Set as completely consumed.

markConsumed() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

markConsumed() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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

MissingParameterException - Exception in com.sk89q.intake.parametric

Thrown when there is a missing parameter.

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

N

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

Get the next string, which may come from the stack or a value flag.

next() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

next() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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

Get the next boolean, which may come from the stack or a value flag.

nextBoolean() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

nextBoolean() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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

Get the next double, which may come from the stack or a value flag.

nextDouble() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

nextDouble() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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

Get the next integer, which may come from the stack or a value flag.

nextInt() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

nextInt() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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

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

Indicates an optional parameter.

originalArgIndices - Variable in class com.sk89q.intake.context.CommandContext

originalArgs - Variable in class com.sk89q.intake.context.CommandContext

overrideUsage(String) - Method in class com.sk89q.intake.SettableDescription

Override the usage string returned with a given one.

P

Parameter - Interface in com.sk89q.intake

Describes a parameter utilized by a command.

ParameterData - Class in com.sk89q.intake.parametric

Describes a parameter in detail.

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

ParameterException - Exception in com.sk89q.intake.parametric

Thrown if there is an error with a parameter.

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

Constructs a new exception with null as its detail message.

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

Constructs a new exception with the specified detail message.

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

Constructs a new exception with the specified detail message and cause.

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

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

ParametricBuilder - Class in com.sk89q.intake.parametric

Creates CommandCallables from methods in an object that have been annotated with Command.

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

Create a new builder.

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.

parsedArgs - Variable in class com.sk89q.intake.context.CommandContext

position() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Return the current position.

postInvoke(Object, Method, ParameterData[], Object[], CommandContext, CommandLocals) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called after the parameter is invoked.

postInvoke(Object, Method, ParameterData[], Object[], CommandContext, CommandLocals) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

preInvoke(Object, Method, ParameterData[], Object[], CommandContext, CommandLocals) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called before the parameter is invoked.

preInvoke(Object, Method, ParameterData[], Object[], CommandContext, CommandLocals) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

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

Add the command to the stack of commands that are a parent to the command that was called.

preProcess(Object, Method, ParameterData[], CommandContext, CommandLocals) - Method in interface com.sk89q.intake.parametric.handler.InvokeHandler

Called before parameters are processed.

preProcess(Object, Method, ParameterData[], CommandContext, CommandLocals) - 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.

PrimitiveBindings - Class in com.sk89q.intake.parametric.binding

Handles basic Java types such as Strings, Bytes, etc.

PrimitiveBindings() - Constructor for class com.sk89q.intake.parametric.binding.PrimitiveBindings

put(Object, Object) - Method in class com.sk89q.intake.context.CommandLocals

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.

remaining() - Method in interface com.sk89q.intake.parametric.argument.ArgumentStack

Get all remaining string values, which will consume the rest of the stack.

remaining() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

remaining() - Method in class com.sk89q.intake.parametric.argument.StringArgumentStack

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.

reset() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Reset to the previously ContextArgumentStack.mark()ed position of the stack, and return the arguments that were consumed between this point and that previous point.

S

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

Set the authorizer.

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(String[]) - Method in class com.sk89q.intake.SettableParameter

Set the default value.

setDescription(String) - Method in class com.sk89q.intake.SettableDescription

Set the description of the command.

setFlag(Character, boolean) - Method in class com.sk89q.intake.SettableParameter

Set the flag used by this parameter.

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

Set the help text of the command.

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

Set the name of the parameter.

setOptional(boolean) - Method in class com.sk89q.intake.SettableParameter

Set whether this parameter is optional.

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

Set the list of parameters.

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

Set the permissions of this command.

SettableDescription - Class in com.sk89q.intake

A simple implementation of Description which has setter methods.

SettableDescription() - Constructor for class com.sk89q.intake.SettableDescription

SettableParameter - Class in com.sk89q.intake

A simple implementation of Parameter that has setter methods to set the properties.

SettableParameter() - Constructor for class com.sk89q.intake.SettableParameter

Create a new parameter with no name defined yet.

SettableParameter(String) - Constructor for class com.sk89q.intake.SettableParameter

Create a new parameter of the given name.

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.

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

StandardBindings - Class in com.sk89q.intake.parametric.binding

Standard bindings that should be available to most configurations.

StandardBindings() - Constructor for class com.sk89q.intake.parametric.binding.StandardBindings

StringArgumentStack - Class in com.sk89q.intake.parametric.argument

A virtual scope that does not actually read from the underlying CommandContext.

StringArgumentStack(CommandContext, String[], boolean) - Constructor for class com.sk89q.intake.parametric.argument.StringArgumentStack

Create a new instance using the given context.

StringArgumentStack(CommandContext, String, boolean) - Constructor for class com.sk89q.intake.parametric.argument.StringArgumentStack

Create a new instance using the given context.

StringUtils - Class in com.sk89q.intake.util

Deprecated.

To be removed in the future.

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

A subject has authorization attached to it.

suggestionContext - Variable in class com.sk89q.intake.context.CommandContext

SuggestionContext - Class in com.sk89q.intake.context

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

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

T

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

Test whether this command can be executed with the given context.

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

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

Tests whether permission is granted for the given context.

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

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

Indicates a String parameter will call ArgumentStack.remaining() and therefore consume all remaining arguments.

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

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

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

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

trimLength(String, int) - Static method in class com.sk89q.intake.util.StringUtils

Deprecated.

Trim a string if it is longer than a certain length.

U

UnconsumedParameterException - Exception in com.sk89q.intake.parametric

Thrown when there are leftover parameters that were not consumed, particular in the case of the user providing too many parameters.

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

Create a new instance.

updateDescription(Object, Method, ParameterData[], SettableDescription) - Method in class com.sk89q.intake.parametric.handler.AbstractInvokeListener

updateDescription(Object, Method, ParameterData[], SettableDescription) - Method in interface com.sk89q.intake.parametric.handler.InvokeListener

During creation of a CommandCallable by a ParametricBuilder, this will be called in case the description needs to be updated.

updateDescription(Object, Method, ParameterData[], SettableDescription) - Method in class com.sk89q.intake.parametric.handler.LegacyCommandsHandler

V

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

Used to validate a string.

valueFlags - Variable in class com.sk89q.intake.context.CommandContext

valueOf(String) - Static method in enum com.sk89q.intake.parametric.binding.BindingBehavior

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sk89q.intake.parametric.binding.BindingBehavior

Returns an array containing the constants of this enum type, in the order they are declared.

W

wasConsumed() - Method in class com.sk89q.intake.parametric.argument.ContextArgumentStack

Return whether any arguments were consumed between the marked position and the current position.

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