Package org.instancio.internal.generator.text

Class CsvGenerator

java.lang.Object

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

org.instancio.internal.generator.text.CsvGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, CsvGeneratorSpec, CsvSpec, NullableGeneratorSpec<String>, ValueSpec<String>

public class CsvGenerator
extends AbstractGenerator<String>
implements CsvSpec

Constructor Summary

Constructors

Constructor	Description
CsvGenerator()
CsvGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
CsvGenerator	column(String name, Generator<?> generator)	Specifies the column name and the generator for producing the values.
CsvGenerator	column(String name, GeneratorSpec<?> generatorSpec)	Specifies the column name and the generator spec for producing the values.
CsvGenerator	lineSeparator(String lineSeparator)	Specifies the line separator.
CsvGenerator	noHeader()	Omit CSV header from the output.
CsvGenerator	nullable()	Indicates that null value can be generated.
CsvGenerator	rows(int rows)	Number of rows to generate.
CsvGenerator	rows(int min, int max)	A range for the number of rows to generate.
CsvGenerator	separator(String separator)	Specifies the value separator.
protected String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
CsvGenerator	wrapIf(Predicate<Object> wrapIf)	A condition that must be satisfied to wrap a value.
CsvGenerator	wrapWith(String wrapWith)	A string to wrap the values with, for example quotes.

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.ValueSpec

get, list, map, stream, toModel

Constructor Details

CsvGenerator

public CsvGenerator()

CsvGenerator

public CsvGenerator(GeneratorContext context)

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<String>

Returns:

spec name if defined, or null otherwise

column

public CsvGenerator column(String name,
 GeneratorSpec<?> generatorSpec)

Description copied from interface: CsvGeneratorSpec

Specifies the column name and the generator spec for producing the values.

This method can be used with Gen, for example:

   String csv = Gen.text().csv()
      .column("productCode", Gen.string().length(5))
      .column("quantity", Gen.ints().range(1, 100))
      .get();
 

Specified by:

column in interface CsvGeneratorSpec

Specified by:

column in interface CsvSpec

Parameters:

name - of the column

generatorSpec - for generating values

Returns:

spec builder

See Also:

• CsvGeneratorSpec.column(String, Generator)

column

public CsvGenerator column(String name,
 Generator<?> generator)

Description copied from interface: CsvGeneratorSpec

Specifies the column name and the generator for producing the values.

Example:

   DataImport data = Instancio.of(DataImport.class)
       .generate(field(DataImport::getCsv), gen -> gen.text().csv()
           .column("productCode", random -> random.upperCaseAlphabetic(5))
           .column("skuCode", new SkuCodeGenerator())
           .column("quantity", random -> random.intRange(1, 100)))
      .create();
 

Specified by:

column in interface CsvGeneratorSpec

Specified by:

column in interface CsvSpec

Parameters:

name - of the column

generator - for generating values

Returns:

spec builder

See Also:

• CsvGeneratorSpec.column(String, GeneratorSpec)

rows

public CsvGenerator rows(int rows)

Description copied from interface: CsvGeneratorSpec

Number of rows to generate.

Specified by:

rows in interface CsvGeneratorSpec

Specified by:

rows in interface CsvSpec

Parameters:

rows - number of rows to generate

Returns:

spec builder

See Also:

• CsvGeneratorSpec.rows(int, int)

rows

public CsvGenerator rows(int min,
 int max)

Description copied from interface: CsvGeneratorSpec

A range for the number of rows to generate. A random number of rows within the given range will be generated.

Specified by:

rows in interface CsvGeneratorSpec

Specified by:

rows in interface CsvSpec

Parameters:

min - minimum number of rows (inclusive)

max - maximum number of rows (inclusive)

Returns:

spec builder

See Also:

• CsvGeneratorSpec.rows(int)

noHeader

public CsvGenerator noHeader()

Description copied from interface: CsvGeneratorSpec

Omit CSV header from the output. The default is to include the header.

Specified by:

noHeader in interface CsvGeneratorSpec

Specified by:

noHeader in interface CsvSpec

Returns:

spec builder

wrapWith

public CsvGenerator wrapWith(String wrapWith)

Description copied from interface: CsvGeneratorSpec

A string to wrap the values with, for example quotes. The default is null.

Specified by:

wrapWith in interface CsvGeneratorSpec

Specified by:

wrapWith in interface CsvSpec

Parameters:

wrapWith - a string to wrap the values with.

Returns:

spec builder

See Also:

• CsvGeneratorSpec.wrapIf(Predicate)

wrapIf

public CsvGenerator wrapIf(Predicate<Object> wrapIf)

Description copied from interface: CsvGeneratorSpec

A condition that must be satisfied to wrap a value. If CsvGeneratorSpec.wrapWith(String) is specified, the default is to wrap all values.

For example, to specify that only strings should be wrapped:

   String csv = Gen.text().csv()
      .column("column1", Gen.string())
      .column("column2", Gen.ints())
      .wrapWith("\"")
      .wrapIf(value -> value instanceof String)
      .get()

   // Sample output:
   //
   // column1,column2
   // "KJDTJZRCYY",2454
   // "LUOQGNQUUJ",9125
   // "FHRFTI",6809
 

Specified by:

wrapIf in interface CsvGeneratorSpec

Specified by:

wrapIf in interface CsvSpec

Parameters:

wrapIf - for wrapping a value

Returns:

spec builder

See Also:

• CsvGeneratorSpec.wrapWith(String)

separator

public CsvGenerator separator(String separator)

Description copied from interface: CsvGeneratorSpec

Specifies the value separator. The default is comma: ','.

Specified by:

separator in interface CsvGeneratorSpec

Specified by:

separator in interface CsvSpec

Parameters:

separator - for separating values

Returns:

spec builder

lineSeparator

public CsvGenerator lineSeparator(String lineSeparator)

Description copied from interface: CsvGeneratorSpec

Specifies the line separator. The default is System.lineSeparator().

Specified by:

lineSeparator in interface CsvGeneratorSpec

Specified by:

lineSeparator in interface CsvSpec

Parameters:

lineSeparator - for separating rows

Returns:

spec builder

nullable

public CsvGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

tryGenerateNonNull

protected String 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<String>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null