java.lang.Object

de.sormuras.bach.Bach

public class Bach
extends Object

Java Shell Builder - build modular projects with JDK tools.

As an example, a project named demo and with version 47.11 can be built with the following code:


 var configuration = Configuration.ofSystem();
 var project = Project.of("demo", "47.11");
 new Bach(configuration, project).build();

The Java Development Kit provides at least the following tools via the ToolProvider interface.

jar - create an archive for classes and resources, and manipulate or restore individual classes or resources from an archive
javac - read Java class and interface definitions and compile them into bytecode and class files
javadoc - generate HTML pages of API documentation from Java source files
javap - disassemble one or more class files
jdeps - launch the Java class dependency analyzer
jlink - assemble and optimize a set of modules and their dependencies into a custom runtime image
jmod - create JMOD files and list the content of existing JMOD files

See Also:: JDK Tools

Field Summary

Fields

Modifier and Type Field Description

static ModuleDescriptor.Version VERSION
Version of the Java Shell Builder.
Constructor Summary

Constructors

Constructor Description

Bach(Configuration configuration, Project project)

Method Summary

Modifier and Type	Method	Description
`Base`	`base()`
`void`	`build()`
`void`	`buildApiDocumentation()`
`void`	`buildCustomRuntimeImage()`
`void`	`buildLibrariesDirectoryByResolvingMissingExternalModules()`
`void`	`buildLibrariesDirectoryByResolvingModules(Set<String> modules)`
`void`	`buildMainModules()`
`void`	`buildProject()`
`void`	`buildProjectModules()`
`void`	`buildTestModules()`
`void`	`buildTestPreviewModules()`
`void`	`buildTestReportsByExecutingTestModule(String realm, SourceUnit unit)`
`void`	`buildTestReportsByExecutingTestModules()`
`void`	`buildTestReportsByExecutingTestPreviewModule(String realm, SourceUnit unit)`
`void`	`buildTestReportsByExecutingTestPreviewModules()`
`boolean`	`checkConditionForBuildApiDocumentation()`
`boolean`	`checkConditionForBuildCustomRuntimeImage()`
`HttpClient`	`computeHttpClient()`
`Jar`	`computeJarCall(Realm<?> realm, SourceUnit unit)`
`Jar`	`computeJarForApiDocumentation()`
`Jar`	`computeJarForMainModule(SourceUnit unit)`
`Jar`	`computeJarForMainSources(SourceUnit unit)`
`Jar`	`computeJarForTestModule(SourceUnit unit)`
`Jar`	`computeJarForTestPreviewModule(SourceUnit unit)`
`Javac`	`computeJavacForMainSources()`
`Javac`	`computeJavacForTestPreview()`
`Javac`	`computeJavacForTestSources()`
`Javadoc`	`computeJavadocForMainSources()`
`Jlink`	`computeJLinkForCustomRuntimeImage()`
`JUnit`	`computeJUnitCall(String realm, SourceUnit unit, List<Path> modulePaths)`
`Optional<Link>`	`computeLinkForUnlinkedModule(String module)`
`Configuration`	`configuration()`
`Configuration.Flags`	`flags()`
`HttpClient`	`http()`
`boolean`	`is(Flag flag)`
`String`	`log(System.Logger.Level level, String text)`
`String`	`log(System.Logger.Level level, String format, Object... args)`
`Logbook`	`logbook()`
`MainSources`	`main()`
`static void`	`main(String... args)`	Main entry-point.
`boolean`	`not(Flag flag)`
`static Bach`	`of(Project project)`	Create new Bach instance for the given project.
`static Bach`	`of(UnaryOperator<Project> operator)`	Create new Bach instance with a project parsed from current user directory.
`Project`	`project()`
`String`	`toString()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- VERSION
  
  public static final ModuleDescriptor.Version VERSION
  
  Version of the Java Shell Builder.
Constructor Details
- Bach
  
  public Bach(Configuration configuration, Project project)
Method Details
- main
  
  public static void main(String... args)
  
  Main entry-point.
  
  Parameters:
  
  args - the arguments
- of
  
  public static Bach of(Project project)
  
  Create new Bach instance for the given project.
  
  Parameters:
  
  project - The project instance to use
  
  Returns:
  
  A new Bach instance
- of
  
  public static Bach of(UnaryOperator<Project> operator)
  
  Create new Bach instance with a project parsed from current user directory.
  
  Parameters:
  
  operator - The operator may return a modified project based on the parsed one
  
  Returns:
  
  A new Bach instance
  
  See Also:
  
  UnaryOperator.identity()
- configuration
  
  public final Configuration configuration()
- flags
  
  public final Configuration.Flags flags()
- is
  
  public final boolean is(Flag flag)
- not
  
  public final boolean not(Flag flag)
- logbook
  
  public final Logbook logbook()
- log
  
  public final String log(System.Logger.Level level, String text)
- log
  
  public final String log(System.Logger.Level level, String format, Object... args)
- project
  
  public final Project project()
- base
  
  public final Base base()
- main
  
  public final MainSources main()
- http
  
  public final HttpClient http()
- build
  
  public void build()
- buildProject
  
  public void buildProject()
- buildLibrariesDirectoryByResolvingMissingExternalModules
  
  public void buildLibrariesDirectoryByResolvingMissingExternalModules()
- buildLibrariesDirectoryByResolvingModules
  
  public void buildLibrariesDirectoryByResolvingModules(Set<String> modules)
- buildProjectModules
  
  public void buildProjectModules()
- buildMainModules
  
  public void buildMainModules()
- buildApiDocumentation
  
  public void buildApiDocumentation()
- buildCustomRuntimeImage
  
  public void buildCustomRuntimeImage()
- buildTestModules
  
  public void buildTestModules()
- buildTestPreviewModules
  
  public void buildTestPreviewModules()
- buildTestReportsByExecutingTestModules
  
  public void buildTestReportsByExecutingTestModules()
- buildTestReportsByExecutingTestPreviewModules
  
  public void buildTestReportsByExecutingTestPreviewModules()
- buildTestReportsByExecutingTestModule
  
  public void buildTestReportsByExecutingTestModule(String realm, SourceUnit unit)
- buildTestReportsByExecutingTestPreviewModule
  
  public void buildTestReportsByExecutingTestPreviewModule(String realm, SourceUnit unit)
- checkConditionForBuildApiDocumentation
  
  public boolean checkConditionForBuildApiDocumentation()
- checkConditionForBuildCustomRuntimeImage
  
  public boolean checkConditionForBuildCustomRuntimeImage()
- computeHttpClient
  
  public HttpClient computeHttpClient()
- computeLinkForUnlinkedModule
  
  public Optional<Link> computeLinkForUnlinkedModule(String module)
- computeJavacForMainSources
  
  public Javac computeJavacForMainSources()
- computeJarForMainSources
  
  public Jar computeJarForMainSources(SourceUnit unit)
- computeJarForMainModule
  
  public Jar computeJarForMainModule(SourceUnit unit)
- computeJavadocForMainSources
  
  public Javadoc computeJavadocForMainSources()
- computeJarForApiDocumentation
  
  public Jar computeJarForApiDocumentation()
- computeJLinkForCustomRuntimeImage
  
  public Jlink computeJLinkForCustomRuntimeImage()
- computeJavacForTestSources
  
  public Javac computeJavacForTestSources()
- computeJavacForTestPreview
  
  public Javac computeJavacForTestPreview()
- computeJarForTestModule
  
  public Jar computeJarForTestModule(SourceUnit unit)
- computeJarForTestPreviewModule
  
  public Jar computeJarForTestPreviewModule(SourceUnit unit)
- computeJarCall
  
  public Jar computeJarCall(Realm<?> realm, SourceUnit unit)
- computeJUnitCall
  
  public JUnit computeJUnitCall(String realm, SourceUnit unit, List<Path> modulePaths)
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class Bach

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details