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

A

action(Command.Action) - Method in interface org.enginehub.piston.Command.Builder

 

addConfig(Config<?>) - Method in class org.enginehub.piston.config.ConfigHolder

 

addPart(CommandPart) - Method in interface org.enginehub.piston.Command.Builder

 

addParts(CommandPart...) - Method in interface org.enginehub.piston.Command.Builder

 

addParts(Iterable<CommandPart>) - Method in interface org.enginehub.piston.Command.Builder

 

aliases(Collection<String>) - Method in interface org.enginehub.piston.Command.Builder

 

and(Command.Condition) - Method in interface org.enginehub.piston.Command.Condition

 

appendUsage(Stream<CommandPart>, TextComponent.Builder) - Static method in class org.enginehub.piston.util.PartHelper

Generate component representing the usage text for the given parts.

apply(TranslatableComponent) - Method in class org.enginehub.piston.config.ColorConfig

 

apply(TranslatableComponent) - Method in class org.enginehub.piston.config.Config

 

apply(TranslatableComponent) - Method in class org.enginehub.piston.config.TextConfig

 

arg(TranslatableComponent, Component) - Static method in class org.enginehub.piston.part.CommandParts

 

ArgAcceptingCommandFlag - Class in org.enginehub.piston.part

 

ArgAcceptingCommandFlag.Builder - Class in org.enginehub.piston.part

 

ArgAcceptingCommandPart - Interface in org.enginehub.piston.part

 

ArgBinding - Interface in org.enginehub.piston

 

ArgConsumingCommandPart - Interface in org.enginehub.piston.part

Marker interface for parts that consume arguments directly from the line, i.e.

argNamed(String) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

argNamed(TranslatableComponent) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

ArgumentConverter<T> - Interface in org.enginehub.piston.converter

Converts user input into an actual type.

ArgumentConverterAccess - Interface in org.enginehub.piston.converter

Access to converters.

ArgumentConverters - Class in org.enginehub.piston.converter

A collection of default argument converters.

ArgumentConverterStore - Interface in org.enginehub.piston.converter

Store for ArgumentConverters.

as(Class<T>) - Method in interface org.enginehub.piston.Command.Condition

Retrieve this condition as a more specific type, if possible.

asMultiple(Class<T>) - Method in interface org.enginehub.piston.CommandValue

Convert the string values using the converted registered under the given key.

asMultiple(Key<T>) - Method in interface org.enginehub.piston.CommandValue

Convert the string values using the converted registered under the given key.

asSingle(Class<T>) - Method in interface org.enginehub.piston.CommandValue

Convert the string value using the converted registered under the given key.

asSingle(Key<T>) - Method in interface org.enginehub.piston.CommandValue

Convert the string value using the converted registered under the given key.

asString() - Method in interface org.enginehub.piston.CommandValue

Get a single string value.

asStrings() - Method in interface org.enginehub.piston.CommandValue

Get all the string values.

B

build() - Method in interface org.enginehub.piston.Command.Builder

 

build() - Method in interface org.enginehub.piston.converter.MultiKeyConverter.Builder

 

build() - Method in interface org.enginehub.piston.NoInputCommandParameters.Builder

 

build() - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

build() - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

build() - Method in class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

build() - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

build() - Method in interface org.enginehub.piston.suggestion.Suggestion.Builder

 

builder(SetMultimap<E, String>) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

builder(Collection<E>, Function<E, Set<String>>) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

builder() - Static method in class org.enginehub.piston.NoInputCommandParameters

 

builder(char, Component) - Static method in class org.enginehub.piston.part.ArgAcceptingCommandFlag

 

Builder() - Constructor for class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

builder(TranslatableComponent, Component) - Static method in class org.enginehub.piston.part.CommandArgument

 

Builder() - Constructor for class org.enginehub.piston.part.CommandArgument.Builder

 

builder(char, String) - Static method in class org.enginehub.piston.part.NoArgCommandFlag

 

builder(char, Component) - Static method in class org.enginehub.piston.part.NoArgCommandFlag

 

Builder() - Constructor for class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

builder(TranslatableComponent, Component) - Static method in class org.enginehub.piston.part.SubCommandPart

 

Builder() - Constructor for class org.enginehub.piston.part.SubCommandPart.Builder

 

builder() - Static method in class org.enginehub.piston.suggestion.Suggestion

 

byPrefix(String) - Static method in class org.enginehub.piston.converter.SuggestionHelper

 

C

camelToTitle(String) - Static method in class org.enginehub.piston.util.CaseHelper

Convert a string from camel case to title case.

CaseHelper - Class in org.enginehub.piston.util

 

CaseHelper() - Constructor for class org.enginehub.piston.util.CaseHelper

 

cast(Stream<?>, Class<T>) - Static method in class org.enginehub.piston.util.StreamHelper

 

checkValue(T) - Method in class org.enginehub.piston.config.Config

 

checkValue(String) - Method in class org.enginehub.piston.config.TextConfig

 

ColorConfig - Class in org.enginehub.piston.config

Color configuration.

Command - Interface in org.enginehub.piston

Represents a command.

Command.Action - Interface in org.enginehub.piston

Represents what a command does.

Command.Builder - Interface in org.enginehub.piston

Builder for a command.

Command.Condition - Interface in org.enginehub.piston

Represents a condition for the execution of a command.

CommandArgument - Class in org.enginehub.piston.part

 

CommandArgument() - Constructor for class org.enginehub.piston.part.CommandArgument

 

CommandArgument.Builder - Class in org.enginehub.piston.part

 

CommandException - Exception in org.enginehub.piston.exception

Parent class for all command-related exceptions.

CommandException(ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.CommandException

 

CommandException(Component, ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.CommandException

 

CommandException(Component, Throwable, ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.CommandException

 

CommandException(Throwable, ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.CommandException

 

CommandExecutionException - Exception in org.enginehub.piston.exception

Thrown when a command action throws an exception.

CommandExecutionException(Throwable, ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.CommandExecutionException

 

CommandFlag - Interface in org.enginehub.piston.part

 

CommandManager - Interface in org.enginehub.piston

Responsible for holding all commands, as well as parsing and dispatching from user input.

CommandManagerService - Interface in org.enginehub.piston

Service for providing CommandManagers.

CommandMetadata - Interface in org.enginehub.piston

Metadata for a called command.

CommandParameters - Interface in org.enginehub.piston

Access to part values derived from user input.

CommandParseResult - Interface in org.enginehub.piston

Represents the result of parsing a command from arguments.

CommandPart - Interface in org.enginehub.piston.part

Represents a part of a command, i.e.

CommandParts - Class in org.enginehub.piston.part

 

commandPrefix() - Static method in class org.enginehub.piston.config.TextConfig

Output command prefix -- all commands will be output with this prefix before their name.

commandPrefixValue() - Static method in class org.enginehub.piston.config.TextConfig

 

commands - Variable in exception org.enginehub.piston.exception.CommandException

 

CommandValue - Interface in org.enginehub.piston

All values provided from the command line for a part.

ComponentHelper - Class in org.enginehub.piston.util

 

condition(Command.Condition) - Method in interface org.enginehub.piston.Command.Builder

 

ConditionFailedException - Exception in org.enginehub.piston.exception

 

ConditionFailedException(ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.ConditionFailedException

 

Config<T> - Class in org.enginehub.piston.config

 

Config(String, T) - Constructor for class org.enginehub.piston.config.Config

 

ConfigHolder - Class in org.enginehub.piston.config

 

ConfigRenderer - Class in org.enginehub.piston.config

Utility to render any config placeholders in a component using a given ConfigHolder.

constant(T) - Static method in interface org.enginehub.piston.util.ValueProvider

 

containsCommand(String) - Method in interface org.enginehub.piston.CommandManager

Determine if this manager knows of a command with name name.

ConversionFailedException - Exception in org.enginehub.piston.exception

Thrown from CommandValue when all conversions to a type have failed.

ConversionFailedException(CommandParseResult, Component, ArgumentConverter<?>, FailedConversion<?>) - Constructor for exception org.enginehub.piston.exception.ConversionFailedException

 

ConversionResult<T> - Class in org.enginehub.piston.converter

Represents the result of Converter.convert(String, InjectedValueAccess).

convert(String, InjectedValueAccess) - Method in interface org.enginehub.piston.converter.Converter

Converts the argument input to a collection of argument values.

convert(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.ForwardingArgumentConverter

 

convert(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.MapArgumentConverter

 

convert(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.MultiKeyConverter

 

convert(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.SimpleArgumentConverter

 

Converter<T> - Interface in org.enginehub.piston.converter

Simplified interface to ArgumentConverter.

converters(ArgumentConverterAccess) - Method in interface org.enginehub.piston.NoInputCommandParameters.Builder

 

copyForDefault() - Method in class org.enginehub.piston.config.ColorConfig

 

copyForDefault() - Method in class org.enginehub.piston.config.Config

 

copyForDefault() - Method in class org.enginehub.piston.config.TextConfig

 

create() - Static method in class org.enginehub.piston.config.ConfigHolder

 

create() - Static method in class org.enginehub.piston.inject.MapBackedValueStore

 

create(Map<Key<?>, ValueProvider<InjectedValueAccess, ?>>) - Static method in class org.enginehub.piston.inject.MapBackedValueStore

 

create(Iterable<Command>) - Static method in class org.enginehub.piston.util.HelpGenerator

 

create(CommandParseResult) - Static method in class org.enginehub.piston.util.HelpGenerator

 

D

DefaultCommandManagerService - Class in org.enginehub.piston

A CommandManagerService that delegates to a default manager.

defaultsTo(Iterable<String>) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

defaultsTo(Iterable<String>) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

DefaultSuggestionProvider - Class in org.enginehub.piston.suggestion

Default provider for suggestions.

delegate - Variable in class org.enginehub.piston.inject.ForwardingValueStore

 

describeAcceptableArguments() - Method in interface org.enginehub.piston.converter.ArgumentConverter

Describe the arguments that can be provided to this converter.

describeAcceptableArguments() - Method in class org.enginehub.piston.converter.ForwardingArgumentConverter

 

describeAcceptableArguments() - Method in class org.enginehub.piston.converter.MapArgumentConverter

 

describeAcceptableArguments() - Method in class org.enginehub.piston.converter.MultiKeyConverter

 

describeAcceptableArguments() - Method in class org.enginehub.piston.converter.SimpleArgumentConverter

 

describedBy(String) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

describedBy(Component) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

describedBy(String) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

describedBy(Component) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

describedBy(String) - Method in class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

describedBy(Component) - Method in class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

describedBy(String) - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

describedBy(Component) - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

description(Component) - Method in interface org.enginehub.piston.Command.Builder

 

E

EMPTY - Static variable in interface org.enginehub.piston.converter.ArgumentConverterAccess

 

EMPTY - Static variable in interface org.enginehub.piston.inject.InjectedValueAccess

 

equals(Object) - Method in class org.enginehub.piston.converter.FailedConversion

 

equals(Object) - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

errorMessage(UnaryOperator<String>) - Method in interface org.enginehub.piston.converter.MultiKeyConverter.Builder

 

execute(InjectedValueAccess, List<String>) - Method in interface org.enginehub.piston.CommandManager

Execute a command, given a set of arguments and a context.

F

FailedConversion<T> - Class in org.enginehub.piston.converter

 

FailedConversion(Throwable, Collection<FailedConversion<T>>) - Constructor for class org.enginehub.piston.converter.FailedConversion

 

FailedConversionMapper - Class in org.enginehub.piston.converter

 

failureAsAny() - Method in class org.enginehub.piston.converter.ConversionResult

If this result is a failure, recast as a different result type.

failureAsAny() - Method in class org.enginehub.piston.converter.FailedConversion

 

failureAsAny() - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

FALSE - Static variable in interface org.enginehub.piston.Command.Condition

An condition that always returns false.

flag(char, Component) - Static method in class org.enginehub.piston.part.CommandParts

 

footer(Component) - Method in interface org.enginehub.piston.Command.Builder

 

forChoices(Set<String>) - Static method in class org.enginehub.piston.converter.MapArgumentConverter

Construct a converter for simple string choices from a set.

forString() - Static method in class org.enginehub.piston.converter.ArgumentConverters

 

ForwardingArgumentConverter<T> - Class in org.enginehub.piston.converter

 

ForwardingArgumentConverter(ArgumentConverter<T>) - Constructor for class org.enginehub.piston.converter.ForwardingArgumentConverter

 

ForwardingValueStore - Class in org.enginehub.piston.inject

Forwards all calls to the delegate.

ForwardingValueStore(InjectedValueStore) - Constructor for class org.enginehub.piston.inject.ForwardingValueStore

 

from(Throwable) - Static method in class org.enginehub.piston.converter.FailedConversion

 

from(Throwable, Collection<FailedConversion<T>>) - Static method in class org.enginehub.piston.converter.FailedConversion

 

from(Map<String, T>) - Static method in class org.enginehub.piston.converter.MapArgumentConverter

 

from(SetMultimap<E, String>) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

from(Collection<E>, Function<E, Set<String>>) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

from(SetMultimap<E, String>, E) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

from(Collection<E>, Function<E, Set<String>>, E) - Static method in class org.enginehub.piston.converter.MultiKeyConverter

 

from(Converter<T>, String) - Static method in class org.enginehub.piston.converter.SimpleArgumentConverter

 

from(Converter<T>, Component) - Static method in class org.enginehub.piston.converter.SimpleArgumentConverter

Implements Converter.convert(String, InjectedValueAccess) using the provided function, and supplies the provided description for ArgumentConverter.describeAcceptableArguments().

from(Collection<T>) - Static method in class org.enginehub.piston.converter.SuccessfulConversion

 

fromSingle(T) - Static method in class org.enginehub.piston.converter.SuccessfulConversion

 

G

get(TypeToken<T>) - Static method in class org.enginehub.piston.converter.ArgumentConverters

 

get() - Method in class org.enginehub.piston.converter.ConversionResult

Get the result, or throw an exception with all collected errors.

get() - Method in class org.enginehub.piston.converter.FailedConversion

 

get() - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

getAction() - Method in interface org.enginehub.piston.Command

 

getAliases() - Method in interface org.enginehub.piston.Command

 

getAllCommands() - Method in interface org.enginehub.piston.CommandManager

Retrieve all commands that are registered.

getAllErrors() - Method in exception org.enginehub.piston.exception.ConversionFailedException

 

getAnnotation() - Method in class org.enginehub.piston.inject.Key

 

getAnnotationType() - Method in class org.enginehub.piston.inject.Key

 

getArgumentName() - Method in interface org.enginehub.piston.part.ArgConsumingCommandPart

The name of the argument taken from the command-line.

getArguments() - Method in interface org.enginehub.piston.CommandMetadata

 

getBoundArguments() - Method in interface org.enginehub.piston.CommandParseResult

Get the raw argument bindings.

getCalledName() - Method in interface org.enginehub.piston.CommandMetadata

 

getCommand(String) - Method in interface org.enginehub.piston.CommandManager

Get the command with name name, if registered.

getCommandParseResult() - Method in exception org.enginehub.piston.exception.UsageException

 

getCommands() - Method in exception org.enginehub.piston.exception.CommandException

Retrieves all commands associated with this exception.

getCommands() - Method in class org.enginehub.piston.part.SubCommandPart

 

getCondition() - Method in interface org.enginehub.piston.Command

 

getCondition() - Method in exception org.enginehub.piston.exception.ConditionFailedException

 

getConfig(Config<T>) - Method in class org.enginehub.piston.config.ConfigHolder

 

getConfigs() - Method in class org.enginehub.piston.config.ConfigHolder

 

getConversion() - Method in exception org.enginehub.piston.exception.ConversionFailedException

 

getConverter(Key<T>) - Method in interface org.enginehub.piston.converter.ArgumentConverterAccess

Get a converter for a key.

getConverter() - Method in exception org.enginehub.piston.exception.ConversionFailedException

 

getConverters() - Method in interface org.enginehub.piston.CommandParameters

Get the converters used in this call.

getConverters() - Method in class org.enginehub.piston.NoInputCommandParameters

 

getDefaults() - Method in interface org.enginehub.piston.part.ArgAcceptingCommandPart

 

getDescription() - Method in interface org.enginehub.piston.Command

 

getDescription() - Method in interface org.enginehub.piston.part.CommandPart

Returns the description of this part.

getError() - Method in class org.enginehub.piston.converter.FailedConversion

 

getExecutionPath() - Method in interface org.enginehub.piston.CommandParseResult

Get the path of commands to be executed.

getFooter() - Method in interface org.enginehub.piston.Command

 

getFullHelp() - Method in interface org.enginehub.piston.Command

 

getFullHelp() - Method in class org.enginehub.piston.util.HelpGenerator

 

getFullName() - Method in class org.enginehub.piston.util.HelpGenerator

Generate a name for the set of commands as a whole.

getInput() - Method in interface org.enginehub.piston.ArgBinding

Get the raw input that was bound.

getInstance() - Static method in class org.enginehub.piston.config.ConfigRenderer

Get an instance of the renderer.

getInstance() - Static method in class org.enginehub.piston.DefaultCommandManagerService

 

getInstance() - Static method in class org.enginehub.piston.suggestion.DefaultSuggestionProvider

 

getKey() - Method in class org.enginehub.piston.config.Config

 

getMetadata() - Method in interface org.enginehub.piston.CommandParameters

Gets the metadata for the command being called.

getMetadata() - Method in class org.enginehub.piston.NoInputCommandParameters

 

getName() - Method in interface org.enginehub.piston.Command

 

getName() - Method in interface org.enginehub.piston.part.CommandFlag

 

getOriginalArguments() - Method in interface org.enginehub.piston.CommandParseResult

 

getOtherFailures() - Method in class org.enginehub.piston.converter.FailedConversion

 

getParameters() - Method in interface org.enginehub.piston.CommandParseResult

Get the parameters to execute the command with.

getParts() - Method in interface org.enginehub.piston.ArgBinding

Get the part(s) the input was bound to.

getParts() - Method in interface org.enginehub.piston.Command

 

getPrimaryCommand() - Method in interface org.enginehub.piston.CommandParseResult

Get the command who's action should be executed.

getReplacedArgument() - Method in class org.enginehub.piston.suggestion.Suggestion

The argument index to replace in the original input.

getRequestedCommand() - Method in exception org.enginehub.piston.exception.NoSuchCommandException

 

getRequestedFlag() - Method in exception org.enginehub.piston.exception.NoSuchFlagException

 

getRichMessage() - Method in exception org.enginehub.piston.exception.CommandException

Get the rich message, with extra formatting.

getSuggester() - Method in interface org.enginehub.piston.Command

 

getSuggestion() - Method in class org.enginehub.piston.suggestion.Suggestion

The suggestion value, to be inserted instead of the argument at index replacedArgument.

getSuggestions(InjectedValueAccess, List<String>) - Method in interface org.enginehub.piston.CommandManager

Suggest inputs based on a current user input.

getSuggestions(String, InjectedValueAccess) - Method in interface org.enginehub.piston.converter.ArgumentConverter

 

getSuggestions(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.ForwardingArgumentConverter

 

getSuggestions(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.MapArgumentConverter

 

getSuggestions(String, InjectedValueAccess) - Method in class org.enginehub.piston.converter.MultiKeyConverter

 

getSuggestions(String, InjectedValueAccess) - Method in interface org.enginehub.piston.converter.SuggestionProvider

Given input as the current input, provide some suggestions for the user.

getTextRepresentation() - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag

 

getTextRepresentation() - Method in class org.enginehub.piston.part.CommandArgument

 

getTextRepresentation() - Method in interface org.enginehub.piston.part.CommandPart

Returns the text representation of this part.

getTextRepresentation() - Method in class org.enginehub.piston.part.NoArgCommandFlag

 

getTextRepresentation() - Method in class org.enginehub.piston.part.SubCommandPart

 

getTypes() - Method in interface org.enginehub.piston.part.ArgAcceptingCommandPart

All possible types for this argument.

getTypeToken() - Method in class org.enginehub.piston.inject.Key

 

getUsage() - Method in interface org.enginehub.piston.Command

 

getUsage() - Method in class org.enginehub.piston.util.HelpGenerator

Generate a usage help text.

getValue() - Method in class org.enginehub.piston.config.Config

 

H

has(CommandPart) - Method in interface org.enginehub.piston.CommandParameters

Checks if the parameters contain the specified part.

has(CommandPart) - Method in class org.enginehub.piston.NoInputCommandParameters

 

hashCode() - Method in class org.enginehub.piston.converter.FailedConversion

 

hashCode() - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

HelpGenerator - Class in org.enginehub.piston.util

 

helpText() - Static method in class org.enginehub.piston.config.ColorConfig

Color for help text.

I

id() - Method in interface org.enginehub.piston.CommandManagerService

The unique ID for this service.

id() - Method in class org.enginehub.piston.DefaultCommandManagerService

 

in(CommandParameters) - Method in interface org.enginehub.piston.part.CommandPart

 

InjectAnnotation - Annotation Type in org.enginehub.piston.inject

Meta-annotation that marks the annotation interface as an inject annotation.

injectedValue(Key<T>, InjectedValueAccess) - Method in class org.enginehub.piston.inject.ForwardingValueStore

 

injectedValue(Key<T>) - Method in interface org.enginehub.piston.inject.InjectedValueAccess

Get an injected value.

injectedValue(Key<T>, InjectedValueAccess) - Method in interface org.enginehub.piston.inject.InjectedValueAccess

Get an injected value, resolving other injected values under the given context.

injectedValue(Key<T>, InjectedValueAccess) - Method in class org.enginehub.piston.inject.MapBackedValueStore

 

injectedValue(Key<T>, InjectedValueAccess) - Method in class org.enginehub.piston.inject.MemoizingValueAccess

 

injectedValue(Key<T>, InjectedValueAccess) - Method in class org.enginehub.piston.inject.MergedValueAccess

 

injectedValue(Key<T>, InjectedValueAccess) - Method in class org.enginehub.piston.NoInputCommandParameters

 

InjectedValueAccess - Interface in org.enginehub.piston.inject

Common access declarations for injected values.

injectedValues(InjectedValueAccess) - Method in interface org.enginehub.piston.NoInputCommandParameters.Builder

 

InjectedValueStore - Interface in org.enginehub.piston.inject

Common storage declarations for injected values.

injectValue(Key<T>, ValueProvider<InjectedValueAccess, T>) - Method in class org.enginehub.piston.inject.ForwardingValueStore

 

injectValue(Key<T>, ValueProvider<InjectedValueAccess, T>) - Method in interface org.enginehub.piston.inject.InjectedValueStore

Inject a value into this store.

injectValue(Key<T>, ValueProvider<InjectedValueAccess, T>) - Method in class org.enginehub.piston.inject.MapBackedValueStore

 

isRequired() - Method in class org.enginehub.piston.part.CommandArgument

Returns true if this part is required, and may not be missing from the command line.

isRequired() - Method in interface org.enginehub.piston.part.CommandFlag

 

isRequired() - Method in interface org.enginehub.piston.part.CommandPart

Returns true if this part is required, and may not be missing from the command line.

isSuccessful() - Method in class org.enginehub.piston.converter.ConversionResult

 

isSuccessful() - Method in class org.enginehub.piston.converter.FailedConversion

 

isSuccessful() - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

isVariable() - Method in class org.enginehub.piston.part.CommandArgument

Check if this argument a variable argument.

items(SetMultimap<E, String>) - Method in interface org.enginehub.piston.converter.MultiKeyConverter.Builder

 

J

joiningTexts(Component, Component, Component) - Static method in class org.enginehub.piston.util.ComponentHelper

 

joiningWithBar() - Static method in class org.enginehub.piston.util.ComponentHelper

Join components together with a `|`, coloring the bar with ColorConfig.partWrapping().

K

Key<T> - Class in org.enginehub.piston.inject

Represents a type-based key.

Key() - Constructor for class org.enginehub.piston.inject.Key

 

keySet() - Method in interface org.enginehub.piston.converter.ArgumentConverterAccess

 

L

limitByPrefix(Stream<String>, String) - Static method in class org.enginehub.piston.converter.SuggestionHelper

 

M

mainText() - Static method in class org.enginehub.piston.config.ColorConfig

Color for a command part label.

map(Function<? super Collection<T>, ? extends Collection<U>>) - Method in class org.enginehub.piston.converter.ConversionResult

If successful, map the result using the given mapper.

map(Function<? super Collection<T>, ? extends Collection<U>>) - Method in class org.enginehub.piston.converter.FailedConversion

 

map(Function<? super Collection<T>, ? extends Collection<U>>) - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

MapArgumentConverter<T> - Class in org.enginehub.piston.converter

Converts using a Map.

MapBackedValueStore - Class in org.enginehub.piston.inject

InjectedValueStore backed by a Map.

mapOnto(Supplier<X>, FailedConversion<?>) - Static method in class org.enginehub.piston.converter.FailedConversionMapper

 

mapSingle(Function<? super T, ? extends U>) - Method in class org.enginehub.piston.converter.ConversionResult

 

MemoizingValueAccess - Class in org.enginehub.piston.inject

Memoizes accesses, so that only one value is used.

MergedValueAccess - Class in org.enginehub.piston.inject

Combination between multiple InjectedValueStore instances.

metadata(CommandMetadata) - Method in interface org.enginehub.piston.NoInputCommandParameters.Builder

 

MultiKeyConverter<E> - Class in org.enginehub.piston.converter

 

MultiKeyConverter.Builder<E> - Interface in org.enginehub.piston.converter

 

N

name(String) - Method in interface org.enginehub.piston.Command.Builder

 

named(char) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

named(String) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

named(TranslatableComponent) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

named(char) - Method in class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

named(TranslatableComponent) - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

newCommand(String) - Method in interface org.enginehub.piston.CommandManager

Create a new command builder, using the default implementation of this manager.

newCommand(String) - Method in interface org.enginehub.piston.CommandManagerService

Creates a new command builder.

newCommand(String) - Method in class org.enginehub.piston.DefaultCommandManagerService

 

newCommandManager() - Method in interface org.enginehub.piston.CommandManagerService

Creates a new command manager.

newCommandManager() - Method in class org.enginehub.piston.DefaultCommandManagerService

 

NoArgCommandFlag - Class in org.enginehub.piston.part

 

NoArgCommandFlag.Builder - Class in org.enginehub.piston.part

 

NoInputCommandParameters - Class in org.enginehub.piston

An implementation of CommandParameters for situations where it is needed, but there is no user input available.

NoInputCommandParameters.Builder - Interface in org.enginehub.piston

 

NonnullByDefault - Annotation Type in org.enginehub.piston.util

Marks a package, class, or method as having all elements Nonnull by default.

NoSuchCommandException - Exception in org.enginehub.piston.exception

 

NoSuchCommandException(String) - Constructor for exception org.enginehub.piston.exception.NoSuchCommandException

 

NoSuchFlagException - Exception in org.enginehub.piston.exception

 

NoSuchFlagException(CommandParseResult, char) - Constructor for exception org.enginehub.piston.exception.NoSuchFlagException

 

not() - Method in interface org.enginehub.piston.Command.Condition

 

NULL_ACTION - Static variable in interface org.enginehub.piston.Command.Action

An action that does nothing, and returns 0.

O

of(Class<T>) - Static method in class org.enginehub.piston.inject.Key

 

of(TypeToken<T>) - Static method in class org.enginehub.piston.inject.Key

 

of(Class<T>, Annotation) - Static method in class org.enginehub.piston.inject.Key

 

of(Class<T>, Class<? extends Annotation>) - Static method in class org.enginehub.piston.inject.Key

 

of(TypeToken<T>, Annotation) - Static method in class org.enginehub.piston.inject.Key

 

of(TypeToken<T>, Class<? extends Annotation>) - Static method in class org.enginehub.piston.inject.Key

 

of(InjectedValueAccess...) - Static method in class org.enginehub.piston.inject.MergedValueAccess

 

of(Collection<? extends InjectedValueAccess>) - Static method in class org.enginehub.piston.inject.MergedValueAccess

 

ofTypes(Collection<Key<?>>) - Method in class org.enginehub.piston.part.ArgAcceptingCommandFlag.Builder

 

ofTypes(Collection<Key<?>>) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

optional() - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

or(Command.Condition) - Method in interface org.enginehub.piston.Command.Condition

 

orElse(ConversionResult<T>) - Method in class org.enginehub.piston.converter.ConversionResult

Pick the successful result, or merge the errors of the two unsuccessful results.

orElse(Collection<T>) - Method in class org.enginehub.piston.converter.ConversionResult

 

orElse(ConversionResult<T>) - Method in class org.enginehub.piston.converter.FailedConversion

 

orElse(ConversionResult<T>) - Method in class org.enginehub.piston.converter.SuccessfulConversion

 

org.enginehub.piston - package org.enginehub.piston

 

org.enginehub.piston.config - package org.enginehub.piston.config

 

org.enginehub.piston.converter - package org.enginehub.piston.converter

 

org.enginehub.piston.exception - package org.enginehub.piston.exception

 

org.enginehub.piston.inject - package org.enginehub.piston.inject

 

org.enginehub.piston.part - package org.enginehub.piston.part

 

org.enginehub.piston.suggestion - package org.enginehub.piston.suggestion

 

org.enginehub.piston.util - package org.enginehub.piston.util

 

P

parse(InjectedValueAccess, List<String>) - Method in interface org.enginehub.piston.CommandManager

Parse a command, given a set of arguments and a context.

PartHelper - Class in org.enginehub.piston.util

 

PartHelper() - Constructor for class org.enginehub.piston.util.PartHelper

 

parts(Collection<CommandPart>) - Method in interface org.enginehub.piston.Command.Builder

 

partWrapping() - Static method in class org.enginehub.piston.config.ColorConfig

Color for the wrapping text of a command part, e.g.

provideSuggestions(List<String>, CommandParseResult) - Method in class org.enginehub.piston.suggestion.DefaultSuggestionProvider

 

provideSuggestions(List<String>, CommandParseResult) - Method in interface org.enginehub.piston.suggestion.SuggestionProvider

Given args and the result of parsing them, provide suggestions for the next argument.

R

reduceToText(Component) - Static method in class org.enginehub.piston.util.TextHelper

 

register(Command) - Method in interface org.enginehub.piston.CommandManager

Registers any command, regardless of how it came about.

register(String, Consumer<Command.Builder>) - Method in interface org.enginehub.piston.CommandManager

Register a command that initially has the given name, and then is configured by a function.

registerConverter(Key<T>, ArgumentConverter<T>) - Method in interface org.enginehub.piston.converter.ArgumentConverterStore

Register a converter for a given key.

registerConverters(ArgumentConverterAccess) - Method in interface org.enginehub.piston.converter.ArgumentConverterStore

Register all the converters in converters with this store.

registerManager(CommandManager) - Method in interface org.enginehub.piston.CommandManager

Register an entire manager with this one, inheriting all of its commands.

render(Component, ConfigHolder) - Method in class org.enginehub.piston.config.ConfigRenderer

 

replace(Component) - Method in class org.enginehub.piston.config.ConfigHolder

Deprecated.

Use ConfigRenderer instead

replacedArgument(int) - Method in interface org.enginehub.piston.suggestion.Suggestion.Builder

 

required() - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

run(CommandParameters) - Method in interface org.enginehub.piston.Command.Action

Run the action.

S

satisfied(InjectedValueAccess) - Method in interface org.enginehub.piston.Command.Condition

Determine if the condition is satisfied.

setDefaultService(CommandManagerService) - Method in class org.enginehub.piston.DefaultCommandManagerService

 

setValue(T) - Method in class org.enginehub.piston.config.Config

 

SimpleArgumentConverter<T> - Class in org.enginehub.piston.converter

A simple base implementation of ArgumentConverter.

snapshotMemory() - Method in class org.enginehub.piston.inject.MemoizingValueAccess

Snapshot the current memory for reading.

StopExecutionException - Exception in org.enginehub.piston.exception

Signal to stop executing a command.

StopExecutionException(Component) - Constructor for exception org.enginehub.piston.exception.StopExecutionException

 

StopExecutionException(Component, ImmutableList<Command>) - Constructor for exception org.enginehub.piston.exception.StopExecutionException

 

StreamHelper - Class in org.enginehub.piston.util

 

SubCommandPart - Class in org.enginehub.piston.part

 

SubCommandPart() - Constructor for class org.enginehub.piston.part.SubCommandPart

 

SubCommandPart.Builder - Class in org.enginehub.piston.part

 

SuccessfulConversion<T> - Class in org.enginehub.piston.converter

 

suggester(SuggestionProvider) - Method in interface org.enginehub.piston.Command.Builder

 

Suggestion - Class in org.enginehub.piston.suggestion

Represents a suggestion.

suggestion(String) - Method in interface org.enginehub.piston.suggestion.Suggestion.Builder

 

Suggestion.Builder - Interface in org.enginehub.piston.suggestion

 

SuggestionHelper - Class in org.enginehub.piston.converter

 

SuggestionProvider - Interface in org.enginehub.piston.converter

Represents an object than can provide suggestions, given an input and context.

SuggestionProvider - Interface in org.enginehub.piston.suggestion

General suggestion provider.

T

TextConfig - Class in org.enginehub.piston.config

Text configuration.

TextHelper - Class in org.enginehub.piston.util

 

textModifier() - Static method in class org.enginehub.piston.config.ColorConfig

Color for text that modifies the main text.

titleToCamel(String) - Static method in class org.enginehub.piston.util.CaseHelper

Convert a string from title case to camel case.

titleToSpacedLower(String) - Static method in class org.enginehub.piston.util.CaseHelper

Convert a string from title case to spaced lower case.

toBuilder() - Method in interface org.enginehub.piston.Command

 

toBuilder() - Method in class org.enginehub.piston.suggestion.Suggestion

Convert this suggestion back to a builder.

toString() - Method in class org.enginehub.piston.inject.Key

 

TRUE - Static variable in interface org.enginehub.piston.Command.Condition

An condition that always returns true.

U

unknownValue(E) - Method in interface org.enginehub.piston.converter.MultiKeyConverter.Builder

 

UsageException - Exception in org.enginehub.piston.exception

Parent class for all usage-related exceptions.

UsageException(CommandParseResult) - Constructor for exception org.enginehub.piston.exception.UsageException

 

UsageException(Component, CommandParseResult) - Constructor for exception org.enginehub.piston.exception.UsageException

 

UsageException(Component, Throwable, CommandParseResult) - Constructor for exception org.enginehub.piston.exception.UsageException

 

UsageException(Throwable, CommandParseResult) - Constructor for exception org.enginehub.piston.exception.UsageException

 

V

value(TextColor) - Method in class org.enginehub.piston.config.ColorConfig

 

value(T) - Method in class org.enginehub.piston.config.Config

 

value() - Method in class org.enginehub.piston.config.Config

 

value(String) - Method in class org.enginehub.piston.config.TextConfig

 

value(CommandParameters) - Method in interface org.enginehub.piston.part.ArgAcceptingCommandPart

 

value(C) - Method in interface org.enginehub.piston.util.ValueProvider

Compute the value from the context.

valueOf(ArgAcceptingCommandPart) - Method in interface org.enginehub.piston.CommandParameters

Gets the value of the specified part, throwing if it is not present or if there are multiple values.

valueOf(ArgAcceptingCommandPart) - Method in class org.enginehub.piston.NoInputCommandParameters

 

ValueProvider<C,T> - Interface in org.enginehub.piston.util

Provides a value, given a context argument.

variable(boolean) - Method in class org.enginehub.piston.part.CommandArgument.Builder

 

W

withCommands(Collection<Command>) - Method in class org.enginehub.piston.part.SubCommandPart.Builder

 

withRequiredArg() - Method in class org.enginehub.piston.part.NoArgCommandFlag.Builder

 

withSuggestions(SuggestionProvider) - Method in class org.enginehub.piston.converter.SimpleArgumentConverter

 

wrap(String) - Method in class org.enginehub.piston.config.ColorConfig

 

wrap(Component...) - Method in class org.enginehub.piston.config.ColorConfig

 

wrap(List<Component>) - Method in class org.enginehub.piston.config.ColorConfig

 

wrap(InjectedValueAccess) - Static method in class org.enginehub.piston.inject.MemoizingValueAccess

 

wrapInternal(List<Component>) - Method in class org.enginehub.piston.config.Config

 

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