Index (picocli-codegen 4.7.5 API)

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

A

AbstractCommandSpecProcessor - Class in picocli.codegen.annotation.processing: Abstract annotation processor for @picocli.* annotations that produces a set of CommandLine.Model.CommandSpec objects built from the annotated source code.
AbstractCommandSpecProcessor() - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
AnnotatedElementHolder - Class in picocli.codegen.annotation.processing: Implementation of the CommandLine.Model.IGetter and CommandLine.Model.ISetter interface that allows custom CommandSpec annotation processors to inspect ArgSpec objects to discover what program element was annotated with @Option or @Parameters.
AnnotatedElementHolder(Element) - Constructor for class picocli.codegen.annotation.processing.AnnotatedElementHolder: Constructs a new AnnotatedElementHolder with the specified element
Assert - Class in picocli.codegen.util: Utility class providing some defensive coding convenience methods.

B

BASE_PATH - Static variable in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor: Base path where generated files will be written to: "META-INF/native-image/picocli-generated/".

C

call() - Method in class picocli.codegen.docgen.manpage.ManPageGenerator: Invokes ManPageGenerator.generateManPage(Config, CommandLine.Model.CommandSpec...) to generate man pages for all non-hidden commands in the hierarchy from the top-level command down.
closeSilently(Closeable) - Static method in class picocli.codegen.util.Util

D

DynamicProxyConfigGenerator - Class in picocli.codegen.aot.graalvm: DynamicProxyConfigGenerator generates a JSON String with the fully qualified interface names for which dynamic proxy classes should be generated at native image build time.
DynamicProxyConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator

E

equals(Object, Object) - Static method in class picocli.codegen.util.Assert
error(Element, String, Object...) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Prints a compile-time error message for the specified element.

F

fatalError(String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Prints a compile-time error message prefixed with "FATAL ERROR".
format(LogRecord) - Method in class picocli.codegen.util.JulLogFormatter

G

generateManPage(File, File, boolean[], boolean, CommandLine.Model.CommandSpec...) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator: Generates AsciiDoc files for the specified classes to the specified output directory, optionally also generating template files in the customizablePagesDirectory directory.
generateProxyConfig(CommandLine.Model.CommandSpec[], String[]) - Static method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator: Returns a JSON String with the interface names to generate dynamic proxy classes for in the native image, used by the specified CommandSpec objects.
generateReflectionConfig(CommandLine.Model.CommandSpec...) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator: Returns a JSON String with the program elements that will be accessed reflectively for the specified CommandSpec objects.
generateResourceConfig(CommandLine.Model.CommandSpec[], String[], String[]) - Static method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator: Returns a JSON String with the resources and resource bundles to include for the specified CommandSpec objects.
get() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder: This implementation does nothing and always returns null.
getCommandSpecs(String, Class<?>[]) - Static method in class picocli.codegen.util.Util
getElement() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder: Returns the program element annotated with @Option or @Parameters.
getSupportedAnnotationTypes() - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Returns the annotation types supported by the super class, and adds "picocli.*" if necessary.
getSupportedSourceVersion() - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Returns the max supported source version.
getTypeElement() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData: Returns the TypeElement of the type mirror.
getTypeMirror() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData: Returns the TypeMirror of the value.

H

handleCommands(Map<Element, CommandLine.Model.CommandSpec>, Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Subclasses must implement this method and do something with the CommandSpec command model objects that were found during compilation.
hashCode(Object) - Static method in class picocli.codegen.util.Assert
hashCode(boolean) - Static method in class picocli.codegen.util.Assert

I

init(ProcessingEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
init(ProcessingEnvironment) - Method in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
isDefault() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData: Returns true if the annotated element did not have the annotation attribute.
ITypeMetaData - Interface in picocli.codegen.annotation.processing: Abstraction over annotation attributes that take a class (or array of classes) as their value.

J

JniConfigGenerator - Class in picocli.codegen.aot.graalvm
JniConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.JniConfigGenerator
JulLogFormatter - Class in picocli.codegen.util
JulLogFormatter() - Constructor for class picocli.codegen.util.JulLogFormatter

L

logInfo(String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Prints a compile-time NOTE message.

M

main(String...) - Static method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator: Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.JniConfigGenerator: Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator: Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator: Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator: Invokes ManPageGenerator.generateManPage(Config, CommandLine.Model.CommandSpec...) to generate man pages for the user-specified @Command-annotated classes.
ManPageGenerator - Class in picocli.codegen.docgen.manpage: Generates AsciiDoc files in a special format that can be converted to HTML, PDF and Unix Man pages.
ManPageGenerator() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator

N

NativeImageConfigGeneratorProcessor - Class in picocli.codegen.aot.graalvm.processor
NativeImageConfigGeneratorProcessor() - Constructor for class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
notNull(T, String) - Static method in class picocli.codegen.util.Assert: Throws a NullPointerException if the specified object is null.

O

OPTION_PROJECT - Static variable in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor: Name of the annotation processor option that can be used to control the actual location where the generated file(s) are to be written to, relative to the NativeImageConfigGeneratorProcessor.BASE_PATH.

P

picocli.codegen.annotation.processing - package picocli.codegen.annotation.processing: Provides classes and interfaces that form a framework for creating picocli annotation processors.
picocli.codegen.aot.graalvm - package picocli.codegen.aot.graalvm: Provides tools for generating GraalVM configuration files from a picocli CommandSpec model.
picocli.codegen.aot.graalvm.processor - package picocli.codegen.aot.graalvm.processor: Provides an annotation processor that generates GraalVM configuration files based on a picocli CommandSpec model.
picocli.codegen.docgen.manpage - package picocli.codegen.docgen.manpage: Provides tools for generating man-page documentation in AsciiDoc format from a picocli CommandSpec model.
picocli.codegen.util - package picocli.codegen.util: Provides utility classes for internal use in the picocli-codegen module.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
processingEnv - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: The ProcessingEnvironment set by the AbstractCommandSpecProcessor.init(ProcessingEnvironment) method.

R

ReflectionConfigGenerator - Class in picocli.codegen.aot.graalvm: ReflectionConfigGenerator generates a JSON String with the program elements that will be accessed reflectively in a picocli-based application, in order to compile this application ahead-of-time into a native executable with GraalVM.
ReflectionConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
ResourceConfigGenerator - Class in picocli.codegen.aot.graalvm: ResourceConfigGenerator generates a JSON String with the resource bundles and other classpath resources that should be included in the Substrate VM native image.
ResourceConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.ResourceConfigGenerator

S

set(T) - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder: This implementation does nothing.
setLoadResourceBundles(boolean) - Static method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: During annotation processing, resource bundles may not be available on the classpath and thereby cause failures.

T

toString() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder: Returns a string representation of this binding, for debugging purposes.

U

Util - Class in picocli.codegen.util

W

warn(Element, String, Object...) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor: Prints a compile-time warning message for the specified element.
writeSingleManPage(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator

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