Package org.instancio.internal.generator.nio.file

Class PathGenerator

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<Path>

org.instancio.internal.generator.nio.file.PathGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Path>, Generator<Path>, GeneratorSpec<Path>, AsGeneratorSpec<Path>, FilePathSpec<Path>, NullableGeneratorSpec<Path>, PathAsGeneratorSpec<Path>, PathGeneratorSpec<Path>, PathSpec, ValueSpec<Path>

public class PathGenerator
extends AbstractGenerator<Path>
implements PathSpec, PathAsGeneratorSpec<Path>

Constructor Summary

Constructors

Constructor	Description
PathGenerator()
PathGenerator(GeneratorContext context)
PathGenerator(GeneratorContext context, String... directories)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
PathGenerator	createDirectory()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.
PathGenerator	createFile()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.
PathGenerator	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.
PathGenerator	name(Generator<String> nameGenerator)	Generator for the file or directory name.
PathGenerator	nullable()	Indicates that null value can be generated.
PathGenerator	prefix(String prefix)	File or directory name prefix.
PathGenerator	suffix(String suffix)	File or directory name suffix.
PathGenerator	tmp()	Generate path with java.io.tmpdir as the parent directory.
Path	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

generate, getContext, hints, isNullable, nullable

Methods inherited from class java.lang.Object

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

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

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

PathGenerator

public PathGenerator()

PathGenerator

public PathGenerator(GeneratorContext context)

PathGenerator

public PathGenerator(GeneratorContext context,
 String... directories)

Method Details

apiMethod

public String apiMethod()

Description copied from class: AbstractGenerator

Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.

Specified by:

apiMethod in class AbstractGenerator<Path>

Returns:

spec name if defined, or null otherwise

tmp

public PathGenerator tmp()

Description copied from interface: PathGeneratorSpec

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

Specified by:

tmp in interface FilePathSpec<Path>

Specified by:

tmp in interface PathAsGeneratorSpec<Path>

Specified by:

tmp in interface PathGeneratorSpec<Path>

Specified by:

tmp in interface PathSpec

Returns:

spec builder

prefix

public PathGenerator prefix(String prefix)

Description copied from interface: PathGeneratorSpec

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

Specified by:

prefix in interface FilePathSpec<Path>

Specified by:

prefix in interface PathAsGeneratorSpec<Path>

Specified by:

prefix in interface PathGeneratorSpec<Path>

Specified by:

prefix in interface PathSpec

Parameters:

prefix - to add to the file or directory name

Returns:

spec builder

suffix

public PathGenerator suffix(String suffix)

Description copied from interface: PathGeneratorSpec

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

Specified by:

suffix in interface FilePathSpec<Path>

Specified by:

suffix in interface PathAsGeneratorSpec<Path>

Specified by:

suffix in interface PathGeneratorSpec<Path>

Specified by:

suffix in interface PathSpec

Parameters:

suffix - to add to the file or directory name

Returns:

spec builder

name

public PathGenerator name(Generator<String> nameGenerator)

Description copied from interface: PathGeneratorSpec

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
 

Specified by:

name in interface FilePathSpec<Path>

Specified by:

name in interface PathAsGeneratorSpec<Path>

Specified by:

name in interface PathGeneratorSpec<Path>

Specified by:

name in interface PathSpec

Parameters:

nameGenerator - for generating the name

Returns:

spec builder

createFile

public PathGenerator createFile(InputStream content)

Description copied from interface: PathGeneratorSpec

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.

Specified by:

createFile in interface FilePathSpec<Path>

Specified by:

createFile in interface PathAsGeneratorSpec<Path>

Specified by:

createFile in interface PathGeneratorSpec<Path>

Specified by:

createFile in interface PathSpec

Parameters:

content - to write to the file

Returns:

completed spec with no further methods

See Also:

• PathGeneratorSpec.createFile()
• PathGeneratorSpec.createDirectory()

createFile

public PathGenerator createFile()

Description copied from interface: PathGeneratorSpec

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.

Specified by:

createFile in interface FilePathSpec<Path>

Specified by:

createFile in interface PathAsGeneratorSpec<Path>

Specified by:

createFile in interface PathGeneratorSpec<Path>

Specified by:

createFile in interface PathSpec

Returns:

completed spec with no further methods

See Also:

• PathGeneratorSpec.createFile(InputStream)
• PathGeneratorSpec.createDirectory()

createDirectory

public PathGenerator createDirectory()

Description copied from interface: PathGeneratorSpec

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.

Specified by:

createDirectory in interface FilePathSpec<Path>

Specified by:

createDirectory in interface PathAsGeneratorSpec<Path>

Specified by:

createDirectory in interface PathGeneratorSpec<Path>

Specified by:

createDirectory in interface PathSpec

Returns:

completed spec with no further methods

See Also:

• PathGeneratorSpec.createFile()
• PathGeneratorSpec.createFile(InputStream)

nullable

public PathGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<Path>

Specified by:

nullable in interface ValueSpec<Path>

Overrides:

nullable in class AbstractGenerator<Path>

Returns:

spec builder

tryGenerateNonNull

public Path tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Specified by:

tryGenerateNonNull in class AbstractGenerator<Path>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null