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

A

addArgument(String) - Method in class org.cyclopsgroup.jcli.spi.CommandLine

addOptionValue(String, String, boolean) - Method in class org.cyclopsgroup.jcli.spi.CommandLine

AnnotationArgument - Class in org.cyclopsgroup.jcli.impl

AnnotationArgument(Argument) - Constructor for class org.cyclopsgroup.jcli.impl.AnnotationArgument

AnnotationCli - Class in org.cyclopsgroup.jcli.impl

Annotation based Cli implementation

AnnotationCli(Cli) - Constructor for class org.cyclopsgroup.jcli.impl.AnnotationCli

AnnotationOption - Class in org.cyclopsgroup.jcli.impl

AnnotationOption(Option, boolean, boolean) - Constructor for class org.cyclopsgroup.jcli.impl.AnnotationOption

AnnotationParsingContext<T> - Class in org.cyclopsgroup.jcli.impl

AnnotationParsingContext(Class<T>, Map<String, Reference<T>>, List<AnnotationOption>, AnnotationCli, AnnotationArgument) - Constructor for class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

Argument - Annotation Type in org.cyclopsgroup.jcli.annotation

This annotation marks a property as non-option argument or arguments.

argument() - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

Argument - Interface in org.cyclopsgroup.jcli.spi

Model of argument definition

argument() - Method in interface org.cyclopsgroup.jcli.spi.ParsingContext

ARGUMENT_REFERNCE_NAME - Static variable in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

ArgumentProcessor<T> - Class in org.cyclopsgroup.jcli

The facade class that parses arguments and sets values to given bean

ArgumentProcessor() - Constructor for class org.cyclopsgroup.jcli.ArgumentProcessor

ArgumentProcessorFactory - Class in org.cyclopsgroup.jcli

Factory class for ArguemntProcessor

ArgumentProcessorFactory() - Constructor for class org.cyclopsgroup.jcli.ArgumentProcessorFactory

ArgumentsInspector - Class in org.cyclopsgroup.jcli.jline

Class that consumes arguments

ArgumentsInspector(ParsingContext) - Constructor for class org.cyclopsgroup.jcli.jline.ArgumentsInspector

ArgumentsInspectorState - Enum in org.cyclopsgroup.jcli.jline

Internal inspection state

AutoCompletable - Interface in org.cyclopsgroup.jcli

Interface for CLI implementation that knows to suggest options

B

build() - Method in class org.cyclopsgroup.jcli.impl.ParsingContextBuilder

C

Cli - Annotation Type in org.cyclopsgroup.jcli.annotation

Type annotated with Cli is considered as a command where options and arguments are set

cli() - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

Cli - Interface in org.cyclopsgroup.jcli.spi

Model of a command line

cli() - Method in interface org.cyclopsgroup.jcli.spi.ParsingContext

CliCompletor - Class in org.cyclopsgroup.jcli.jline

JLine completor implemented with JCli

CliCompletor(Object, ValueTokenizer) - Constructor for class org.cyclopsgroup.jcli.jline.CliCompletor

CommandLine - Class in org.cyclopsgroup.jcli.spi

Data that comes from command arguments

CommandLine() - Constructor for class org.cyclopsgroup.jcli.spi.CommandLine

CommandLine.OptionValue - Class in org.cyclopsgroup.jcli.spi

One entry of option value

CommandLine.OptionValue(String, String, boolean) - Constructor for class org.cyclopsgroup.jcli.spi.CommandLine.OptionValue

CommandLineBuilder - Class in org.cyclopsgroup.jcli.spi

A builder class to create CommandLine

CommandLineBuilder() - Constructor for class org.cyclopsgroup.jcli.spi.CommandLineBuilder

CommandLineParser - Interface in org.cyclopsgroup.jcli.spi

Implementation of this interface is aware of syntax of command arguments

complete(String, int, List) - Method in class org.cyclopsgroup.jcli.jline.CliCompletor

consume(String) - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

converter - Variable in class org.cyclopsgroup.jcli.impl.Reference

createParsingContext() - Method in class org.cyclopsgroup.jcli.ArgumentProcessor

createParsingContext() - Method in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

D

DefaultArgumentProcessor<T> - Class in org.cyclopsgroup.jcli.impl

DefaultArgumentProcessor(Class<T>, CommandLineParser) - Constructor for class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

DefaultArgumentProcessorFactory - Class in org.cyclopsgroup.jcli.impl

Default implementation of ArgumentProcessorFactory

DefaultArgumentProcessorFactory() - Constructor for class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessorFactory

E

end() - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

End the process

equals(Object) - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

G

getAction() - Method in class org.cyclopsgroup.jcli.example.UserControl

getArguments() - Method in class org.cyclopsgroup.jcli.spi.CommandLine

getContext() - Method in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

getCreationDate() - Method in class org.cyclopsgroup.jcli.example.UserControl

getCurrentOption() - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

getCurrentValue() - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

getDefaultValue() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

getDefaultValue() - Method in interface org.cyclopsgroup.jcli.spi.Option

getDescription() - Method in class org.cyclopsgroup.jcli.impl.AnnotationArgument

getDescription() - Method in class org.cyclopsgroup.jcli.impl.AnnotationCli

getDescription() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

getDescription() - Method in class org.cyclopsgroup.jcli.impl.OptionHelp

getDescription() - Method in interface org.cyclopsgroup.jcli.spi.Argument

getDescription() - Method in interface org.cyclopsgroup.jcli.spi.Cli

getDescription() - Method in interface org.cyclopsgroup.jcli.spi.Option

getDisplayName() - Method in class org.cyclopsgroup.jcli.impl.AnnotationArgument

getDisplayName() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

getDisplayName() - Method in class org.cyclopsgroup.jcli.impl.OptionHelp

getDisplayName() - Method in interface org.cyclopsgroup.jcli.spi.Argument

getDisplayName() - Method in interface org.cyclopsgroup.jcli.spi.Option

getInstance() - Static method in class org.cyclopsgroup.jcli.ArgumentProcessorFactory

getIntValue() - Method in class org.cyclopsgroup.jcli.example.UserControl

getLongName() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

getLongName() - Method in class org.cyclopsgroup.jcli.impl.OptionHelp

getLongName() - Method in interface org.cyclopsgroup.jcli.spi.Option

getName() - Method in class org.cyclopsgroup.jcli.impl.AnnotationCli

getName() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

getName() - Method in class org.cyclopsgroup.jcli.impl.OptionHelp

getName() - Method in interface org.cyclopsgroup.jcli.spi.Cli

getName() - Method in interface org.cyclopsgroup.jcli.spi.Option

getNote() - Method in class org.cyclopsgroup.jcli.impl.AnnotationCli

getNote() - Method in interface org.cyclopsgroup.jcli.spi.Cli

getOptionValues() - Method in class org.cyclopsgroup.jcli.spi.CommandLine

getRemainingOptions() - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

getState() - Method in class org.cyclopsgroup.jcli.jline.ArgumentsInspector

getUserNames() - Method in class org.cyclopsgroup.jcli.example.UserControl

GnuParser - Class in org.cyclopsgroup.jcli

GnuParser() - Constructor for class org.cyclopsgroup.jcli.GnuParser

H

hashCode() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

I

isFlag() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

isFlag() - Method in interface org.cyclopsgroup.jcli.spi.Option

isMultiValue() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

isMultiValue() - Method in interface org.cyclopsgroup.jcli.spi.Option

isRequired() - Method in class org.cyclopsgroup.jcli.impl.AnnotationOption

isRequired() - Method in interface org.cyclopsgroup.jcli.spi.Option

L

longName - Variable in class org.cyclopsgroup.jcli.impl.Reference

lookupReference(String, boolean) - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

Find reference with given name of option or argument

M

main(String[]) - Static method in class org.cyclopsgroup.jcli.example.UserControl

MultiValue - Annotation Type in org.cyclopsgroup.jcli.annotation

Mark an option that takes multple values

MultiValueReference<T> - Class in org.cyclopsgroup.jcli.impl

MultiValueReference(Class<T>, Converter<?>, ValueReference<T>, String, Class<?>) - Constructor for class org.cyclopsgroup.jcli.impl.MultiValueReference

N

name - Variable in class org.cyclopsgroup.jcli.spi.CommandLine.OptionValue

Name of command line option it detects

newInstance(Class<T>) - Static method in class org.cyclopsgroup.jcli.ArgumentProcessor

Create new instance with default parser, a GnuParser

newInstance(Class<T>, CommandLineParser) - Static method in class org.cyclopsgroup.jcli.ArgumentProcessor

Create new instance with given bean type and command line parser that describes command line sytnax

newProcessor(Class<T>, CommandLineParser) - Method in class org.cyclopsgroup.jcli.ArgumentProcessorFactory

Create new instance of ArgumentProcessor.

newProcessor(Class<T>, CommandLineParser) - Method in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessorFactory

O

Option - Annotation Type in org.cyclopsgroup.jcli.annotation

Option of command

Option - Interface in org.cyclopsgroup.jcli.spi

Meta data for an option

OptionHelp - Class in org.cyclopsgroup.jcli.impl

An internal POJO to help printing out usage page

OptionHelp(Option) - Constructor for class org.cyclopsgroup.jcli.impl.OptionHelp

options() - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

options() - Method in interface org.cyclopsgroup.jcli.spi.ParsingContext

optionWithLongName(String) - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

optionWithLongName(String) - Method in interface org.cyclopsgroup.jcli.spi.ParsingContext

optionWithShortName(String) - Method in class org.cyclopsgroup.jcli.impl.AnnotationParsingContext

optionWithShortName(String) - Method in interface org.cyclopsgroup.jcli.spi.ParsingContext

org.cyclopsgroup.jcli - package org.cyclopsgroup.jcli

General utilities used by jcli package

org.cyclopsgroup.jcli.annotation - package org.cyclopsgroup.jcli.annotation

Annotations that defines command line syntax

org.cyclopsgroup.jcli.example - package org.cyclopsgroup.jcli.example

org.cyclopsgroup.jcli.impl - package org.cyclopsgroup.jcli.impl

org.cyclopsgroup.jcli.jline - package org.cyclopsgroup.jcli.jline

Provides classes needed for jline(http://jline.sf.net) integration

org.cyclopsgroup.jcli.spi - package org.cyclopsgroup.jcli.spi

Service provider API for implementations

P

parse(List<String>, ParsingContext) - Method in class org.cyclopsgroup.jcli.GnuParser

parse(List<String>, ParsingContext) - Method in interface org.cyclopsgroup.jcli.spi.CommandLineParser

ParsingContext - Interface in org.cyclopsgroup.jcli.spi

Context for parsing arguments for given bean

ParsingContextBuilder<T> - Class in org.cyclopsgroup.jcli.impl

Internal builder to create instance of AnnotationParsingContext

ParsingContextBuilder(Class<T>) - Constructor for class org.cyclopsgroup.jcli.impl.ParsingContextBuilder

printHelp(PrintWriter) - Method in class org.cyclopsgroup.jcli.ArgumentProcessor

printHelp(PrintWriter) - Method in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

process(List<String>, T) - Method in class org.cyclopsgroup.jcli.ArgumentProcessor

Process argument list and pass values to given bean

process(String[], T) - Method in class org.cyclopsgroup.jcli.ArgumentProcessor

Process argument array and pass values to given bean

process(List<String>, T) - Method in class org.cyclopsgroup.jcli.impl.DefaultArgumentProcessor

R

ref - Variable in class org.cyclopsgroup.jcli.impl.Reference

Reference<T> - Class in org.cyclopsgroup.jcli.impl

A reference to allow to set value as an attribute of bean

Reference(Class<T>, Converter<?>, ValueReference<T>, String) - Constructor for class org.cyclopsgroup.jcli.impl.Reference

S

setAction(UserControlAction) - Method in class org.cyclopsgroup.jcli.example.UserControl

setCreationDate(Date) - Method in class org.cyclopsgroup.jcli.example.UserControl

setIntValue(int) - Method in class org.cyclopsgroup.jcli.example.UserControl

setUserNames(List<String>) - Method in class org.cyclopsgroup.jcli.example.UserControl

setValue(T, String) - Method in class org.cyclopsgroup.jcli.impl.SingleValueReference

Set a string value to bean based on known conversion rule and value reference

setValues(T, List<String>) - Method in class org.cyclopsgroup.jcli.impl.MultiValueReference

Write multi value to bean

shortName - Variable in class org.cyclopsgroup.jcli.spi.CommandLine.OptionValue

True if option name is a short name

SingleValueReference<T> - Class in org.cyclopsgroup.jcli.impl

SingleValueReference(Class<T>, Converter<?>, ValueReference<T>, String) - Constructor for class org.cyclopsgroup.jcli.impl.SingleValueReference

suggestArgument(String) - Method in interface org.cyclopsgroup.jcli.AutoCompletable

Suggest candidates for argument with given partial input

suggestOption(String, String) - Method in interface org.cyclopsgroup.jcli.AutoCompletable

Suggest candidates for an option with given partial input

T

toCommandLine() - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

toString() - Method in class org.cyclopsgroup.jcli.example.UserControl

toString() - Method in class org.cyclopsgroup.jcli.impl.Reference

toString() - Method in class org.cyclopsgroup.jcli.spi.CommandLine.OptionValue

toString() - Method in class org.cyclopsgroup.jcli.spi.CommandLine

U

UserControl - Class in org.cyclopsgroup.jcli.example

An example bean that shows how JCli populates POJO with arguments

UserControl() - Constructor for class org.cyclopsgroup.jcli.example.UserControl

UserControlAction - Enum in org.cyclopsgroup.jcli.example

Enum used in example

V

value - Variable in class org.cyclopsgroup.jcli.spi.CommandLine.OptionValue

Detected value

valueOf(String) - Static method in enum org.cyclopsgroup.jcli.example.UserControlAction

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

valueOf(String) - Static method in enum org.cyclopsgroup.jcli.jline.ArgumentsInspectorState

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

values() - Static method in enum org.cyclopsgroup.jcli.example.UserControlAction

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

values() - Static method in enum org.cyclopsgroup.jcli.jline.ArgumentsInspectorState

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

W

withArgument(String) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

withArguments(Collection<String>) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

withLongFlag(String) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

Add a flag option with its long name

withLongOption(String, String) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

Add an option with its long name

withShortFlag(String) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

Add a flag option with its short name

withShortOption(String, String) - Method in class org.cyclopsgroup.jcli.spi.CommandLineBuilder

Add an option with its short name

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