Skip to content

Commit 449ac14

Browse files
committed
Update PathRoot documentation
1 parent 766e591 commit 449ac14

File tree

1 file changed

+4
-0
lines changed
  • java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces

1 file changed

+4
-0
lines changed

java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces/PathRoot.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,16 @@ public interface PathRoot {
4242
/**
4343
* Convert the given path root into a JAR and return the byte contents of the JAR.
4444
*
45+
* <p>You can use this to create JAR files from existing path roots, if you want to package
46+
* some compiled outputs into a JAR to use them as inputs to another build.
47+
*
4548
* @return the byte contents of the JAR.
4649
* @throws UncheckedIOException if the JAR cannot be created.
4750
* @since 0.4.0
4851
*/
4952
@API(since = "0.4.0", status = Status.STABLE)
5053
default byte[] asJar() {
54+
// TODO(ascopes): move this to impl level before 1.0.0 ideally.
5155
return uncheckedIo(() -> {
5256
try (var baos = new ByteArrayOutputStream()) {
5357
JarFactoryImpl.getInstance().createJarFrom(baos, getPath());

0 commit comments

Comments
 (0)