Package org.instancio.generator.specs

Interface CsvSpec

All Superinterfaces:

CsvGeneratorSpec, GeneratorSpec<String>, Supplier<String>, ValueSpec<String>

@ExperimentalApi
public interface CsvSpec
extends CsvGeneratorSpec, ValueSpec<String>

Spec for generating CSV.

Since:

2.12.0

Method Summary

Modifier and Type	Method	Description
CsvSpec	column(String name, Generator<?> generator)	Specifies the column name and the generator for producing the values.
CsvSpec	column(String name, GeneratorSpec<?> generatorSpec)	Specifies the column name and the generator spec for producing the values.
CsvSpec	delimiter(String delimiter)	Specifies the delimiter used to separate values.
CsvSpec	lineSeparator(String lineSeparator)	Specifies the line separator.
CsvSpec	noHeader()	Omit CSV header from the output.
CsvSpec	rows(int rows)	Number of rows to generate.
CsvSpec	rows(int minRows, int maxRows)	A range for the number of rows to generate.
CsvSpec	wrapIf(Predicate<Object> condition)	A condition that must be satisfied to wrap a value.
CsvSpec	wrapWith(String wrapWith)	A string to wrap the values with, for example quotes.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, nullable, stream

Method Details

column

CsvSpec column(String name,
 Generator<?> generator)

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

Parameters:

name - of the column

generator - for generating values

Returns:

spec builder

See Also:

• CsvGeneratorSpec.column(String, GeneratorSpec)

column

CsvSpec column(String name,
 GeneratorSpec<?> generatorSpec)

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

This method can be used with Instancio.gen(), for example:

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

Specified by:

column in interface CsvGeneratorSpec

Parameters:

name - of the column

generatorSpec - for generating values

Returns:

spec builder

See Also:

• CsvGeneratorSpec.column(String, Generator)

rows

CsvSpec rows(int rows)

Number of rows to generate.

Specified by:

rows in interface CsvGeneratorSpec

Parameters:

rows - number of rows to generate

Returns:

spec builder

See Also:

• CsvGeneratorSpec.rows(int, int)

rows

CsvSpec rows(int minRows,
 int maxRows)

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

Parameters:

minRows - minimum number of rows (inclusive)

maxRows - maximum number of rows (inclusive)

Returns:

spec builder

See Also:

• CsvGeneratorSpec.rows(int)

noHeader

CsvSpec noHeader()

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

Specified by:

noHeader in interface CsvGeneratorSpec

Returns:

spec builder

wrapWith

CsvSpec wrapWith(String wrapWith)

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

Specified by:

wrapWith in interface CsvGeneratorSpec

Parameters:

wrapWith - a string to wrap the values with.

Returns:

spec builder

See Also:

• CsvGeneratorSpec.wrapIf(Predicate)

wrapIf

CsvSpec wrapIf(Predicate<Object> condition)

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 = Instancio.gen().text().csv()
      .column("column1", Instancio.gen().string())
      .column("column2", Instancio.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

Parameters:

condition - for wrapping a value

Returns:

spec builder

See Also:

• CsvGeneratorSpec.wrapWith(String)

delimiter

CsvSpec delimiter(String delimiter)

Specifies the delimiter used to separate values. The default delimiter is a comma (',').

Specified by:

delimiter in interface CsvGeneratorSpec

Parameters:

delimiter - the character used to separate values

Returns:

spec builder

Since:

5.0.0

lineSeparator

CsvSpec lineSeparator(String lineSeparator)

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

Specified by:

lineSeparator in interface CsvGeneratorSpec

Parameters:

lineSeparator - for separating rows

Returns:

spec builder