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

A

AbstractPathCompleter<P> - Class in org.crsh.cli.completers

AbstractPathCompleter() - Constructor for class org.crsh.cli.completers.AbstractPathCompleter

add(String, boolean) - Method in class org.crsh.cli.spi.Completion.Builder

Argument - Annotation Type in org.crsh.cli

A command argument.

ArgumentDescriptor - Class in org.crsh.cli.descriptor

ArgumentDescriptor(String, ParameterType<?>, Description, boolean, boolean, boolean, Class<? extends Completer>, Annotation) - Constructor for class org.crsh.cli.descriptor.ArgumentDescriptor

B

BOOLEAN - Static variable in class org.crsh.cli.type.ValueType

Boolean.

build() - Method in class org.crsh.cli.spi.Completion.Builder

builder(String) - Static method in class org.crsh.cli.spi.Completion

C

Command - Annotation Type in org.crsh.cli

Annotates a method for declaring a CRaSH command.

CommandDescriptor<T> - Class in org.crsh.cli.descriptor

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.AbstractPathCompleter

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.EmptyCompleter

Returns the value returned by Collections.emptyList().

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.EnumCompleter

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.ObjectNameCompleter

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.SystemPropertyNameCompleter

complete(ParameterDescriptor, String) - Method in class org.crsh.cli.completers.ThreadCompleter

complete(ParameterDescriptor, String) - Method in interface org.crsh.cli.spi.Completer

Query the completer for a set of completions for the given prefix.

completer() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Completer - Interface in org.crsh.cli.spi

Completion - Class in org.crsh.cli.spi

An immutable object representing the complation of a value.

Completion.Builder - Class in org.crsh.cli.spi

Completion.Builder(String) - Constructor for class org.crsh.cli.spi.Completion.Builder

create() - Static method in class org.crsh.cli.spi.Completion

create(String) - Static method in class org.crsh.cli.spi.Completion

create(String, String, boolean) - Static method in class org.crsh.cli.spi.Completion

create(String, boolean) - Static method in class org.crsh.cli.spi.Completion

create(String, Map<String, Boolean>) - Static method in class org.crsh.cli.spi.Completion

D

DEFAULT - Static variable in class org.crsh.cli.type.ValueTypeFactory

A value type factory instance that provides a predefined set of value types.

DESCRIBE - Static variable in class org.crsh.cli.descriptor.Format

.

Description - Class in org.crsh.cli.descriptor

Description() - Constructor for class org.crsh.cli.descriptor.Description

Description(Description, Description) - Constructor for class org.crsh.cli.descriptor.Description

Description(String, String) - Constructor for class org.crsh.cli.descriptor.Description

Description(AnnotatedElement) - Constructor for class org.crsh.cli.descriptor.Description

Description(Annotation...) - Constructor for class org.crsh.cli.descriptor.Description

E

EmptyCompleter - Class in org.crsh.cli.completers

EmptyCompleter() - Constructor for class org.crsh.cli.completers.EmptyCompleter

ENUM - Static variable in class org.crsh.cli.type.ValueType

Any Java enum.

EnumCompleter - Class in org.crsh.cli.completers

EnumCompleter() - Constructor for class org.crsh.cli.completers.EnumCompleter

equals(Object) - Method in class org.crsh.cli.descriptor.Description

equals(Object) - Method in class org.crsh.cli.spi.Completion

equals(Object) - Method in class org.crsh.cli.type.ValueType

F

FILE - Static variable in class org.crsh.cli.type.ValueType

A value type for files.

FileCompleter - Class in org.crsh.cli.completers

FileCompleter() - Constructor for class org.crsh.cli.completers.FileCompleter

Format - Class in org.crsh.cli.descriptor

Format the command descriptor for producing documentation.

Format() - Constructor for class org.crsh.cli.descriptor.Format

Format.Describe - Class in org.crsh.cli.descriptor

The command description in one line.

Format.Describe() - Constructor for class org.crsh.cli.descriptor.Format.Describe

Format.Man - Class in org.crsh.cli.descriptor

The command manual.

Format.Man() - Constructor for class org.crsh.cli.descriptor.Format.Man

Format.Usage - Class in org.crsh.cli.descriptor

The command usage.

Format.Usage() - Constructor for class org.crsh.cli.descriptor.Format.Usage

G

get(String) - Method in class org.crsh.cli.spi.Completion

get(Class<S>) - Method in class org.crsh.cli.type.ValueTypeFactory

getAnnotation() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getArgument(int) - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns a a specified argument by its index.

getArguments() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns a list of the command arguments.

getArity() - Method in class org.crsh.cli.descriptor.OptionDescriptor

getCompleter() - Method in class org.crsh.cli.type.ValueType

getCompleterType() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getDeclaredType() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getDepth() - Method in class org.crsh.cli.descriptor.CommandDescriptor

getDescription() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command description.

getDescription() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getInstance() - Static method in class org.crsh.cli.completers.EmptyCompleter

Returns the empty completer instance.

getInstance() - Static method in class org.crsh.cli.completers.EnumCompleter

Returns the empty completer instance.

getInvoker(InvocationMatch<T>) - Method in class org.crsh.cli.descriptor.CommandDescriptor

getLongOptionNames() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command long option names.

getMan() - Method in class org.crsh.cli.descriptor.Description

getMultiplicity() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getName() - Method in class org.crsh.cli.descriptor.ArgumentDescriptor

Returns the argument name, that can be null.

getName() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command name.

getNames() - Method in class org.crsh.cli.descriptor.OptionDescriptor

getOption(String) - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns a command option by its name.

getOptionNames() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command option names.

getOptions() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command options.

getOwner() - Method in class org.crsh.cli.descriptor.CommandDescriptor

getParameters() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command parameters, the returned collection contains the command options and the command arguments.

getPrefix() - Method in class org.crsh.cli.spi.Completion

getShortOptionNames() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command short option names.

getSize() - Method in class org.crsh.cli.spi.Completion

getSubordinate(String) - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns a specified subordinate.

getSubordinates() - Method in class org.crsh.cli.descriptor.CommandDescriptor

getType() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getType() - Method in class org.crsh.cli.type.ValueType

getUsage() - Method in class org.crsh.cli.descriptor.CommandDescriptor

Returns the command usage, shortcut for invoking getDescription().getUsage() on this object.

getUsage() - Method in class org.crsh.cli.descriptor.Description

getUsage() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

getValues() - Method in class org.crsh.cli.spi.Completion

H

hashCode() - Method in class org.crsh.cli.spi.Completion

hashCode() - Method in class org.crsh.cli.type.ValueType

I

INTEGER - Static variable in class org.crsh.cli.type.ValueType

Integer.

isEmpty() - Method in class org.crsh.cli.spi.Completion

isMultiValued() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

isPassword() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

isRequired() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

isSingleValued() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

isUnquote() - Method in class org.crsh.cli.descriptor.ParameterDescriptor

iterator() - Method in class org.crsh.cli.spi.Completion

M

MAN - Static variable in class org.crsh.cli.descriptor.Format

.

Man - Annotation Type in org.crsh.cli

Provides the manual text, this method can be used to annotate a command class, a command method or a command parameter.

matcher() - Method in class org.crsh.cli.descriptor.CommandDescriptor

N

Named - Annotation Type in org.crsh.cli

This annotation can be used to name a program element, useful for overriding the name of a command.

O

OBJECT_NAME - Static variable in class org.crsh.cli.type.ValueType

A JMX object name value type.

ObjectNameCompleter - Class in org.crsh.cli.completers

ObjectNameCompleter() - Constructor for class org.crsh.cli.completers.ObjectNameCompleter

Option - Annotation Type in org.crsh.cli

An option command parameter.

OptionDescriptor - Class in org.crsh.cli.descriptor

OptionDescriptor(ParameterType<?>, List<String>, Description, boolean, boolean, boolean, Class<? extends Completer>, Annotation) - Constructor for class org.crsh.cli.descriptor.OptionDescriptor

org.crsh.cli - package org.crsh.cli

org.crsh.cli.completers - package org.crsh.cli.completers

org.crsh.cli.descriptor - package org.crsh.cli.descriptor

org.crsh.cli.spi - package org.crsh.cli.spi

org.crsh.cli.type - package org.crsh.cli.type

P

ParameterDescriptor - Class in org.crsh.cli.descriptor

ParameterDescriptor(ParameterType<?>, Description, boolean, boolean, boolean, Class<? extends Completer>, Annotation) - Constructor for class org.crsh.cli.descriptor.ParameterDescriptor

parse(List<String>) - Method in class org.crsh.cli.descriptor.ArgumentDescriptor

parse(List<String>) - Method in class org.crsh.cli.descriptor.OptionDescriptor

parse(String) - Method in class org.crsh.cli.descriptor.ParameterDescriptor

parse(List<String>) - Method in class org.crsh.cli.descriptor.ParameterDescriptor

parse(String) - Method in class org.crsh.cli.type.ValueType

parse(Class<S>, String) - Method in class org.crsh.cli.type.ValueType

Parse the s argument into a value of type S that is a subclass of the generic value type V.

print(Format, Appendable) - Method in class org.crsh.cli.descriptor.CommandDescriptor

print(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Describe

print(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Man

print(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format

Print the specified command to the stream

print(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Usage

printDescriptionSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Man

printDetailsSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Usage

printMan(Appendable) - Method in class org.crsh.cli.descriptor.CommandDescriptor

printNameSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Man

printParametersSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Man

printSynopsisSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Man

printUsage(Appendable) - Method in class org.crsh.cli.descriptor.ArgumentDescriptor

Prints the argument: Single valued arguments use the "$arg" pattern. Multi valued arguments use the "...

printUsage(Appendable) - Method in class org.crsh.cli.descriptor.CommandDescriptor

printUsage(Appendable) - Method in class org.crsh.cli.descriptor.OptionDescriptor

Prints the option names as an alternative of switches surrounded by a square brace, for instance: "[-f --foo]"

printUsage(Appendable) - Method in class org.crsh.cli.descriptor.ParameterDescriptor

printUsageSection(CommandDescriptor<?>, Appendable) - Method in class org.crsh.cli.descriptor.Format.Usage

PROPERTIES - Static variable in class org.crsh.cli.type.ValueType

Properties as semi colon separated values.

R

Required - Annotation Type in org.crsh.cli

Declares if a command parameter is required or not.

resolveOption(String) - Method in class org.crsh.cli.descriptor.CommandDescriptor

Find an command option by its name, this will look through the command hierarchy.

S

STRING - Static variable in class org.crsh.cli.type.ValueType

Identity.

SystemPropertyNameCompleter - Class in org.crsh.cli.completers

A completer for system property names.

SystemPropertyNameCompleter() - Constructor for class org.crsh.cli.completers.SystemPropertyNameCompleter

T

THREAD - Static variable in class org.crsh.cli.type.ValueType

A value type for threads.

ThreadCompleter - Class in org.crsh.cli.completers

ThreadCompleter() - Constructor for class org.crsh.cli.completers.ThreadCompleter

toString() - Method in class org.crsh.cli.descriptor.ArgumentDescriptor

toString() - Method in class org.crsh.cli.descriptor.OptionDescriptor

toString() - Method in class org.crsh.cli.spi.Completion

U

USAGE - Static variable in class org.crsh.cli.descriptor.Format

.

Usage - Annotation Type in org.crsh.cli

Provides the text for a usage, this method can be used to annotate a command class, a command method or a command parameter.

V

ValueType<V> - Class in org.crsh.cli.type

Defines a type for values, this is used for transforming a textual value into a type, for command argument and options.

ValueTypeFactory - Class in org.crsh.cli.type

A factory for value types.

ValueTypeFactory(ClassLoader) - Constructor for class org.crsh.cli.type.ValueTypeFactory

Create a value type factory for the the default value types and the value types that the specified classloader will load.

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