io.vertx.codegen

Class Generator<M extends Model>

java.lang.Object

io.vertx.codegen.Generator<M>

Type Parameters:

M - the model

Direct Known Subclasses:

DataObjectCheatsheetGen, DataObjectHelperGen, EnumCheatsheetGen

public abstract class Generator<M extends Model>
extends Object

A generator for a Model.

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
ProcessingEnvironment	env
boolean	incremental
Set<String>	kinds
String	name

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Modifier and Type	Method and Description
Collection<Class<? extends Annotation>>	annotations()
String	filename(M model) Generate the file name for the model.
void	load(ProcessingEnvironment processingEnv)
String	render(M model, int index, int size, Map<String,Object> session) Render the model

Methods inherited from class java.lang.Object

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

Field Detail

env

public ProcessingEnvironment env

name

public String name

kinds

public Set<String> kinds

incremental

public boolean incremental

Constructor Detail

Generator

public Generator()

Method Detail

annotations

public Collection<Class<? extends Annotation>> annotations()

load

public void load(ProcessingEnvironment processingEnv)

filename

public String filename(M model)

Generate the file name for the model.

When the returned value

• is null, no file is created
• does not contain / and ends with .java, the file is created as a source file by the annotation processor and the class will be compiled by the current compilation process
• starts with the resources/ prefix, the file is created as a resource file by the annotation processor using the remaining suffix value and the file will likely end in the classes directory
• otherwise the resource will be created as a file on the filesystem, a value not starting with / is created relative to the codegen.output directory

Parameters:

model - the model

Returns:

the filename or null if no generation should happen

render

public String render(M model,
                     int index,
                     int size,
                     Map<String,Object> session)

Render the model

Parameters:

model - the model

index - the index for an incremental generator

size - the number of models for an incremental generator

session - the session

Returns:

the rendered string or null