Package org.instancio.generator.specs

Interface PathGeneratorSpec<T>

All Superinterfaces:

AsGeneratorSpec<T>, GeneratorSpec<T>

All Known Subinterfaces:

FilePathSpec<T>, FileSpec, PathSpec

public interface PathGeneratorSpec<T>
extends AsGeneratorSpec<T>

Generator spec for customising Files and Paths.

Since:

2.1.0

Method Summary

Modifier and Type	Method	Description
GeneratorSpec<T>	createDirectory()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.
GeneratorSpec<T>	createFile()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.
GeneratorSpec<T>	createFile(InputStream content)	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system and content provided by the input stream written to the file.
PathGeneratorSpec<T>	name(Generator<String> nameGenerator)	Generator for the file or directory name.
PathGeneratorSpec<T>	prefix(String prefix)	File or directory name prefix.
PathGeneratorSpec<T>	suffix(String suffix)	File or directory name suffix.
PathGeneratorSpec<T>	tmp()	Generate path with java.io.tmpdir as the parent directory.

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

as, asString

Method Details

name

PathGeneratorSpec<T> name(Generator<String> nameGenerator)

Generator for the file or directory name.

Generated path names are formed using the following elements:

     [prefix][name][suffix]
 

• Prefix and suffix are optional and are null by default.
• If no generator is supplied using this method, a random 16-character lowercase name will be generated.
• The concatenation of prefix, name, and suffix must not be blank.

Example:

 List<Path> paths = Instancio.ofList(Path.class)
         .generate(all(Path.class), gen -> gen.nio().path()
                 .prefix("queued_")
                 .name(random -> random.alphanumeric(8))
                 .suffix(".csv"))
         .create();

 // Sample paths: queued_t5LG4AUw.csv, queued_o0nBWkej.csv, etc
 

Parameters:

nameGenerator - for generating the name

Returns:

spec builder

Since:

2.1.0

prefix

PathGeneratorSpec<T> prefix(String prefix)

File or directory name prefix. No prefix is added by default.

Parameters:

prefix - to add to the file or directory name

Returns:

spec builder

Since:

2.1.0

suffix

PathGeneratorSpec<T> suffix(String suffix)

File or directory name suffix. No suffix is added by default.

Parameters:

suffix - to add to the file or directory name

Returns:

spec builder

Since:

2.1.0

tmp

PathGeneratorSpec<T> tmp()

Generate path with java.io.tmpdir as the parent directory.

Returns:

spec builder

Since:

2.1.0

createDirectory

@ExperimentalApi
GeneratorSpec<T> createDirectory()

Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.

If the directory already exists, then no action will be taken.

Returns:

completed spec with no further methods

Throws:

InstancioApiException - if an error occurs creating the path

Since:

2.1.0

See Also:

• createFile()
• createFile(InputStream)

createFile

@ExperimentalApi
GeneratorSpec<T> createFile()

Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.

If the file already exists, then no action will be taken.

Returns:

completed spec with no further methods

Throws:

InstancioApiException - if an error occurs creating the path

Since:

2.1.0

See Also:

• createFile(InputStream)
• createDirectory()

createFile

@ExperimentalApi
GeneratorSpec<T> createFile(InputStream content)

Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system and content provided by the input stream written to the file.

If the file already exists, then no action will be taken.

Parameters:

content - to write to the file

Returns:

completed spec with no further methods

Throws:

InstancioApiException - if an error occurs creating the path or writing content to the file

Since:

2.1.0

See Also:

• createFile()
• createDirectory()