A C D F G I M N O P S T U V W

A

addViolation(T) - Method in class org.cyclopsgroup.jcli.ValidationResult

Add a new violation to validation result

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

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

Argument - Interface in org.cyclopsgroup.jcli.spi

Model of argument definition

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

ArgumentMissing() - Constructor for class org.cyclopsgroup.jcli.ValidationResult.ArgumentMissing

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 ArgumentProcessor

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

AutoCompletable - Interface in org.cyclopsgroup.jcli

Interface for CLI implementation that knows to suggest options

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

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(LineReader, ParsedLine, List<Candidate>) - Method in class org.cyclopsgroup.jcli.jline.CliCompletor

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

D

DefaultArgumentProcessorFactory - Class in org.cyclopsgroup.jcli.impl

Default implementation of ArgumentProcessorFactory

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

F

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

Create new instance with default parser, a GnuParser

forTypeOf(T) - Static method in class org.cyclopsgroup.jcli.ArgumentProcessor

G

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

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

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

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

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

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

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

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

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

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

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

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

getOptionName() - Method in class org.cyclopsgroup.jcli.ValidationResult.OptionMissing

Get name of missing option

getOptionName() - Method in class org.cyclopsgroup.jcli.ValidationResult.UnexpectedOption

Get name of missing option

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

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

getViolations() - Method in class org.cyclopsgroup.jcli.ValidationResult

Get list of violations in result

GnuParser - Class in org.cyclopsgroup.jcli

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

I

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

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

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

isValid() - Method in class org.cyclopsgroup.jcli.ValidationResult

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

N

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

Name of command line option it detects

newInstance(Class<? extends 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.

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

Deprecated.

Use ArgumentProcessor.forType(Class) instead.

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

Create new instance of ArgumentProcessor.

newProcessor(Class<? extends 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

OptionMissing(String) - Constructor for class org.cyclopsgroup.jcli.ValidationResult.OptionMissing

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

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

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

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

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

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

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

True if option name is a short name

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.spi.CommandLine.OptionValue

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

U

UnexpectedOption(String) - Constructor for class org.cyclopsgroup.jcli.ValidationResult.UnexpectedOption

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

validate(String[]) - Method in class org.cyclopsgroup.jcli.ArgumentProcessor

Verifies if given arguments meet requirement defined for processor.

ValidationResult - Class in org.cyclopsgroup.jcli

Argument validation result coming from ArgumentProcessor.validate(String[])

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

ValidationResult.ArgumentMissing - Class in org.cyclopsgroup.jcli

A violation indicating required argument is missing

ValidationResult.OptionMissing - Class in org.cyclopsgroup.jcli

Type of violation where a required option is missing

ValidationResult.UnexpectedOption - Class in org.cyclopsgroup.jcli

Violation where an unexpected option value is found

ValidationResult.Violation - Class in org.cyclopsgroup.jcli

A validation violation

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.

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.

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 C D F G I M N O P S T U V W