Index
All Classes|All Packages|Constant Field Values|Serialized Form
A
- accept(String) - Method in class com.github.sormuras.bach.Logbook
- args() - Method in record class com.github.sormuras.bach.tool.Command
-
Returns the value of the
args
record component. - args() - Method in interface com.github.sormuras.bach.tool.ToolCall
-
Return the possibly empty list of arguments of this tool call.
- args() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
args
record component. - arguments() - Method in record class com.github.sormuras.bach.project.Tweak
-
Returns the value of the
arguments
record component. - arguments(String) - Method in record class com.github.sormuras.bach.project.Tweaks
-
Returns a possibly empty list of additional arguments for the given trigger.
- AUTO - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Detect type of link automatically.
B
- bach() - Method in class com.github.sormuras.bach.Builder
- Bach - Class in com.github.sormuras.bach
-
Java Shell Builder.
- Bach(Logbook, Supplier<HttpClient>) - Constructor for class com.github.sormuras.bach.Bach
-
Initialize default constructor.
- build() - Method in class com.github.sormuras.bach.Builder
-
Builds a modular Java project.
- build() - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Builds and returns a command from its components.
- build(Bach, String...) - Method in interface com.github.sormuras.bach.BuildProgram
-
Builds a modular Java project.
- build(String...) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Builds a project by delegating to the default build sequence.
- buildAllSpaces(CodeSpaces) - Method in class com.github.sormuras.bach.Builder
-
Builds all code spaces.
- builder(String) - Static method in record class com.github.sormuras.bach.tool.Command
-
Instantiates a builder to build a command.
- Builder - Class in com.github.sormuras.bach
-
A modular Java project builder.
- Builder(Bach, Project) - Constructor for class com.github.sormuras.bach.Builder
-
Initialize this builder with the given components.
- BuildException - Exception in com.github.sormuras.bach
-
An exception thrown at build time.
- BuildException(String) - Constructor for exception com.github.sormuras.bach.BuildException
-
Initialize this build-related exception with the specified detail message.
- buildMainCodeSpace(MainCodeSpace) - Method in class com.github.sormuras.bach.Builder
-
Builds the main space.
- buildMainSingleReleaseVintageModules(int) - Method in class com.github.sormuras.bach.Builder
-
Builds all modules targeting Java 7 or Java 8.
- BuildProgram - Interface in com.github.sormuras.bach
-
The
BuildProgram
interface should be implemented by custom build programs. - buildTestCodeSpace(TestCodeSpace) - Method in class com.github.sormuras.bach.Builder
-
Builds the test space.
C
- checkSuccessful() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns silently if this response represents a successful tool call run.
- classes() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a resolved path.
- classes() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
- classes(int) - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a resolved path.
- classes(int, String) - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a resolved path.
- classifier() - Static method in class com.github.sormuras.bach.project.ModuleLookup.JavaFX
- classifier() - Static method in class com.github.sormuras.bach.project.ModuleLookup.LWJGL
- code() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
code
record component. - CodeSpaces - Record Class in com.github.sormuras.bach.project
-
A set of well-known code spaces.
- CodeSpaces(MainCodeSpace, TestCodeSpace) - Constructor for record class com.github.sormuras.bach.project.CodeSpaces
-
Creates an instance of a
CodeSpaces
record class. - com.github.sormuras.bach - module com.github.sormuras.bach
-
Defines the API of 🎼 Bach, the Java Shell Builder.
- com.github.sormuras.bach - package com.github.sormuras.bach
-
Provides the classes and interfaces of 🎼 Bach, the Java Shell Builder.
- com.github.sormuras.bach.project - package com.github.sormuras.bach.project
-
Provides the classes and interfaces for Bach's
Project
API. - com.github.sormuras.bach.tool - package com.github.sormuras.bach.tool
-
Provides the classes and interfaces of the tool-related API.
- command() - Method in record class com.github.sormuras.bach.project.Launcher
- Command - Record Class in com.github.sormuras.bach.tool
-
An immutable tool call implementation.
- Command(String, List<String>) - Constructor for record class com.github.sormuras.bach.tool.Command
-
Creates an instance of a
Command
record class. - Command.Builder - Class in com.github.sormuras.bach.tool
-
A builder for building
Command
objects. - compareTo(ExternalModule) - Method in record class com.github.sormuras.bach.project.ExternalModule
- compareTo(ModuleDeclaration) - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
- compileModulesForJavaRelease() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- compose(ModuleLookup...) - Static method in interface com.github.sormuras.bach.project.ModuleLookup
-
Returns a module lookup that is composed from a sequence of zero or more module lookup objects.
- computeMainDocumentationJarCall() - Method in class com.github.sormuras.bach.Builder
- computeMainDocumentationJavadocCall() - Method in class com.github.sormuras.bach.Builder
- computeMainJarCall(ModuleDeclaration) - Method in class com.github.sormuras.bach.Builder
- computeMainJarFileName(ModuleDeclaration) - Method in class com.github.sormuras.bach.Builder
- computeMainJarTargetedDirectories(ModuleDeclaration) - Method in class com.github.sormuras.bach.Builder
- computeMainJavacCall(int) - Method in class com.github.sormuras.bach.Builder
- computeMainJavacCall(String, SourceFolder) - Method in class com.github.sormuras.bach.Builder
- computeMainJLinkCall() - Method in class com.github.sormuras.bach.Builder
- computeMessageText(StringWriter) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Computes a string from the characters buffered in the given writer.
- computeModuleLookup() - Method in class com.github.sormuras.bach.Builder
-
Returns a module lookup composed of external module links and best-effort lookup.
- computeTestJarCall(ModuleDeclaration) - Method in class com.github.sormuras.bach.Builder
- computeTestJavacCall() - Method in class com.github.sormuras.bach.Builder
- computeTestJUnitCall(ModuleDeclaration) - Method in class com.github.sormuras.bach.Builder
- computeToolCallArgumentsDescription(ToolCall, int) - Method in class com.github.sormuras.bach.Builder
-
Returns a description of the given tool call.
- computeToolProvider(String) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Computes an instance of
ToolProvider
for the given name.
D
- debug(String, Object...) - Method in class com.github.sormuras.bach.Bach
-
Log a formatted message at debug level.
- describeModule(String) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints a module description of the given module.
- documentation(String) - Method in record class com.github.sormuras.bach.project.MainCodeSpace
- duration() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
duration
record component.
E
- equals(Object) - Method in record class com.github.sormuras.bach.project.CodeSpaces
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.ExternalModule
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.ExternalModules
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.Features
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.Launcher
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.ModulePaths
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.Project
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.SourceFolder
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.SourceFolders
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.Tweak
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.project.Tweaks
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.tool.Command
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Indicates whether some other object is "equal to" this one.
- err() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
err
record component. - execute(Bach, String...) - Static method in interface com.github.sormuras.bach.BuildProgram
-
Builds a modular Java project.
- execute(PrintWriter, PrintWriter, String...) - Method in class com.github.sormuras.bach.Main
-
Main program.
- execute(String...) - Static method in interface com.github.sormuras.bach.BuildProgram
-
Builds a modular Java project using the default build program with an Bach instance that is using components configured from system properties.
- EXTERNAL_MODULES - Static variable in annotation interface com.github.sormuras.bach.project.ProjectInfo
-
Path to the directory that collects downloaded external modules.
- ExternalModule - Record Class in com.github.sormuras.bach.project
-
A module-uri pair used to connect a module name to a specific modular JAR file.
- ExternalModule(String, String) - Constructor for record class com.github.sormuras.bach.project.ExternalModule
-
Creates an instance of a
ExternalModule
record class. - ExternalModuleBuilder - Class in com.github.sormuras.bach.project
-
A builder of external module objects.
- ExternalModuleBuilder(String) - Constructor for class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Constructs an instance of this class with the given components.
- ExternalModules - Record Class in com.github.sormuras.bach.project
-
An external modules configuration.
- ExternalModules(Set<String>, Map<String, ExternalModule>) - Constructor for record class com.github.sormuras.bach.project.ExternalModules
-
Creates an instance of a
ExternalModules
record class. - externals() - Method in record class com.github.sormuras.bach.project.Project
-
Returns the value of the
externals
record component. - EXTERNALS - Static variable in class com.github.sormuras.bach.Bach
-
Path to directory with external modules.
F
- Feature - Enum Class in com.github.sormuras.bach.project
-
A feature flag.
- features() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
features
record component. - features() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- Features - Record Class in com.github.sormuras.bach.project
-
A feature set.
- Features(Set<Feature>) - Constructor for record class com.github.sormuras.bach.project.Features
-
Creates an instance of a
Features
record class. - find(String) - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
- find(String) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints a listing of all files matching the given glob pattern.
- findAll() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
- finder() - Method in record class com.github.sormuras.bach.project.CodeSpaces
- finder() - Method in record class com.github.sormuras.bach.project.ExternalModules
- first() - Method in record class com.github.sormuras.bach.project.SourceFolders
G
- GENERATE_API_DOCUMENTATION - Enum constant in enum class com.github.sormuras.bach.project.Feature
-
Call
javadoc
to generate HTML pages of API documentation from main source files. - GENERATE_CUSTOM_RUNTIME_IMAGE - Enum constant in enum class com.github.sormuras.bach.project.Feature
-
Call
jlink
to assemble main modules and their dependencies into a runtime image. - GENERATE_MAVEN_POM_FILES - Enum constant in enum class com.github.sormuras.bach.project.Feature
-
Generate Maven-based consumer POM files.
H
- hashCode() - Method in record class com.github.sormuras.bach.project.CodeSpaces
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.ExternalModules
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.Features
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.Launcher
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.ModulePaths
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.Project
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.SourceFolder
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.SourceFolders
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.Tweak
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.project.Tweaks
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.tool.Command
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns a hash code value for this object.
- history() - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Returns the history of tool calls as recorded in response objects.
- httpClient() - Method in class com.github.sormuras.bach.Bach
-
Returns the http client for downloading files.
- httpCopy(URI, Path) - Method in class com.github.sormuras.bach.Bach
-
Copy all content and attributes from a uri to a target file.
- httpCopy(URI, Path, CopyOption...) - Method in class com.github.sormuras.bach.Bach
-
Copy all content from a uri to a target file.
- httpRead(URI) - Method in class com.github.sormuras.bach.Bach
-
Read all content from a uri into a string.
I
- in() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Tweak
- INCLUDE_SOURCES_IN_MODULAR_JAR - Enum constant in enum class com.github.sormuras.bach.project.Feature
-
Include
*.java
files alongside with*.class
files into each modular JAR. - info() - Method in class com.github.sormuras.bach.project.ModuleInfoReference
- info(String, Object...) - Method in class com.github.sormuras.bach.Bach
-
Log a formatted message at info level.
- INFO - Static variable in class com.github.sormuras.bach.Bach
-
Default
project-info
annotation instance. - is(Feature) - Method in record class com.github.sormuras.bach.project.MainCodeSpace
- isEmpty() - Method in record class com.github.sormuras.bach.project.CodeSpaces
- isEmpty() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
- isError() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns
true
if this response represents an errored tool call run. - isGenerateApiDocumentation() - Method in class com.github.sormuras.bach.Builder
- isGenerateCustomRuntimeImage() - Method in class com.github.sormuras.bach.Builder
- isGenerateMavenPomFiles() - Method in class com.github.sormuras.bach.Builder
- isIncludeSourcesInModules() - Method in class com.github.sormuras.bach.Builder
- isModuleInfoJavaPresent() - Method in record class com.github.sormuras.bach.project.SourceFolder
- isSuccessful() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns
true
if this response represents a successful tool call run. - isTargeted() - Method in record class com.github.sormuras.bach.project.SourceFolder
J
- jar(String) - Method in record class com.github.sormuras.bach.project.ExternalModules
- jarslug() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
jarslug
record component. - JavaFX(String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.JavaFX
-
Constructs a new module searcher with the given version.
- JavaFX(String, String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.JavaFX
-
Constructs a new module searcher with the given version.
- JUnitJupiter(String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.JUnitJupiter
-
Constructs a new module searcher with the given version.
- JUnitJupiter_5_7() - Constructor for class com.github.sormuras.bach.project.ModuleLookups.JUnitJupiter_5_7
-
Default constructor.
- JUnitPlatform(String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.JUnitPlatform
-
Constructs a new module searcher with the given version.
- JUnitPlatform_1_7() - Constructor for class com.github.sormuras.bach.project.ModuleLookups.JUnitPlatform_1_7
-
Constructs a new module searcher with the given version.
L
- launchCustomRuntimeImageWithModule() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- launcher() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
launcher
record component. - Launcher - Record Class in com.github.sormuras.bach.project
-
A launcher command configuration.
- Launcher(String, String) - Constructor for record class com.github.sormuras.bach.project.Launcher
-
Creates an instance of a
Launcher
record class. - link(String) - Static method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns an external module builder for the given module name.
- linkModule(String, String) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Links the given module name to the specified target, usually a URI of a remote JAR file.
- links() - Method in record class com.github.sormuras.bach.project.ExternalModules
-
Returns the value of the
links
record component. - links() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- list() - Method in record class com.github.sormuras.bach.project.SourceFolders
-
Returns the value of the
list
record component. - list() - Method in record class com.github.sormuras.bach.project.Tweaks
-
Returns the value of the
list
record component. - listLoadedModules() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints a list of all loaded modules.
- listMissingModules() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints all missing modules.
- listModuleLinks() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints all module links.
- listPublicStaticMethods() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints all public static method names.
- listSystemModules() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints a list of all system modules.
- listToolProviders() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Prints all available tool provider implementations.
- loadMissingModules() - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Loads all missing modules.
- loadMissingModules(ExternalModules, ModuleLookup) - Method in class com.github.sormuras.bach.Bach
-
Load all missing modules of the given module directory.
- loadModule(ExternalModules, ModuleLookup, String) - Method in class com.github.sormuras.bach.Bach
-
Load a module.
- loadModule(String) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Loads the given module.
- loadRequiredAndMissingModules() - Method in class com.github.sormuras.bach.Builder
-
Load required and missing modules in a best-effort manner.
- log(ToolResponse) - Method in class com.github.sormuras.bach.Logbook
-
Adds the given response to the list of responses.
- log(System.Logger.Level, String) - Method in class com.github.sormuras.bach.Logbook
-
Returns the formatted message after logging it.
- log(System.Logger.Level, String, Object...) - Method in class com.github.sormuras.bach.Logbook
-
Returns the formatted message after logging it.
- logbook() - Method in class com.github.sormuras.bach.Bach
-
Returns the logbook.
- Logbook - Class in com.github.sormuras.bach
-
A logbook records text messages.
- Logbook(Consumer<String>, System.Logger.Level) - Constructor for class com.github.sormuras.bach.Logbook
-
Initialize a logbook with the given components.
- lookup(String) - Method in record class com.github.sormuras.bach.project.ExternalModules
- lookup(String) - Method in class com.github.sormuras.bach.project.ModuleLookup.JavaFX
- lookup(String) - Method in class com.github.sormuras.bach.project.ModuleLookup.JUnitJupiter
- lookup(String) - Method in class com.github.sormuras.bach.project.ModuleLookup.JUnitPlatform
- lookup(String) - Method in interface com.github.sormuras.bach.project.ModuleLookup
-
Returns an optional uniform resource identifier for the given module name.
- lookup(String) - Method in class com.github.sormuras.bach.project.ModuleLookup.LWJGL
- LWJGL(String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.LWJGL
-
Constructs a new module searcher with the given version.
- LWJGL(String, String) - Constructor for class com.github.sormuras.bach.project.ModuleLookup.LWJGL
-
Constructs a new module searcher with the given version.
- LWJGL_3_2_3() - Constructor for class com.github.sormuras.bach.project.ModuleLookups.LWJGL_3_2_3
-
Default constructor.
M
- main() - Method in record class com.github.sormuras.bach.project.CodeSpaces
-
Returns the value of the
main
record component. - main(String...) - Static method in class com.github.sormuras.bach.Main
-
Main entry-point.
- Main - Class in com.github.sormuras.bach
-
Bach's main program.
- Main() - Constructor for class com.github.sormuras.bach.Main
-
Default constructor.
- MAIN - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Tweak.Space
-
Main code space.
- MainCodeSpace - Record Class in com.github.sormuras.bach.project
-
A space for main modules.
- MainCodeSpace(ModuleDeclarations, ModulePaths, int, String, Launcher, Features, Tweaks) - Constructor for record class com.github.sormuras.bach.project.MainCodeSpace
-
Creates an instance of a
MainCodeSpace
record class. - map() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Returns the value of the
map
record component. - MAVEN - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Maven-based coordinates.
- mavenRepository() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Link
- missing() - Method in record class com.github.sormuras.bach.project.ExternalModules
- module() - Method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns the value of the
module
record component. - module() - Method in record class com.github.sormuras.bach.project.Launcher
-
Returns the value of the
module
record component. - module() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Link
- ModuleDeclaration - Record Class in com.github.sormuras.bach.project
-
A module declaration connects a module compilation unit with source folders and resource paths.
- ModuleDeclaration(ModuleInfoReference, SourceFolders, SourceFolders) - Constructor for record class com.github.sormuras.bach.project.ModuleDeclaration
-
Creates an instance of a
ModuleDeclaration
record class. - ModuleDeclarations - Record Class in com.github.sormuras.bach.project
-
A map of module declarations using their names as keys.
- ModuleDeclarations(Map<String, ModuleDeclaration>) - Constructor for record class com.github.sormuras.bach.project.ModuleDeclarations
-
Creates an instance of a
ModuleDeclarations
record class. - ModuleInfoReference - Class in com.github.sormuras.bach.project
- ModuleLookup - Interface in com.github.sormuras.bach.project
-
A function that tries to map a module name to a specific uniform resource identifier.
- ModuleLookup.JavaFX - Class in com.github.sormuras.bach.project
-
Maps well-known JavaFX module names to their Maven Central artifacts.
- ModuleLookup.JUnitJupiter - Class in com.github.sormuras.bach.project
-
Maps well-known JUnit Jupiter module names to their Maven Central artifacts.
- ModuleLookup.JUnitPlatform - Class in com.github.sormuras.bach.project
-
Maps well-known JUnit Platform module names to their Maven Central artifacts.
- ModuleLookup.LWJGL - Class in com.github.sormuras.bach.project
-
Maps well-known LWJGL module names to their Maven Central artifacts.
- ModuleLookups - Interface in com.github.sormuras.bach.project
-
A namespace for pre-defined module lookup implementations.
- ModuleLookups.JUnitJupiter_5_7 - Class in com.github.sormuras.bach.project
-
Maps well-known JUnit Jupiter 5.7.0 modules to their Maven Central artifacts.
- ModuleLookups.JUnitPlatform_1_7 - Class in com.github.sormuras.bach.project
-
Maps well-known JUnit Platform 1.7.0 modules to their Maven Central artifacts.
- ModuleLookups.LWJGL_3_2_3 - Class in com.github.sormuras.bach.project
-
Maps well-known LWJGL 3.2.3 modules to their Maven Central artifacts.
- modulePaths() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
modulePaths
record component. - modulePaths() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- modulePaths() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns the value of the
modulePaths
record component. - ModulePaths - Record Class in com.github.sormuras.bach.project
-
A module-path type.
- ModulePaths(List<Path>) - Constructor for record class com.github.sormuras.bach.project.ModulePaths
-
Creates an instance of a
ModulePaths
record class. - modules() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
modules
record component. - modules() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
-
An array of paths to module compilation units.
- modules() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns the value of the
modules
record component.
N
- name() - Method in record class com.github.sormuras.bach.project.Launcher
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
- name() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
- name() - Method in class com.github.sormuras.bach.project.ModuleInfoReference
- name() - Method in record class com.github.sormuras.bach.project.Project
-
Returns the value of the
name
record component. - name() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- name() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
- name() - Method in record class com.github.sormuras.bach.tool.Command
-
Returns the value of the
name
record component. - name() - Method in interface com.github.sormuras.bach.tool.ToolCall
-
Return the name of the tool to be called.
- name() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
name
record component. - newHttpClient() - Static method in class com.github.sormuras.bach.Bach
-
Returns a new HttpClient following normal redirects.
O
- of() - Static method in record class com.github.sormuras.bach.project.Project
-
Returns a project model based on walking the current working directory.
- of(ProjectInfo) - Static method in record class com.github.sormuras.bach.project.Project
-
Returns a project model based on the current working directory and the given info annotation.
- of(String, Object...) - Static method in record class com.github.sormuras.bach.tool.Command
-
Builds a command with the given tool name and an array of arguments.
- of(Path) - Static method in class com.github.sormuras.bach.project.ModuleInfoReference
- ofBestEffort(Bach) - Static method in interface com.github.sormuras.bach.project.ModuleLookup
-
Returns a best-effort module lookup.
- ofEmpty() - Static method in interface com.github.sormuras.bach.project.ModuleLookup
- ofSystem() - Static method in class com.github.sormuras.bach.Bach
-
Returns a shell builder initialized with default components.
- ofSystem() - Static method in class com.github.sormuras.bach.Logbook
-
Returns a logbook initialized with default components.
- open() - Method in class com.github.sormuras.bach.project.ModuleInfoReference
- out() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
out
record component.
P
- path() - Method in record class com.github.sormuras.bach.project.SourceFolder
-
Returns the value of the
path
record component. - PATH - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Path to a local file.
- pathBase() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Link
- paths() - Method in record class com.github.sormuras.bach.project.ModulePaths
-
Returns the value of the
paths
record component. - printUsageInstructions(PrintStream) - Static method in class com.github.sormuras.bach.Main
-
Print usage instructions to the given print stream.
- project() - Method in class com.github.sormuras.bach.Builder
- Project - Record Class in com.github.sormuras.bach.project
-
Bach's project model.
- Project(String, ModuleDescriptor.Version, ExternalModules, CodeSpaces) - Constructor for record class com.github.sormuras.bach.project.Project
-
Creates an instance of a
Project
record class. - ProjectInfo - Annotation Interface in com.github.sormuras.bach.project
-
Indicates that the annotated module is a project declaration.
- ProjectInfo.Link - Annotation Interface in com.github.sormuras.bach.project
-
An external module name to URI pair annotation.
- ProjectInfo.Link.Type - Enum Class in com.github.sormuras.bach.project
-
Link target type.
- ProjectInfo.Tweak - Annotation Interface in com.github.sormuras.bach.project
-
Tool name-args pair annotation.
- ProjectInfo.Tweak.Space - Enum Class in com.github.sormuras.bach.project
-
An enumeration of code spaces.
R
- reference() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Returns the value of the
reference
record component. - release() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
release
record component. - release() - Method in record class com.github.sormuras.bach.project.SourceFolder
-
Returns the value of the
release
record component. - requires() - Method in record class com.github.sormuras.bach.project.ExternalModules
-
Returns the value of the
requires
record component. - requires() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- resources() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Returns the value of the
resources
record component. - run(ToolCall) - Method in class com.github.sormuras.bach.Builder
-
Runs the given tool call.
- run(ToolCall) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Runs a tool call.
- run(ToolCall, ModuleFinder, String...) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Runs a tool call.
- run(String, Object...) - Static method in class com.github.sormuras.bach.ShellEnvironment
-
Run the named tool passing the given arguments.
- run(String, String...) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Runs a tool call.
- run(String, List<String>) - Method in class com.github.sormuras.bach.tool.ToolRunner
-
Runs a tool call.
- run(Stream<ToolCall>) - Method in class com.github.sormuras.bach.Builder
-
Runs tool calls of the given stream in parallel.
S
- set() - Method in record class com.github.sormuras.bach.project.Features
-
Returns the value of the
set
record component. - ShellEnvironment - Class in com.github.sormuras.bach
-
An enviroment used by Bach's Boot Script.
- size() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
- SourceFolder - Record Class in com.github.sormuras.bach.project
-
A source or resource directory potentially targeting a specific Java SE release.
- SourceFolder(Path, int) - Constructor for record class com.github.sormuras.bach.project.SourceFolder
-
Creates an instance of a
SourceFolder
record class. - SourceFolders - Record Class in com.github.sormuras.bach.project
-
A list of source folder objects.
- SourceFolders(List<SourceFolder>) - Constructor for record class com.github.sormuras.bach.project.SourceFolders
-
Creates an instance of a
SourceFolders
record class. - sources() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Returns the value of the
sources
record component. - spaces() - Method in record class com.github.sormuras.bach.project.Project
-
Returns the value of the
spaces
record component. - stream() - Method in record class com.github.sormuras.bach.project.ExternalModules
T
- test() - Method in record class com.github.sormuras.bach.project.CodeSpaces
-
Returns the value of the
test
record component. - TEST - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Tweak.Space
-
Test code space.
- TestCodeSpace - Record Class in com.github.sormuras.bach.project
-
A space for test modules.
- TestCodeSpace(ModuleDeclarations, ModulePaths, Tweaks) - Constructor for record class com.github.sormuras.bach.project.TestCodeSpace
-
Creates an instance of a
TestCodeSpace
record class. - testModulePaths() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- tests() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- thread() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns the value of the
thread
record component. - to() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Link
- to(String) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link whose uri is determined by the given target string.
- toBuilder() - Method in record class com.github.sormuras.bach.tool.Command
-
Instantiates a builder based on this a command's components.
- toCommand() - Method in interface com.github.sormuras.bach.tool.ToolCall
-
Return an immutable tool call instance representing this tool call.
- toMaven(String, String) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link pointing to an artifact hosted at the given Maven repository.
- toMavenCentral(String) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link pointing to an artifact hosted at Maven Central.
- toModulePatches(ModuleDeclarations) - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Return a map of module-paths entries.
- toModulePath() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
- toModuleSourcePath() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
- toModuleSourcePaths(boolean) - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Returns a list of module source path forms.
- toModuleSpecificSourcePath() - Method in record class com.github.sormuras.bach.project.SourceFolders
- toNames() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
- toNames(String) - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Returns a string of all module names joined by the given delimiter.
- tool() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Tweak
- ToolCall - Interface in com.github.sormuras.bach.tool
-
A tool call object with its name and an array of argument strings.
- ToolResponse - Record Class in com.github.sormuras.bach.tool
-
Recordable tool call response.
- ToolResponse(String, List<String>, long, Duration, int, String, String) - Constructor for record class com.github.sormuras.bach.tool.ToolResponse
-
Creates an instance of a
ToolResponse
record class. - ToolRunner - Class in com.github.sormuras.bach.tool
-
An object that runs
ToolCall
instances. - ToolRunner() - Constructor for class com.github.sormuras.bach.tool.ToolRunner
-
Initializes a tool shell instance with the default components.
- ToolRunner(ModuleFinder) - Constructor for class com.github.sormuras.bach.tool.ToolRunner
-
Initializes a tool shell instance with the given components.
- toPath(String, String) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link pointing to local path.
- toString() - Method in record class com.github.sormuras.bach.project.CodeSpaces
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.ExternalModules
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.Features
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.Launcher
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.ModuleDeclaration
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.ModuleDeclarations
-
Returns a string representation of this record class.
- toString() - Method in class com.github.sormuras.bach.project.ModuleInfoReference
- toString() - Method in record class com.github.sormuras.bach.project.ModulePaths
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.Project
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.SourceFolder
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.SourceFolders
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.Tweak
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.project.Tweaks
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.tool.Command
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.tool.ToolResponse
-
Returns a string representation of this record class.
- toUri(String) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link pointing to the given uniform resource identifier.
- toUri(URI) - Method in class com.github.sormuras.bach.project.ExternalModuleBuilder
-
Returns a module link pointing to the given uniform resource identifier.
- trigger() - Method in record class com.github.sormuras.bach.project.Tweak
-
Returns the value of the
trigger
record component. - Tweak - Record Class in com.github.sormuras.bach.project
-
A tool call tweak.
- Tweak(String, List<String>) - Constructor for record class com.github.sormuras.bach.project.Tweak
-
Creates an instance of a
Tweak
record class. - tweaks() - Method in record class com.github.sormuras.bach.project.MainCodeSpace
-
Returns the value of the
tweaks
record component. - tweaks() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
- tweaks() - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns the value of the
tweaks
record component. - Tweaks - Record Class in com.github.sormuras.bach.project
-
A collection of tweak objects.
- Tweaks(List<Tweak>) - Constructor for record class com.github.sormuras.bach.project.Tweaks
-
Creates an instance of a
Tweaks
record class. - type() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Link
U
- uri() - Method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns the value of the
uri
record component. - uri(String) - Static method in record class com.github.sormuras.bach.project.ExternalModule
-
Returns the uniform resource identifier computed from the given target string.
- URI - Enum constant in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Uniform Resource Identifier (URI) reference as is
URI
.
V
- valueOf(String) - Static method in enum class com.github.sormuras.bach.project.Feature
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.sormuras.bach.project.ProjectInfo.Tweak.Space
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.sormuras.bach.project.Feature
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.sormuras.bach.project.ProjectInfo.Link.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.sormuras.bach.project.ProjectInfo.Tweak.Space
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Static method in class com.github.sormuras.bach.Bach
-
Returns the version of Bach.
- version() - Method in record class com.github.sormuras.bach.project.Project
-
Returns the value of the
version
record component. - version() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo
W
- with() - Element in annotation interface com.github.sormuras.bach.project.ProjectInfo.Tweak
- with(Object) - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Adds an argument.
- with(String, Object, Object...) - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Adds two or more arguments.
- with(Optional<T>, BiConsumer<Command.Builder, T>) - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Calls the given consumer if a value is present in the given optional.
- withEach(Iterable<?>) - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Adds all arguments provided by the given iterable object.
- withEach(Iterable<T>, BiConsumer<Command.Builder, T>) - Method in class com.github.sormuras.bach.tool.Command.Builder
-
Calls for each iterable element the given consumer.
- workspace(String, String...) - Method in record class com.github.sormuras.bach.project.TestCodeSpace
-
Returns a normalized path resolved to the workspace directory.
- WORKSPACE - Static variable in class com.github.sormuras.bach.Bach
-
Path to directory that collects all generated assets.
- WORKSPACE - Static variable in annotation interface com.github.sormuras.bach.project.ProjectInfo
-
Path to the directory that collects all generated assets.
- WORKSPACE_MODULES - Static variable in annotation interface com.github.sormuras.bach.project.ProjectInfo
-
Path to the directory that collects this project's main modules.
- write(Project) - Method in class com.github.sormuras.bach.Logbook
-
Returns the path to the logbook file.
All Classes|All Packages|Constant Field Values|Serialized Form