Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- args() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
args
record component. - arguments() - Method in interface com.github.sormuras.bach.ToolCall
- artifact() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
artifact
record component. - artifact(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
- Asset(String, String) - Constructor for record class com.github.sormuras.bach.Grabber.Asset
-
Creates an instance of a
Asset
record class. - assets() - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Returns the value of the
assets
record component.
B
- bach() - Method in record class com.github.sormuras.bach.builder.BuilderFactory
-
Returns the value of the
bach
record component. - bach() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
-
Returns the value of the
bach
record component. - bach() - Method in record class com.github.sormuras.bach.Explorer
-
Returns the value of the
bach
record component. - bach() - Method in record class com.github.sormuras.bach.Grabber
-
Returns the value of the
bach
record component. - bach() - Method in record class com.github.sormuras.bach.Printer
-
Returns the value of the
bach
record component. - Bach - Class in com.github.sormuras.bach
-
Java Shell Builder.
- Bach(Configuration) - Constructor for class com.github.sormuras.bach.Bach
- Bach(String...) - Constructor for class com.github.sormuras.bach.Bach
- Bach.BuildProgramGenerators - Interface in com.github.sormuras.bach
-
Convenience short-cuts to various build program generators.
- build() - Method in record class com.github.sormuras.bach.external.Maven.Builder
- builder() - Method in class com.github.sormuras.bach.Bach
- builder(String, String, String) - Static method in class com.github.sormuras.bach.external.Maven
- Builder(Bach, Conventional.Space) - Constructor for record class com.github.sormuras.bach.builder.Conventional.Builder
-
Creates an instance of a
Builder
record class. - Builder(String, String, String) - Constructor for record class com.github.sormuras.bach.external.Maven.Builder
- Builder(String, String, String, String, String, String) - Constructor for record class com.github.sormuras.bach.external.Maven.Builder
-
Creates an instance of a
Builder
record class. - BuilderFactory - Record Class in com.github.sormuras.bach.builder
-
Contains methods creating new builder instances, e.g.
- BuilderFactory(Bach) - Constructor for record class com.github.sormuras.bach.builder.BuilderFactory
-
Creates an instance of a
BuilderFactory
record class.
C
- call() - Method in record class com.github.sormuras.bach.Logbook.ToolCallNote
-
Returns the value of the
call
record component. - caption() - Method in record class com.github.sormuras.bach.external.FXGL
- caption() - Method in record class com.github.sormuras.bach.external.GluonAttach
- caption() - Method in record class com.github.sormuras.bach.external.Jackson
- caption() - Method in record class com.github.sormuras.bach.external.JavaFX
- caption() - Method in record class com.github.sormuras.bach.external.JUnit
- caption() - Method in record class com.github.sormuras.bach.external.Kotlin
- caption() - Method in interface com.github.sormuras.bach.ExternalModuleLocator
- CaptionNote(String) - Constructor for record class com.github.sormuras.bach.Logbook.CaptionNote
-
Creates an instance of a
CaptionNote
record class. - central(String, String, String) - Static method in class com.github.sormuras.bach.external.Maven
- central(String, String, String, String) - Static method in class com.github.sormuras.bach.external.Maven
- CENTRAL_REPOSITORY - Static variable in class com.github.sormuras.bach.external.Maven
- classifier() - Method in record class com.github.sormuras.bach.external.JavaFX
-
Returns the value of the
classifier
record component. - classifier() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
classifier
record component. - classifier(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
- close() - Method in class com.github.sormuras.bach.Bach
- code() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
code
record component. - 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.builder - package com.github.sormuras.bach.builder
-
Provides the classes and interfaces for building single tool calls or modular Java projects.
- com.github.sormuras.bach.external - package com.github.sormuras.bach.external
-
Provides the classes and interfaces for locating modules of well-known 3rd-party libraries.
- compile() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- compile(ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- compile(ToolCall.Composer, ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- compose(ToolFinder...) - Static method in interface com.github.sormuras.bach.ToolFinder
- computeJarFileName(String, ModuleDescriptor.Version) - Static method in record class com.github.sormuras.bach.Configuration
- computeJavaExecutablePath(String) - Static method in record class com.github.sormuras.bach.Configuration
- configuration() - Method in class com.github.sormuras.bach.Bach
- Configuration - Record Class in com.github.sormuras.bach
-
Global settings with nested topic-specific configurations.
- Configuration(boolean, boolean, int, Configuration.Pathing, Configuration.Printing, Configuration.Tooling, Options.ProjectOptions) - Constructor for record class com.github.sormuras.bach.Configuration
-
Creates an instance of a
Configuration
record class. - Configuration.Pathing - Record Class in com.github.sormuras.bach
-
Path
-related settings. - Configuration.Printing - Record Class in com.github.sormuras.bach
-
Print-related settings and common
PrintWriter
objects. - Configuration.Tooling - Record Class in com.github.sormuras.bach
-
ToolFinder
-related andToolProvider
-related settings. - ConfigurationOptions(Optional<Boolean>, Optional<Boolean>, Optional<Integer>) - Constructor for record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Creates an instance of a
ConfigurationOptions
record class. - constructLogbook() - Method in class com.github.sormuras.bach.Bach
- conventional(String...) - Method in record class com.github.sormuras.bach.builder.BuilderFactory
- Conventional - Interface in com.github.sormuras.bach.builder
-
An API for building modular Java projects using conventional source file tree layouts.
- Conventional.Builder - Record Class in com.github.sormuras.bach.builder
-
Conventional project builder.
- Conventional.Space - Record Class in com.github.sormuras.bach.builder
-
Conventional module space descriptor.
- conventionalSpace(String, String...) - Method in record class com.github.sormuras.bach.builder.BuilderFactory
D
- declared(ModuleFinder) - Static method in record class com.github.sormuras.bach.Explorer
- declared(Stream<ModuleDescriptor>) - Static method in record class com.github.sormuras.bach.Explorer
- DEFAULT_CLASSIFIER - Static variable in class com.github.sormuras.bach.external.Maven
- DEFAULT_TYPE - Static variable in class com.github.sormuras.bach.external.Maven
- dependentSpace(String, String...) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- description() - Method in record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Returns the value of the
description
record component. - destinationDirectory() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns the value of the
destinationDirectory
record component. - Directory(Path, String, List<Grabber.Asset>) - Constructor for record class com.github.sormuras.bach.Grabber.Directory
-
Creates an instance of a
Directory
record class. - document(ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- duration() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
duration
record component.
E
- equals(Object) - Method in record class com.github.sormuras.bach.builder.BuilderFactory
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Configuration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Configuration.Printing
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Configuration.Tooling
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Explorer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.FXGL
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.GluonAttach
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.Jackson
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.JavaFX
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.JUnit
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.Kotlin
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.ExternalModuleLocators
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Grabber.Asset
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Grabber
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Logbook.CaptionNote
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Logbook.MessageNote
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Logbook.ToolCallNote
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Main
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Options
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Options.ProjectOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.Printer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sormuras.bach.ToolRun
-
Indicates whether some other object is "equal to" this one.
- err() - Method in class com.github.sormuras.bach.Bach
- err() - Method in record class com.github.sormuras.bach.Configuration.Printing
-
Returns the value of the
err
record component. - errors() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
errors
record component. - explorer() - Method in class com.github.sormuras.bach.Bach
- Explorer - Record Class in com.github.sormuras.bach
-
An Explorer finds files, lists modules, and helps explore other assets and states.
- Explorer(Bach) - Constructor for record class com.github.sormuras.bach.Explorer
-
Creates an instance of a
Explorer
record class. - EXTERNAL_MODULES_DIRECTORY - Static variable in record class com.github.sormuras.bach.Configuration
- EXTERNAL_TOOL_LAYERS_DIRECTORY - Static variable in record class com.github.sormuras.bach.Configuration
- EXTERNAL_TOOL_PROGRAM_ARGSFILE - Static variable in record class com.github.sormuras.bach.Configuration
- EXTERNAL_TOOL_PROGRAMS_DIRECTORY - Static variable in record class com.github.sormuras.bach.Configuration
- ExternalModuleLocator - Interface in com.github.sormuras.bach
-
An external module locator tries to link a module name to a remote location.
- ExternalModuleLocators - Record Class in com.github.sormuras.bach
-
A list of external module locator instances that are queried in order.
- ExternalModuleLocators(List<ExternalModuleLocator>) - Constructor for record class com.github.sormuras.bach.ExternalModuleLocators
-
Creates an instance of a
ExternalModuleLocators
record class. - externalModules() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
externalModules
record component. - externalToolLayers() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
externalToolLayers
record component. - externalToolPrograms() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
externalToolPrograms
record component.
F
- find(String) - Method in interface com.github.sormuras.bach.ExternalModuleLocator
- find(String) - Method in interface com.github.sormuras.bach.ToolFinder
- findAll() - Method in interface com.github.sormuras.bach.ToolFinder
- finder() - Method in record class com.github.sormuras.bach.Configuration.Tooling
-
Returns the value of the
finder
record component. - findJavaFiles() - Method in record class com.github.sormuras.bach.Explorer
- findJavaFiles(Path) - Method in record class com.github.sormuras.bach.Explorer
- findModuleInfoJavaFiles() - Method in record class com.github.sormuras.bach.Explorer
- findModuleInfoJavaFiles(Path) - Method in record class com.github.sormuras.bach.Explorer
- forConfiguration() - Method in record class com.github.sormuras.bach.Options
-
Returns the value of the
forConfiguration
record component. - forMain() - Method in record class com.github.sormuras.bach.Options
-
Returns the value of the
forMain
record component. - forProject() - Method in record class com.github.sormuras.bach.Options
-
Returns the value of the
forProject
record component. - FXGL - Record Class in com.github.sormuras.bach.external
-
Locates "Java/JavaFX/Kotlin Game Library" modules via their Maven Central artifacts.
- FXGL(String) - Constructor for record class com.github.sormuras.bach.external.FXGL
-
Creates an instance of a
FXGL
record class.
G
- generateBuildProgram() - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Returns the value of the
generateBuildProgram
record component. - generateConventionalBuildProgram() - Static method in interface com.github.sormuras.bach.Bach.BuildProgramGenerators
- generateConventionalUnnamedSpaceBuildProgram() - Static method in interface com.github.sormuras.bach.Bach.BuildProgramGenerators
- generateMainAndTestSpaceBuildProgram() - Static method in interface com.github.sormuras.bach.builder.Conventional
-
Returns a build program for a project using
main
andtest
space layout. - generateUnnamedSpaceBuildProgram() - Static method in interface com.github.sormuras.bach.builder.Conventional
-
Returns a build program for the conventional unnamend space.
- GluonAttach - Record Class in com.github.sormuras.bach.external
-
Locates "Gluon Attach" modules via their Maven Central artifacts.
- GluonAttach(String) - Constructor for record class com.github.sormuras.bach.external.GluonAttach
-
Creates an instance of a
GluonAttach
record class. - grab(Grabber.Directory...) - Method in record class com.github.sormuras.bach.Grabber
- grab(Grabber, String...) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- grab(Path, Grabber.Asset) - Method in record class com.github.sormuras.bach.Grabber
- grabber(ExternalModuleLocator...) - Method in class com.github.sormuras.bach.Bach
- grabber(ExternalModuleLocators) - Method in class com.github.sormuras.bach.Bach
- Grabber - Record Class in com.github.sormuras.bach
-
A grabber helps loading, updating, and verifying external assets.
- Grabber(Bach, ExternalModuleLocators) - Constructor for record class com.github.sormuras.bach.Grabber
-
Creates an instance of a
Grabber
record class. - Grabber.Asset - Record Class in com.github.sormuras.bach
-
Links a local file via its path name to a (remote) resource identifier.
- Grabber.Directory - Record Class in com.github.sormuras.bach
-
Links an
Grabber.Asset
list to a directory name within a parent directory. - grabExternalModules(String...) - Method in record class com.github.sormuras.bach.Grabber
- grabMissingExternalModules() - Method in record class com.github.sormuras.bach.Grabber
- group() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
group
record component. - group(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
H
- hashCode() - Method in record class com.github.sormuras.bach.builder.BuilderFactory
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Configuration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Configuration.Printing
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Configuration.Tooling
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Explorer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.FXGL
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.GluonAttach
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.Jackson
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.JavaFX
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.JUnit
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.Kotlin
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.ExternalModuleLocators
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Grabber.Asset
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Grabber
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Logbook.CaptionNote
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Logbook.MessageNote
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Logbook.ToolCallNote
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Main
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Options
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Options.ProjectOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.Printer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns a hash code value for this object.
- help() - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Returns the value of the
help
record component.
I
- identity() - Static method in interface com.github.sormuras.bach.ToolCall.Composer
-
Returns a tool call composer that always returns the same call instance.
- isError() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns
true
if this response represents an errored tool call run. - isSuccessful() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns
true
if this response represents a successful tool call run.
J
- Jackson - Record Class in com.github.sormuras.bach.external
-
Locates "Jackson" modules via their Maven Central artifacts.
- Jackson(String) - Constructor for record class com.github.sormuras.bach.external.Jackson
-
Creates an instance of a
Jackson
record class. - java(Object...) - Static method in interface com.github.sormuras.bach.ToolCall
- javaExecutable() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
javaExecutable
record component. - JavaFX - Record Class in com.github.sormuras.bach.external
-
Locates well-known JavaFX modules via their Maven Central artifacts.
- JavaFX(String, String) - Constructor for record class com.github.sormuras.bach.external.JavaFX
-
Creates an instance of a
JavaFX
record class. - JUnit - Record Class in com.github.sormuras.bach.external
-
Locates "JUnit" modules via their Maven Central artifacts.
- JUnit(String) - Constructor for record class com.github.sormuras.bach.external.JUnit
-
Creates an instance of a
JUnit
record class.
K
- Kotlin - Record Class in com.github.sormuras.bach.external
-
Locates "Kotlin" modules via their Maven Central artifacts.
- Kotlin(String) - Constructor for record class com.github.sormuras.bach.external.Kotlin
-
Creates an instance of a
Kotlin
record class.
L
- lenient() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
lenient
record component. - lenient() - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Returns the value of the
lenient
record component. - level() - Method in record class com.github.sormuras.bach.Logbook.MessageNote
-
Returns the value of the
level
record component. - line() - Method in record class com.github.sormuras.bach.Logbook.CaptionNote
-
Returns the value of the
line
record component. - link(ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- list() - Method in record class com.github.sormuras.bach.ExternalModuleLocators
-
Returns the value of the
list
record component. - list(String) - Method in interface com.github.sormuras.bach.ToolFinder
- listMissingExternalModules(ModuleFinder, String...) - Method in record class com.github.sormuras.bach.Explorer
- listMissingExternalModules(String...) - Method in record class com.github.sormuras.bach.Explorer
- listMissingExternalModules(List<ModuleFinder>, String...) - Method in record class com.github.sormuras.bach.Explorer
- locate(String) - Method in record class com.github.sormuras.bach.external.FXGL
- locate(String) - Method in record class com.github.sormuras.bach.external.GluonAttach
- locate(String) - Method in record class com.github.sormuras.bach.external.Jackson
- locate(String) - Method in record class com.github.sormuras.bach.external.JavaFX
- locate(String) - Method in record class com.github.sormuras.bach.external.JUnit
- locate(String) - Method in record class com.github.sormuras.bach.external.Kotlin
- locate(String) - Method in interface com.github.sormuras.bach.ExternalModuleLocator
- locators() - Method in record class com.github.sormuras.bach.Grabber
-
Returns the value of the
locators
record component. - logbook() - Method in class com.github.sormuras.bach.Bach
- Logbook - Class in com.github.sormuras.bach
-
A logbook collects notes, prints them, and is able to write itself into a file.
- Logbook(Bach) - Constructor for class com.github.sormuras.bach.Logbook
- LOGBOOK_ARCHIVE_FILE - Static variable in record class com.github.sormuras.bach.Configuration
- LOGBOOK_MARKDOWN_FILE - Static variable in record class com.github.sormuras.bach.Configuration
- Logbook.CaptionNote - Record Class in com.github.sormuras.bach
-
A textual note starting a section of notes.
- Logbook.MessageNote - Record Class in com.github.sormuras.bach
-
A weighted textual note.
- Logbook.Note - Interface in com.github.sormuras.bach
-
An abstract logbook entry.
- Logbook.ToolCallNote - Record Class in com.github.sormuras.bach
-
A note indicating that a tool is about to be called.
- Logbook.ToolRunNote - Record Class in com.github.sormuras.bach
-
A note indicating that a tool was run with a detailed description.
- logCaption(String) - Method in class com.github.sormuras.bach.Bach
- logCaption(String) - Method in class com.github.sormuras.bach.Logbook
- logMessage(String) - Method in class com.github.sormuras.bach.Bach
- logMessage(System.Logger.Level, String) - Method in class com.github.sormuras.bach.Bach
- logMessage(System.Logger.Level, String) - Method in class com.github.sormuras.bach.Logbook
M
- main(String...) - Static method in record class com.github.sormuras.bach.Main
-
The main entry-point.
- Main - Record Class in com.github.sormuras.bach
-
Bach's main program.
- Main() - Constructor for record class com.github.sormuras.bach.Main
-
Creates an instance of a
Main
record class. - MainOptions(Optional<Boolean>, Optional<Boolean>, Optional<Boolean>) - Constructor for record class com.github.sormuras.bach.Options.MainOptions
-
Creates an instance of a
MainOptions
record class. - Maven - Class in com.github.sormuras.bach.external
-
Maven-related helpers.
- MAVEN_GROUP - Static variable in record class com.github.sormuras.bach.external.JavaFX
- Maven.Builder - Record Class in com.github.sormuras.bach.external
-
A builder of Maven coordinates.
- MessageNote(System.Logger.Level, String) - Constructor for record class com.github.sormuras.bach.Logbook.MessageNote
-
Creates an instance of a
MessageNote
record class. - module(ModuleFinder, String, Object...) - Static method in interface com.github.sormuras.bach.ToolCall
- modulePaths() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns the value of the
modulePaths
record component. - modules() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns the value of the
modules
record component. - moduleSourcePaths() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns the value of the
moduleSourcePaths
record component.
N
- name() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sormuras.bach.Grabber.Asset
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sormuras.bach.Main
- name() - Method in record class com.github.sormuras.bach.Options.ProjectOptions
-
Returns the value of the
name
record component. - name() - Method in interface com.github.sormuras.bach.ToolCall
- name() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
name
record component. - newExternalToolLayerDirectory(String, Grabber.Asset...) - Method in record class com.github.sormuras.bach.Grabber
- newExternalToolProgramDirectory(String, Grabber.Asset...) - Method in record class com.github.sormuras.bach.Grabber
- newModuleInfoFinder(Path) - Method in record class com.github.sormuras.bach.Explorer
- noop() - Static method in interface com.github.sormuras.bach.ToolRun.Visitor
-
Returns a tool run visitor that does nothing.
O
- of() - Static method in record class com.github.sormuras.bach.Configuration
- of(Configuration.Pathing, Configuration.Printing) - Static method in record class com.github.sormuras.bach.Configuration
- of(ExternalModuleLocator...) - Static method in record class com.github.sormuras.bach.ExternalModuleLocators
- of(ToolFinder, String, Object...) - Static method in interface com.github.sormuras.bach.ToolCall
- of(ClassLoader) - Static method in interface com.github.sormuras.bach.ToolFinder
- of(ModuleFinder, boolean, String...) - Static method in interface com.github.sormuras.bach.ToolFinder
- of(ModuleLayer) - Static method in interface com.github.sormuras.bach.ToolFinder
- of(String, Object...) - Static method in interface com.github.sormuras.bach.ToolCall
- of(Path) - Static method in record class com.github.sormuras.bach.Configuration.Pathing
- of(ServiceLoader<ToolProvider>) - Static method in interface com.github.sormuras.bach.ToolFinder
- of(ToolProvider...) - Static method in interface com.github.sormuras.bach.ToolFinder
- ofBach() - Static method in interface com.github.sormuras.bach.ToolFinder
- ofCurrentWorkingDirectory() - Static method in record class com.github.sormuras.bach.Configuration.Pathing
- ofErrorsOnly() - Static method in record class com.github.sormuras.bach.Configuration.Printing
- ofLayers(Path) - Static method in interface com.github.sormuras.bach.ToolFinder
- ofPrograms(Path, Path, String) - Static method in interface com.github.sormuras.bach.ToolFinder
- ofSystem() - Static method in interface com.github.sormuras.bach.ToolFinder
- Options - Record Class in com.github.sormuras.bach
-
All well-known options, usually parsed from command-line arguments.
- Options(Options.MainOptions, Options.ConfigurationOptions, Options.ProjectOptions, List<String>) - Constructor for record class com.github.sormuras.bach.Options
-
Creates an instance of a
Options
record class. - Options.ConfigurationOptions - Record Class in com.github.sormuras.bach
-
A group of optional components used as global settings of a
Configuration
instance. - Options.MainOptions - Record Class in com.github.sormuras.bach
-
A group of optional components used by the main program.
- Options.ProjectOptions - Record Class in com.github.sormuras.bach
-
A group of optional components used when building a project model instance.
- out() - Method in class com.github.sormuras.bach.Bach
- out() - Method in record class com.github.sormuras.bach.Configuration.Printing
-
Returns the value of the
out
record component. - output() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
output
record component.
P
- parent() - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Returns the value of the
parent
record component. - parse(String...) - Static method in record class com.github.sormuras.bach.Options
-
Parses an array of strings in command-line style into an options instance.
- parse(List<String>) - Static method in record class com.github.sormuras.bach.Options
- path() - Method in class com.github.sormuras.bach.Bach
- pathing() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
pathing
record component. - Pathing(Path, Path, Path, Path, Path, Path) - Constructor for record class com.github.sormuras.bach.Configuration.Pathing
-
Creates an instance of a
Pathing
record class. - print(Logbook.CaptionNote) - Method in class com.github.sormuras.bach.Logbook
- print(Logbook.MessageNote) - Method in class com.github.sormuras.bach.Logbook
- print(Logbook.ToolCallNote) - Method in class com.github.sormuras.bach.Logbook
- print(Logbook.ToolRunNote) - Method in class com.github.sormuras.bach.Logbook
- print(ToolRun) - Method in class com.github.sormuras.bach.Logbook
- print(ToolRun) - Method in record class com.github.sormuras.bach.Printer
- print(ToolRun, boolean, int) - Method in record class com.github.sormuras.bach.Printer
- printer() - Method in class com.github.sormuras.bach.Bach
- Printer - Record Class in com.github.sormuras.bach
-
A printer of various types using the configured output writer.
- Printer(Bach) - Constructor for record class com.github.sormuras.bach.Printer
-
Creates an instance of a
Printer
record class. - printing() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
printing
record component. - Printing(PrintWriter, PrintWriter) - Constructor for record class com.github.sormuras.bach.Configuration.Printing
-
Creates an instance of a
Printing
record class. - process(Path, Object...) - Static method in interface com.github.sormuras.bach.ToolCall
- projectOptions() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
projectOptions
record component. - ProjectOptions(Optional<String>, Optional<ModuleDescriptor.Version>) - Constructor for record class com.github.sormuras.bach.Options.ProjectOptions
-
Creates an instance of a
ProjectOptions
record class.
R
- repository() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
repository
record component. - repository(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
- required(ModuleFinder) - Static method in record class com.github.sormuras.bach.Explorer
- required(Stream<ModuleDescriptor>) - Static method in record class com.github.sormuras.bach.Explorer
- requireSuccessful() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns silently this instance if it represents a successful tool call run.
- root() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
root
record component. - root(String, String...) - Method in record class com.github.sormuras.bach.Configuration.Pathing
- run() - Method in record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Returns the value of the
run
record component. - run(ToolCall) - Method in class com.github.sormuras.bach.Bach
- run(ToolFinder, String, ToolCall.Composer) - Method in class com.github.sormuras.bach.Bach
- run(PrintWriter, PrintWriter, String...) - Method in record class com.github.sormuras.bach.Main
- run(ModuleFinder, String, ToolCall.Composer) - Method in class com.github.sormuras.bach.Bach
- run(String, ToolCall.Composer) - Method in class com.github.sormuras.bach.Bach
- run(Path, ToolCall.Composer) - Method in class com.github.sormuras.bach.Bach
- runAllTests() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runJUnit(ToolFinder, String) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runJUnit(ToolFinder, String, ToolCall.Composer, ToolRun.Visitor) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runJUnit(String) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runModule(ModuleFinder, String, ToolCall.Composer, ToolRun.Visitor) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runModule(String, ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runTool(ToolFinder, String, ToolCall.Composer, ToolRun.Visitor) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
- runTool(String, ToolCall.Composer) - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
S
- sanitize(Object) - Static method in class com.github.sormuras.bach.Logbook
- source() - Method in record class com.github.sormuras.bach.Grabber.Asset
-
Returns the value of the
source
record component. - space() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
-
Returns the value of the
space
record component. - Space(Optional<String>, List<String>, List<String>, List<Path>, Path) - Constructor for record class com.github.sormuras.bach.builder.Conventional.Space
-
Creates an instance of a
Space
record class.
T
- text() - Method in record class com.github.sormuras.bach.Logbook.MessageNote
-
Returns the value of the
text
record component. - thread() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns the value of the
thread
record component. - timeout() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
timeout
record component. - timeout() - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Returns the value of the
timeout
record component. - TIMESTAMP_PATTERN - Static variable in record class com.github.sormuras.bach.Configuration
- toMarkdown() - Method in class com.github.sormuras.bach.Logbook
- ToolCall - Interface in com.github.sormuras.bach
-
Builds named tool calls with their arguments.
- ToolCall.Composer - Interface in com.github.sormuras.bach
-
A tool call arguments tweaker.
- ToolCallNote(ToolCall) - Constructor for record class com.github.sormuras.bach.Logbook.ToolCallNote
-
Creates an instance of a
ToolCallNote
record class. - ToolFinder - Interface in com.github.sormuras.bach
-
A finder of tool providers.
- tooling() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
tooling
record component. - Tooling(ToolFinder) - Constructor for record class com.github.sormuras.bach.Configuration.Tooling
-
Creates an instance of a
Tooling
record class. - ToolRun - Record Class in com.github.sormuras.bach
-
A record of a tool run.
- ToolRun(String, List<String>, long, Duration, int, String, String) - Constructor for record class com.github.sormuras.bach.ToolRun
-
Creates an instance of a
ToolRun
record class. - ToolRun.Visitor - Interface in com.github.sormuras.bach
-
A consumer of a tool run instance.
- ToolRunNote(ToolRun, String) - Constructor for record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Creates an instance of a
ToolRunNote
record class. - toString() - Method in record class com.github.sormuras.bach.builder.BuilderFactory
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.builder.Conventional.Builder
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.builder.Conventional.Space
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Configuration.Printing
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Configuration.Tooling
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Configuration
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Explorer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.FXGL
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.GluonAttach
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.Jackson
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.JavaFX
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.JUnit
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.Kotlin
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.ExternalModuleLocators
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Grabber.Asset
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Grabber.Directory
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Grabber
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Logbook.CaptionNote
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Logbook.MessageNote
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Logbook.ToolCallNote
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Logbook.ToolRunNote
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Main
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Options.ProjectOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Options
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.Printer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sormuras.bach.ToolRun
-
Returns a string representation of this record class.
- type() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
type
record component. - type(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
U
- unhandledArguments() - Method in record class com.github.sormuras.bach.Options
-
Returns the value of the
unhandledArguments
record component. - uptime() - Method in class com.github.sormuras.bach.Logbook
V
- verbose() - Method in record class com.github.sormuras.bach.Configuration
-
Returns the value of the
verbose
record component. - verbose() - Method in record class com.github.sormuras.bach.Options.ConfigurationOptions
-
Returns the value of the
verbose
record component. - version() - Static method in class com.github.sormuras.bach.Bach
-
Returns the version information compiled into Bach's module.
- version() - Method in record class com.github.sormuras.bach.external.FXGL
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.GluonAttach
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.Jackson
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.JavaFX
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.JUnit
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.Kotlin
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.external.Maven.Builder
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.Options.MainOptions
-
Returns the value of the
version
record component. - version() - Method in record class com.github.sormuras.bach.Options.ProjectOptions
-
Returns the value of the
version
record component. - version(String) - Static method in record class com.github.sormuras.bach.external.FXGL
-
Constructs a new FXGL module locator with the given version.
- version(String) - Static method in record class com.github.sormuras.bach.external.GluonAttach
-
Constructs a new Gluon Attach module locator with the given version.
- version(String) - Static method in record class com.github.sormuras.bach.external.Jackson
-
Constructs a new Jackson module locator with the given version.
- version(String) - Static method in record class com.github.sormuras.bach.external.JavaFX
-
Constructs a new JavaFX module locator with the given version.
- version(String) - Static method in record class com.github.sormuras.bach.external.JUnit
-
Constructs a new JUnit module locator with the given version.
- version(String) - Static method in record class com.github.sormuras.bach.external.Kotlin
-
Constructs a new Kotlin module locator with the given version.
- version(String) - Method in record class com.github.sormuras.bach.external.Maven.Builder
- version(String, String) - Static method in record class com.github.sormuras.bach.external.JavaFX
-
Constructs a new JavaFX module locator with the given version.
- visit(ToolRun.Visitor) - Method in record class com.github.sormuras.bach.ToolRun
W
- with(Options) - Method in record class com.github.sormuras.bach.Configuration
- with(Object) - Method in interface com.github.sormuras.bach.ToolCall
- with(String, Object, Object...) - Method in interface com.github.sormuras.bach.ToolCall
- with(String, Collection<Path>) - Method in interface com.github.sormuras.bach.ToolCall
- with(Collection<?>, CharSequence) - Method in interface com.github.sormuras.bach.ToolCall
- withAll(Object...) - Method in interface com.github.sormuras.bach.ToolCall
- withAll(Collection<?>) - Method in interface com.github.sormuras.bach.ToolCall
- withAsset(String, String) - Method in record class com.github.sormuras.bach.Grabber.Directory
- workspace() - Method in record class com.github.sormuras.bach.Configuration.Pathing
-
Returns the value of the
workspace
record component. - workspace(String, String...) - Method in record class com.github.sormuras.bach.Configuration.Pathing
- WORKSPACE_DIRECTORY - Static variable in record class com.github.sormuras.bach.Configuration
- writeLogbook() - Method in class com.github.sormuras.bach.Bach
All Classes and Interfaces|All Packages|Constant Field Values