io.vertx.codegen.generators.cheatsheet

Class EnumCheatsheetGen

java.lang.Object

io.vertx.codegen.Generator<EnumModel>

io.vertx.codegen.generators.cheatsheet.EnumCheatsheetGen

public class EnumCheatsheetGen
extends Generator<EnumModel>

A generator for Java enums that creates cheatsheets doc.

Field Summary

Fields inherited from class io.vertx.codegen.Generator

env, incremental, kinds, name

Constructor Summary

Constructors

Constructor and Description
EnumCheatsheetGen()

Method Summary

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

Methods inherited from class io.vertx.codegen.Generator

load

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumCheatsheetGen

public EnumCheatsheetGen()

Method Detail

annotations

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

Overrides:

annotations in class Generator<EnumModel>

filename

public String filename(EnumModel model)

Description copied from class: Generator

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

Overrides:

filename in class Generator<EnumModel>

Parameters:

model - the model

Returns:

the filename or null if no generation should happen

render

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

Description copied from class: Generator

Render the model

Overrides:

render in class Generator<EnumModel>

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