au.com.anthonybruno

Class Gen

java.lang.Object

au.com.anthonybruno.Gen

All Implemented Interfaces:

FieldDefinition, FileTypeDefinition, RecordDefinition, ResultDefinition, StartDefinition

public class Gen
extends Object
implements FileTypeDefinition, ResultDefinition, StartDefinition, RecordDefinition, FieldDefinition

Method Summary

Modifier and Type	Method and Description
FieldDefinition	addField(String name, Generator generator) Adds a field to be generated.
ResultDefinition	asCsv() Sets the format to csv.
ResultDefinition	asCsv(CsvSettings csvSettings) Sets the format to csv with configuration options given by the specified settings object.
ResultDefinition	asFixedWidth(FixedWidthSettings fixedWidthSettings) Sets the format to be fixed width with configuration options given by the specified settings object.
FileTypeDefinition	generate(int num) Specifies how many records will be generated.
static StartDefinition	start()
File	toFile(File file) Saves the generated data to the specified File and returns it.
File	toFile(String path) Saves the generated date to a File specified by the path and returns it.
String	toStringForm() Returns the generated data as a String.
RecordDefinition	use(Class<?> c) Specifies a class that will be used to generate fields.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static StartDefinition start()

use

public RecordDefinition use(Class<?> c)

Description copied from interface: StartDefinition

Specifies a class that will be used to generate fields.

Specified by:

use in interface StartDefinition

Parameters:

c - the class which the random data is to be generated for

Returns:

a RecordDefinition that allows the specification of the number of records to generate

addField

public FieldDefinition addField(String name,
                                Generator generator)

Description copied from interface: StartDefinition

Adds a field to be generated.

Specified by:

addField in interface FieldDefinition

Specified by:

addField in interface StartDefinition

Parameters:

name - String that names the field

generator - Generator object that creates random values for the field

Returns:

A FieldDefinition that allows more fields to be added

asCsv

public ResultDefinition asCsv()

Description copied from interface: FileTypeDefinition

Sets the format to csv.

Specified by:

asCsv in interface FileTypeDefinition

Returns:

a ResultDefinition object to specify how the generated data is saved.

asCsv

public ResultDefinition asCsv(CsvSettings csvSettings)

Description copied from interface: FileTypeDefinition

Sets the format to csv with configuration options given by the specified settings object.

Specified by:

asCsv in interface FileTypeDefinition

Parameters:

csvSettings - a CsvSettings object which configures how the csv is created such as whether or include a heading row.

Returns:

a ResultDefinition object to specify how the generated data is saved.

asFixedWidth

public ResultDefinition asFixedWidth(FixedWidthSettings fixedWidthSettings)

Description copied from interface: FileTypeDefinition

Sets the format to be fixed width with configuration options given by the specified settings object.

Specified by:

asFixedWidth in interface FileTypeDefinition

Parameters:

fixedWidthSettings - a FixedWidthSettings object that specifies the fixed width desired

Returns:

a ResultDefinition object to specify how the generated data is saved.

toFile

public File toFile(File file)

Description copied from interface: ResultDefinition

Saves the generated data to the specified File and returns it.

Specified by:

toFile in interface ResultDefinition

Parameters:

file - a File where the generated data will be written to

Returns:

a File containing the generated data

toFile

public File toFile(String path)

Description copied from interface: ResultDefinition

Saves the generated date to a File specified by the path and returns it.

Specified by:

toFile in interface ResultDefinition

Parameters:

path - The directory path where the file will be saved

Returns:

a File containing the generated data

toStringForm

public String toStringForm()

Description copied from interface: ResultDefinition

Returns the generated data as a String.

Specified by:

toStringForm in interface ResultDefinition

Returns:

a String containing the generated data

generate

public FileTypeDefinition generate(int num)

Description copied from interface: RecordDefinition

Specifies how many records will be generated.

Specified by:

generate in interface RecordDefinition

Parameters:

num - the int defining how many rows will be generated

Returns:

A FileTypeDefinition which allows the specification of the type of file to create