A B C D F G I L P R S T U

A

add(FlagID, T) - Method in class com.github.yin.cli.FlagIndex

allArguments(FlagID) - Method in class com.github.yin.cli.Cli

apply(String) - Method in interface com.github.yin.cli.TypeConversions.Conversion

B

byClass() - Method in class com.github.yin.cli.FlagIndex

byFQN() - Method in class com.github.yin.cli.FlagIndex

byName() - Method in class com.github.yin.cli.FlagIndex

C

classes() - Method in class com.github.yin.cli.ClassMetadataIndex

ClassMetadata - Class in com.github.yin.cli

Stores description and other flag attributes.

ClassMetadata() - Constructor for class com.github.yin.cli.ClassMetadata

ClassMetadataIndex - Class in com.github.yin.cli

Stores metadata for classes scanned by java-cli.

ClassMetadataIndex() - Constructor for class com.github.yin.cli.ClassMetadataIndex

className() - Method in class com.github.yin.cli.ClassMetadata

className() - Method in class com.github.yin.cli.FlagID

ClassScanner - Class in com.github.yin.cli.annotations

ClassScanner() - Constructor for class com.github.yin.cli.annotations.ClassScanner

clear() - Static method in class com.github.yin.cli.Cli

Clears flag values after test case completes.

Cli - Class in com.github.yin.cli

Stores arguments values and provides Flag accessors for the values.

collectFlagInfo(Class<?>, FlagIndex<FlagMetadata>) - Method in class com.github.yin.cli.annotations.ClassScanner

com.github.yin.cli - package com.github.yin.cli

com.github.yin.cli.analysis - package com.github.yin.cli.analysis

com.github.yin.cli.annotations - package com.github.yin.cli.annotations

com.github.yin.cli.parsing - package com.github.yin.cli.parsing

compareTo(FlagID) - Method in class com.github.yin.cli.FlagID

compareTo(FlagMetadata) - Method in class com.github.yin.cli.FlagMetadata

create(String, String) - Static method in class com.github.yin.cli.ClassMetadata

create(Class<T>, String) - Static method in class com.github.yin.cli.Cli

Returns flag value accessor, which can be used to retrieve the flag value supplied by command line arguments.

create(String, String, String, Class<T>) - Static method in class com.github.yin.cli.FlagMetadata

D

desc() - Method in class com.github.yin.cli.ClassMetadata

desc() - Method in class com.github.yin.cli.FlagMetadata

F

Flag<T> - Class in com.github.yin.cli

Provides Flag value and type-conversion to program classes.

Flag() - Constructor for class com.github.yin.cli.Flag

FlagID - Class in com.github.yin.cli

FlagID() - Constructor for class com.github.yin.cli.FlagID

flagID() - Method in class com.github.yin.cli.FlagMetadata

FlagIndex<T> - Class in com.github.yin.cli

Stores value objects indexed by FlagID in a Multimap fashion and allows for easy access by any FlagID attribute.

FlagIndex() - Constructor for class com.github.yin.cli.FlagIndex

FlagMetadata - Class in com.github.yin.cli

Stores description and other flag attributes.

FlagMetadata() - Constructor for class com.github.yin.cli.FlagMetadata

flagName() - Method in class com.github.yin.cli.FlagID

flags() - Method in class com.github.yin.cli.Flag

forType(Class<T>) - Method in interface com.github.yin.cli.TypeConversions

forType(Class<T>) - Method in class com.github.yin.cli.TypeConversionsImpl

Returns type-conversion function for given type.

fqn() - Method in class com.github.yin.cli.FlagID

G

get() - Method in class com.github.yin.cli.Flag

getTypeConversions() - Method in class com.github.yin.cli.Cli

Type conversions used by Cli.

I

init(String[]) - Static method in class com.github.yin.cli.Cli

Initializes flag values from array of command-line arguments.

init(ImmutableMultimap<String, String>) - Static method in class com.github.yin.cli.Cli

Initializes flag values from an ImmutableMultimap.

L

LongKeyValueParser - Class in com.github.yin.cli.parsing

Parses program arguments and recognize long-format cli, each flag name argument must be followed by its value.

LongKeyValueParser(String[]) - Constructor for class com.github.yin.cli.parsing.LongKeyValueParser

P

parse() - Method in class com.github.yin.cli.parsing.LongKeyValueParser

printUsage(FlagIndex<FlagMetadata>, ClassMetadataIndex, PrintStream) - Method in class com.github.yin.cli.analysis.UsagePrinter

printUsage(String) - Static method in class com.github.yin.cli.Cli

Prints user-readable usage help for all cli in a given package

R

register(Class<T>, TypeConversions.Conversion<T>) - Method in interface com.github.yin.cli.TypeConversionRegistrar

register(Class<T>, TypeConversions.Conversion<T>) - Method in class com.github.yin.cli.TypeConversionsImpl

Registers a type conversion.

S

scanClass(String, FlagIndex<FlagMetadata>, ClassMetadataIndex) - Method in class com.github.yin.cli.annotations.ClassScanner

scanClass(Class<?>, FlagIndex<FlagMetadata>, ClassMetadataIndex) - Method in class com.github.yin.cli.annotations.ClassScanner

scanPackage(String, FlagIndex<FlagMetadata>, ClassMetadataIndex) - Method in class com.github.yin.cli.annotations.ClassScanner

singleArgument(FlagID) - Method in class com.github.yin.cli.Cli

string(String) - Static method in class com.github.yin.cli.Cli

Returns flag value accessor for String type.

T

type() - Method in class com.github.yin.cli.FlagMetadata

TypeConversionRegistrar - Interface in com.github.yin.cli

Registers TypeConversions.Conversion's constructed using old Java6 inheritance.

typeConversions() - Method in class com.github.yin.cli.Flag

TypeConversions - Interface in com.github.yin.cli

I am so stupid, that I forgotten to change this javadoc, me fool.

TypeConversions.Conversion<T> - Interface in com.github.yin.cli

Converts String value of a flag into the desired type.

TypeConversionsImpl - Class in com.github.yin.cli

Stores and provides type conversion functions for Flag accessors.

TypeConversionsImpl() - Constructor for class com.github.yin.cli.TypeConversionsImpl

U

unregister(Class<T>) - Method in interface com.github.yin.cli.TypeConversions

unregister(Class<T>) - Method in class com.github.yin.cli.TypeConversionsImpl

Unregisters type conversion

Usage - Annotation Type in com.github.yin.cli.annotations

Annotates class and fields with flag descriptions, seen in e.g.

UsagePrinter - Class in com.github.yin.cli.analysis

UsagePrinter() - Constructor for class com.github.yin.cli.analysis.UsagePrinter

A B C D F G I L P R S T U