Module io.github.ascopes.jct

Package io.github.ascopes.jct.workspaces

Interface FileBuilder

@API(since="0.0.1",
     status=STABLE)
public interface FileBuilder

Chainable builder for creating individual files.

Since:

0.0.1

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
ManagedDirectory	asJarFrom(PathRoot directory)	Take the directory, represented by the given ManagedDirectory, and convert it into a JAR file, that will be written to the file being created.
ManagedDirectory	asJarFrom(Path directory)	Take the directory, represented by the given path, and convert it into a JAR file, that will be written to the file being created.
ManagedDirectory	copiedFromClassPath(ClassLoader classLoader, String resource)	Copy a resource from the given class loader into the file system.
ManagedDirectory	copiedFromClassPath(String resource)	Copy a resource from the class loader on the current thread into the file system.
ManagedDirectory	copiedFromFile(File file)	Copy the contents from the given file into the file system.
ManagedDirectory	copiedFromFile(Path file)	Copy the contents from the given path into the file system.
ManagedDirectory	copiedFromUrl(URL url)	Copy the contents from the given URL into the file system.
ManagedDirectory	fromInputStream(InputStream inputStream)	Copy the contents from the given input stream into the file system.
ManagedDirectory	thatIsEmpty()	Create the file but do not put anything in it.
ManagedDirectory	withContents(byte[] contents)	Create the file with the given byte contents.
default ManagedDirectory	withContents(String... lines)	Create the file with the given contents as UTF-8.
default ManagedDirectory	withContents(ByteBuffer buffer)	An overload of withContents(byte[]) that consumes a NIO byte buffer.
default ManagedDirectory	withContents(Charset charset, String... lines)	Create the file with the given contents.
ManagedDirectory	withContents(Charset charset, List<String> lines)	Create the file with the given contents.
ManagedDirectory	withContents(List<String> lines)	Create the file with the given contents as UTF-8.

Method Details

asJarFrom

@API(since="0.3.0",
     status=STABLE)
ManagedDirectory asJarFrom(PathRoot directory)

Take the directory, represented by the given ManagedDirectory, and convert it into a JAR file, that will be written to the file being created.

Parameters:

directory - the managed directory to use.

Returns:

the root managed directory for further configuration.

Since:

0.3.0

asJarFrom

@API(since="0.3.0",
     status=STABLE)
ManagedDirectory asJarFrom(Path directory)

Take the directory, represented by the given path, and convert it into a JAR file, that will be written to the file being created.

   ManagedDirectory someDirectory = ...;
   someDirectory
       .createFile("first.jar")
       .asJarFrom(firstClassOutputs);
   var secondCompilation = secondCompiler.compile(secondWorkspace);
   ...
 

Parameters:

directory - the directory to use.

Returns:

the root managed directory for further configuration.

Since:

0.3.0

copiedFromClassPath

ManagedDirectory copiedFromClassPath(ClassLoader classLoader,
 String resource)

Copy a resource from the given class loader into the file system.

   var classLoader = getClass().getClassLoader();

   directory
       .createFile("org", "example", "HelloWorld.class")
       .copiedFromClassPath(classLoader, "org/example/HelloWorld.class");
 

Parameters:

classLoader - the class loader to use.

resource - the resource to copy.

Returns:

the root managed directory for further configuration.

copiedFromClassPath

ManagedDirectory copiedFromClassPath(String resource)

Copy a resource from the class loader on the current thread into the file system.

   directory
       .createFile("org", "example", "HelloWorld.class")
       .copiedFromClassPath("org/example/HelloWorld.class");
 

Parameters:

resource - the resource to copy.

Returns:

the root managed directory for further configuration.

copiedFromFile

ManagedDirectory copiedFromFile(File file)

Copy the contents from the given file into the file system.

   var file = new File("src/test/resources/code/HelloWorld.java");

   directory
       .createFile("org", "example", "HelloWorld.java")
       .copiedFromFile(file);
 

Parameters:

file - the file to read.

Returns:

the root managed directory for further configuration.

copiedFromFile

ManagedDirectory copiedFromFile(Path file)

Copy the contents from the given path into the file system.

   var file = Path.of("src", "test", "resources", "code", "HelloWorld.java");

   directory
       .createFile("org", "example", "HelloWorld.java")
       .copiedFromFile(file);
 

Parameters:

file - the file to read.

Returns:

the root managed directory for further configuration.

copiedFromUrl

ManagedDirectory copiedFromUrl(URL url)

Copy the contents from the given URL into the file system.

   var url = URI.create("file:///code/org/example/HelloWorld.java").toURI();

   directory
       .createFile("org", "example", "HelloWorld.java")
       .copiedFromUrl(url);
 

Parameters:

url - the URL to read.

Returns:

the root managed directory for further configuration.

fromInputStream

ManagedDirectory fromInputStream(InputStream inputStream)

Copy the contents from the given input stream into the file system.

The input stream will be closed when reading completes.

   try (var is = getClass().getResourceAsStream("code/examples/HelloWorld.java")) {
     directory
         .createFile("org", "example", "HelloWorld.java")
         .fromInputStream(is);
   }
 

Parameters:

inputStream - the input stream to read.

Returns:

the root managed directory for further configuration.

thatIsEmpty

ManagedDirectory thatIsEmpty()

Create the file but do not put anything in it.

The resultant file will be 0 bytes long.

   directory
       .createFile(".gitkeep")
       .thatIsEmpty();
 

Returns:

the root managed directory for further configuration.

withContents

ManagedDirectory withContents(byte[] contents)

Create the file with the given byte contents.

   var classFile = new byte[]{
      -54, -2, -70, -66, 0, 0, 0, 63, 0, 29, 10, 0, 2, 0, 3, 7, 0, 4, 12, 0, 5, 0, 6, 1, 0,
      16, 106, 97, 118, 97, 47, 108, 97, 110, 103, 47, 79, 98, 106, 101, 99, 116, 1, 0, 6,
      60, 105, 110, 105, 116, 62, 1, 0, 3, 40, 41, 86, 9, 0, 8, 0, 9, 7, 0, 10, 12, 0, 11,
      0, 12, 1, 0, 16, 106, 97, 118, 97, 47, 108, 97, 110, 103, 47, 83, 121, 115, 116, 101,
      109, 1, 0, 3, 111, 117, 116, 1, 0, 21, 76, 106, 97, 118, 97, 47, 105, 111, 47, 80, 114,
      105, 110, 116, 83, 116, 114, 101, 97, 109, 59, 8, 0, 14, 1, 0, 13, 72, 101, 108, 108,
      111, 44, 32, 87, 111, 114, 108, 100, 33, 10, 0, 16, 0, 17, 7, 0, 18, 12, 0, 19, 0, 20,
      1, 0, 19, 106, 97, 118, 97, 47, 105, 111, 47, 80, 114, 105, 110, 116, 83, 116, 114, 101,
      97, 109, 1, 0, 7, 112, 114, 105, 110, 116, 108, 110, 1, 0, 21, 40, 76, 106, 97, 118, 97,
      47, 108, 97, 110, 103, 47, 83, 116, 114, 105, 110, 103, 59, 41, 86, 7, 0, 22, 1, 0, 10,
      72, 101, 108, 108, 111, 87, 111, 114, 108, 100, 1, 0, 4, 67, 111, 100, 101, 1, 0, 15, 76,
      105, 110, 101, 78, 117, 109, 98, 101, 114, 84, 97, 98, 108, 101, 1, 0, 4, 109, 97, 105,
      110, 1, 0, 22, 40, 91, 76, 106, 97, 118, 97, 47, 108, 97, 110, 103, 47, 83, 116, 114,
      105, 110, 103, 59, 41, 86, 1, 0, 10, 83, 111, 117, 114, 99, 101, 70, 105, 108, 101, 1,
      0, 15, 72, 101, 108, 108, 111, 87, 111, 114, 108, 100, 46, 106, 97, 118, 97, 0, 33, 0,
      21, 0, 2, 0, 0, 0, 0, 0, 2, 0, 1, 0, 5, 0, 6, 0, 1, 0, 23, 0, 0, 0, 29, 0, 1, 0, 1, 0,
      0, 0, 5, 42, -73, 0, 1, -79, 0, 0, 0, 1, 0, 24, 0, 0, 0, 6, 0, 1, 0, 0, 0, 1, 0, 9, 0,
      25, 0, 26, 0, 1, 0, 23, 0, 0, 0, 37, 0, 2, 0, 1, 0, 0, 0, 9, -78, 0, 7, 18, 13, -74, 0,
      15, -79, 0, 0, 0, 1, 0, 24, 0, 0, 0, 10, 0, 2, 0, 0, 0, 3, 0, 8, 0, 4, 0, 1, 0, 27, 0,
      0, 0, 2, 0, 28
   };

   directory
       .createFile("HelloWorld.class")
       .withContents(classFile);
 

Parameters:

contents - the bytes to write.

Returns:

the root managed directory for further configuration.

See Also:

• withContents(ByteBuffer)

withContents

@API(since="4.0.0",
     status=STABLE)
default ManagedDirectory withContents(ByteBuffer buffer)

An overload of withContents(byte[]) that consumes a NIO byte buffer.

Parameters:

buffer - the byte buffer to consume.

Returns:

the managed directory.

Since:

4.0.0

withContents

@API(since="4.0.0",
     status=STABLE)
ManagedDirectory withContents(Charset charset,
 List<String> lines)

Create the file with the given contents.

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents(StandardCharsets.US_ASCII, List.of(
        "package org.example;",
        "",
        "public class HelloWorld {",
        "  public static void main(String[] args) {",
        "    System.out.println(\"Hello, World!\");",
        "  }",
        "}"
      ));
 

Parameters:

charset - the character encoding to use.

lines - the lines to write.

Returns:

the root managed directory for further configuration.

Since:

4.0.0

See Also:

• withContents(Charset, String...)
• withContents(String...)
• withContents(List)
• withContents(byte[])

withContents

default ManagedDirectory withContents(Charset charset,
 String... lines)

Create the file with the given contents.

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents(StandardCharsets.US_ASCII, """
        package org.example;

        public class HelloWorld {
          public static void main(String[] args) {
            System.out.println("Hello, World!");
          }
        }
      """);
 

If the Java language level of your tests does not support multi-line strings, you can alternatively pass each line of text to write as a separate string. These will be written to the file using line-feed '\n' separators. For example:

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents(
        StandardCharsets.US_ASCII,
        "package org.example;",
        "",
        "public class HelloWorld {",
        "  public static void main(String[] args) {",
        "    System.out.println(\"Hello, World!\");",
        "  }",
        "}"
      );
 

Parameters:

charset - the character encoding to use.

lines - the lines to write.

Returns:

the root managed directory for further configuration.

See Also:

• withContents(List)
• withContents(Charset, List)
• withContents(String...)
• withContents(byte[])

withContents

@API(since="4.0.0",
     status=STABLE)
ManagedDirectory withContents(List<String> lines)

Create the file with the given contents as UTF-8.

If you are using multi-line strings, an example of usage would be:

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents(List.of(
        "package org.example;",
        "",
        "public class HelloWorld {",
        "  public static void main(String[] args) {",
        "    System.out.println(\"Hello, World!\");",
        "  }",
        "}"
      ));
 

Parameters:

lines - the lines to write using the default charset.

Returns:

the root managed directory for further configuration.

Since:

4.0.0

See Also:

• withContents(Charset, String...)
• withContents(String...)
• withContents(Charset, List)
• withContents(byte[])

withContents

default ManagedDirectory withContents(String... lines)

Create the file with the given contents as UTF-8.

If you are using multi-line strings, an example of usage would be:

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents("""
        package org.example;

        public class HelloWorld {
          public static void main(String[] args) {
            System.out.println("Hello, World!");
          }
        }
      """);
 

If the Java language level of your tests does not support multi-line strings, you can alternatively pass each line of text to write as a separate string. These will be written to the file using line-feed '\n' separators. For example:

   directory
      .createFile("org", "example", "HelloWorld.java")
      .withContents(
        "package org.example;",
        "",
        "public class HelloWorld {",
        "  public static void main(String[] args) {",
        "    System.out.println(\"Hello, World!\");",
        "  }",
        "}"
      );
 

Parameters:

lines - the lines to write using the default charset.

Returns:

the root managed directory for further configuration.

See Also:

• withContents(Charset, String...)
• withContents(List)
• withContents(Charset, List)
• withContents(byte[])