org.fastnate.generator

Class WriterEntitySqlGenerator

java.lang.Object

org.fastnate.generator.EntitySqlGenerator

org.fastnate.generator.WriterEntitySqlGenerator

All Implemented Interfaces:

Closeable, AutoCloseable

public class WriterEntitySqlGenerator
extends EntitySqlGenerator

Extension of EntitySqlGenerator which writes the statements into a Writer resp. File.

Author:

Tobias Liefke

Constructor Summary

Constructors

Constructor and Description
WriterEntitySqlGenerator(Writer writer) Creates a new generator for a given writer.
WriterEntitySqlGenerator(Writer writer, GeneratorContext context) Creates a new instance of WriterEntitySqlGenerator.

Method Summary

Modifier and Type	Method and Description
void	close() Writes any missing SQL and closes any open resources.
Writer	getWriter() Used to write the SQL statements.
void	writeComment(String comment) Writes a SQL comment to the target.
void	writeSectionSeparator() Writes a new line to the target to separate different sections in the SQL file.
void	writeStatement(EntityStatement stmt) Writes the given statement to the target.

Methods inherited from class org.fastnate.generator.EntitySqlGenerator

findEntity, getContext, markExistingEntities, markExistingEntity, write, write, writeAlignmentStatements

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterEntitySqlGenerator

public WriterEntitySqlGenerator(Writer writer)

Creates a new generator for a given writer.

Parameters:

writer - the writer of the file to generate

WriterEntitySqlGenerator

public WriterEntitySqlGenerator(Writer writer,
                                GeneratorContext context)

Creates a new instance of WriterEntitySqlGenerator.

Parameters:

writer - the writer of the file to generate

context - Used to keep the state of indices and to store any configuration

Method Detail

close

public void close()
           throws IOException

Description copied from class: EntitySqlGenerator

Writes any missing SQL and closes any open resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class EntitySqlGenerator

Throws:

IOException - if the target writer throws one

writeComment

public void writeComment(String comment)
                  throws IOException

Description copied from class: EntitySqlGenerator

Writes a SQL comment to the target.

Specified by:

writeComment in class EntitySqlGenerator

Parameters:

comment - the comment to write

Throws:

IOException - if the target throws one

writeSectionSeparator

public void writeSectionSeparator()
                           throws IOException

Description copied from class: EntitySqlGenerator

Writes a new line to the target to separate different sections in the SQL file.

Specified by:

writeSectionSeparator in class EntitySqlGenerator

Throws:

IOException - if the target throws such an exception

writeStatement

public void writeStatement(EntityStatement stmt)
                    throws IOException

Description copied from class: EntitySqlGenerator

Writes the given statement to the target.

Specified by:

writeStatement in class EntitySqlGenerator

Parameters:

stmt - the SQL statement to write

Throws:

IOException - if the target throws one

getWriter

@Generated(value="lombok")
public Writer getWriter()

Used to write the SQL statements.