Module io.github.ascopes.jct

Package io.github.ascopes.jct.workspaces

Interface DirectoryBuilder

All Known Subinterfaces:

ManagedDirectory

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

Chainable builder for creating directories.

Since:

0.0.1

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
ManagedDirectory	copyContentsFrom(File dir)	Copy the contents of the directory at the given path recursively into this directory.
default ManagedDirectory	copyContentsFrom(String... fragments)	Copy the contents of the directory at the given path recursively into this directory.
ManagedDirectory	copyContentsFrom(Path rootDir)	Copy the contents of the directory at the given path recursively into this directory.
ManagedDirectory	copyContentsFrom(List<String> fragments)	Copy the contents of the directory at the given path recursively into this directory.
ManagedDirectory	thatIsEmpty()	Create an empty directory.

Method Details

copyContentsFrom

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

Copy the contents of the directory at the given path recursively into this directory.

Symbolic links will not be followed.

This uses the default file system. If you want to use a different FileSystem as your source, then use copyContentsFrom(Path) instead.

Examples:

   // Letting JCT infer the correct path separators to use (recommended).
   directoryBuilder.copyContentsFrom(List.of("foo", "bar", "baz"));

   // Using POSIX platform-specific separators (may cause issues if your tests run on Windows)
   directoryBuilder.copyContentsFrom(List.of("foo/bar/baz"));

   // Using Windows platform-specific separators (may cause issues if your tests run on POSIX)
   directoryBuilder.copyContentsFrom(List.of("foo\\bar\\baz"));
 

Parameters:

fragments - parts of the path.

Returns:

the root managed directory for further configuration.

Throws:

IllegalArgumentException - if no path fragments are provided.

NullPointerException - if any null path fragments are provided.

Since:

4.0.0

See Also:

• copyContentsFrom(Path)
• copyContentsFrom(String...)

copyContentsFrom

default ManagedDirectory copyContentsFrom(String... fragments)

Copy the contents of the directory at the given path recursively into this directory.

Symbolic links will not be followed.

This uses the default file system. If you want to use a different FileSystem as your source, then use copyContentsFrom(Path) instead.

Examples:

   // Letting JCT infer the correct path separators to use (recommended).
   directoryBuilder.copyContentsFrom("foo", "bar", "baz");

   // Using POSIX platform-specific separators (may cause issues if your tests run on Windows)
   directoryBuilder.copyContentsFrom("foo/bar/baz");

   // Using Windows platform-specific separators (may cause issues if your tests run on POSIX)
   directoryBuilder.copyContentsFrom("foo\\bar\\baz");
 

Parameters:

fragments - parts of the path.

Returns:

the root managed directory for further configuration.

Throws:

IllegalArgumentException - if no path fragments are provided.

NullPointerException - if any null path fragments are provided.

See Also:

• copyContentsFrom(Path)
• copyContentsFrom(List)

copyContentsFrom

ManagedDirectory copyContentsFrom(File dir)

Copy the contents of the directory at the given path recursively into this directory.

Symbolic links will not be followed.

  directory.copyContentsFrom(new File("code/examples"));
 

Parameters:

dir - the directory to copy the contents from.

Returns:

the root managed directory for further configuration.

copyContentsFrom

ManagedDirectory copyContentsFrom(Path rootDir)

Copy the contents of the directory at the given path recursively into this directory.

Symbolic links will not be followed.

   directory.copyContentsFrom(Path.of("code", "examples"));
 

Parameters:

rootDir - the directory to copy the contents from.

Returns:

the root managed directory for further configuration.

thatIsEmpty

ManagedDirectory thatIsEmpty()

Create an empty directory.

   directory.thatIsEmpty();
 

Returns:

the root managed directory for further configuration.