net.morimekta.providence.generator.format.json

Class JsonGeneratorFactory

java.lang.Object

net.morimekta.providence.generator.format.json.JsonGeneratorFactory

All Implemented Interfaces:

GeneratorFactory

public class JsonGeneratorFactory
extends Object
implements GeneratorFactory

Factory for JSON generator.

Constructor Summary

Constructors

Constructor and Description
JsonGeneratorFactory()

Method Summary

Modifier and Type	Method and Description
Generator	createGenerator(FileManager manager, GeneratorOptions generatorOptions, Collection<String> options) Create the actual generator.
String	generatorDescription() A general description of the generator.
String	generatorName() The name of the generator.
void	printGeneratorOptionsHelp(PrintStream out) Print a listing of the generator options in a CLI like point list.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonGeneratorFactory

public JsonGeneratorFactory()

Method Detail

generatorName

public String generatorName()

Description copied from interface: GeneratorFactory

The name of the generator. This is what must be matched in the --gen generator CLI argument.

Specified by:

generatorName in interface GeneratorFactory

Returns:

The name of the generator.

generatorDescription

public String generatorDescription()

Description copied from interface: GeneratorFactory

A general description of the generator. Should be in the range of 20-60 characters.

Specified by:

generatorDescription in interface GeneratorFactory

Returns:

The generator description.

printGeneratorOptionsHelp

public void printGeneratorOptionsHelp(PrintStream out)

Description copied from interface: GeneratorFactory

Print a listing of the generator options in a CLI like point list. E.g.:

 - first          : The first option, does this.
 - second         : The second option, does that.
 

Specified by:

printGeneratorOptionsHelp in interface GeneratorFactory

Parameters:

out - The print stream to write to.

createGenerator

public Generator createGenerator(FileManager manager,
                                 GeneratorOptions generatorOptions,
                                 Collection<String> options)

Description copied from interface: GeneratorFactory

Create the actual generator. The generator instance is usually the same when generating many thrift programs, but does not need to be synchronized.

Specified by:

createGenerator in interface GeneratorFactory

Parameters:

manager - The file manager to use for creating files.

generatorOptions - The general generator options.

options - List of string options to create generator-specific options.

Returns:

The generator instance.