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

A

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

apply(String) - Method in interface com.github.yin.flags.TypeConversion.Conversion

arguments() - Method in class com.github.yin.flags.Flags

Returns an ArgumentIndex instance used to query for argument values.

B

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

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

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

C

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

ClassMetadata - Class in com.github.yin.flags

Stores description and other flag attributes.

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

ClassMetadataIndex - Class in com.github.yin.flags

Stores metadata for classes scanned by java-flags.

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

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

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

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

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

clear() - Static method in class com.github.yin.flags.Flags

Clears the argument values.

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

com.github.yin.flags - package com.github.yin.flags

com.github.yin.flags.analysis - package com.github.yin.flags.analysis

com.github.yin.flags.annotations - package com.github.yin.flags.annotations

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

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

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

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

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

Returns flag value accessor, which can be used to retrieve the actual flag value supplied by command line arguments or by other mechanism (such as initForTesting()).

D

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

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

F

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

Provides Flag value and type-conversion to program classes.

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

FlagDesc - Annotation Type in com.github.yin.flags.annotations

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

FlagID - Class in com.github.yin.flags

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

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

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

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.flags.FlagIndex

FlagMetadata - Class in com.github.yin.flags

Stores description and other flag attributes.

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

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

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

Flags - Class in com.github.yin.flags

Parses program arguments in a specified format and initializes registered static class fields in different application components.

forType(Class<T>) - Method in class com.github.yin.flags.TypeConversion

Returns type-conversion function for given type.

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

G

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

getTypeConversion() - Method in class com.github.yin.flags.Flags

Type conversions used by Flags.

I

init(String[]) - Static method in class com.github.yin.flags.Flags

Initializes flag values from command-line style arguments.

initForTesting(Map<String, String>) - Static method in class com.github.yin.flags.Flags

Indexes flag values from a Map.

P

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

printUsage(String) - Static method in class com.github.yin.flags.Flags

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

R

register(Class<T>, Function<String, T>) - Method in class com.github.yin.flags.TypeConversion

Registers a type conversion.

S

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

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

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

string(String) - Static method in class com.github.yin.flags.Flags

Returns flag value accessor for String type.

T

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

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

TypeConversion - Class in com.github.yin.flags

Stores type conversion functions for Flag accessors.

TypeConversion() - Constructor for class com.github.yin.flags.TypeConversion

TypeConversion.Conversion<T> - Interface in com.github.yin.flags

Converts String value of a flag into the desired type.

U

unregister(Class<T>) - Method in class com.github.yin.flags.TypeConversion

Unregisters type conversion

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

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

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