FileGeneratorBuilder (vertigo-studio 3.4.0 API)

java.lang.Object
- io.vertigo.studio.impl.generator.FileGeneratorBuilder

All Implemented Interfaces:

io.vertigo.core.lang.Builder<FileGenerator>
```
public final class FileGeneratorBuilder
extends Object
implements io.vertigo.core.lang.Builder<FileGenerator>
```
This class provides a way to create a FileFenerator.

Author:

pchretien, mlaroche

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FileGenerator`	`build()`
`FileGeneratorBuilder`	`withEncoding(String encoding)`
`FileGeneratorBuilder`	`withFileName(String fileName)`
`FileGeneratorBuilder`	`withGenSubDir(String genSubDir)`
`FileGeneratorBuilder`	`withModel(Map<String,Object> model)`
`FileGeneratorBuilder`	`withPackageName(String packageName)`
`FileGeneratorBuilder`	`withTargetGenDir(String targetGenDir)`
`FileGeneratorBuilder`	`withTemplateName(Class relativeClass, String templateName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withModel

public FileGeneratorBuilder withModel(Map<String,Object> model)

Parameters:: model - the model
Returns:: this builder

withFileName
```
public FileGeneratorBuilder withFileName(String fileName)
```
Parameters:

fileName - the name of the file including extension

Returns:

this builder

withPackageName
```
public FileGeneratorBuilder withPackageName(String packageName)
```
Parameters:

packageName - the name of the package

Returns:

this builder

withEncoding
```
public FileGeneratorBuilder withEncoding(String encoding)
```
Parameters:

packageName - the name of the package

Returns:

this builder

withTemplateName

public FileGeneratorBuilder withTemplateName(Class relativeClass,
                                             String templateName)

Parameters:: templateName - the name of the template
Returns:: this builder

withTargetGenDir
```
public FileGeneratorBuilder withTargetGenDir(String targetGenDir)
```
Parameters:

targetGenDir - Repertoire de destination

Returns:

this builder

withGenSubDir
```
public FileGeneratorBuilder withGenSubDir(String genSubDir)
```
Parameters:

genSubDir - Nom subdir de génération

Returns:

this builder

build
```
public FileGenerator build()
```
Specified by:

build in interface io.vertigo.core.lang.Builder<FileGenerator>