com.netflix.hollow.api.codegen

Class HollowAPIGenerator

java.lang.Object

com.netflix.hollow.api.codegen.HollowAPIGenerator

public class HollowAPIGenerator
extends java.lang.Object

This class is used to generate java code which defines an implementation of a HollowAPI. The generated java code is based on a data model (defined by a set of HollowSchema), and will contain convenience methods for traversing a dataset, based on the specific fields in the data model. You may also run the main() method directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HollowAPIGenerator.Builder
static class	HollowAPIGenerator.GeneratorArguments An enumeration of possible arguments to the code generator when being called via the main function.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiClassname
protected CodeGeneratorConfig	config
protected HollowDataset	dataset
protected java.nio.file.Path	destinationPath
protected HollowErgonomicAPIShortcuts	ergonomicShortcuts
protected boolean	hasCollectionsInDataSet
protected java.lang.String	packageName
protected boolean	parameterizeClassNames
protected java.util.Set<java.lang.String>	parameterizedTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset) Deprecated. use HollowAPIGenerator(String, String, HollowDataset, Path) and use generateSourceFiles()
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, boolean parameterizeAllClassNames) Deprecated. use HollowAPIGenerator(String, String, HollowDataset, boolean, Path) and use generateSourceFiles()
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, boolean parameterizeAllClassNames, java.nio.file.Path destinationPath)
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, java.nio.file.Path destinationPath)
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, java.util.Set<java.lang.String> parameterizeSpecificTypeNames) Deprecated. use HollowAPIGenerator(String, String, HollowDataset, Set, Path) and use generateSourceFiles()
protected	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, java.util.Set<java.lang.String> parameterizedTypes, boolean parameterizeAllClassNames, boolean useErgonomicShortcuts) Deprecated. construct with a destinationPath and use generateSourceFiles()
protected	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, java.util.Set<java.lang.String> parameterizedTypes, boolean parameterizeAllClassNames, boolean useErgonomicShortcuts, java.nio.file.Path destinationPath)
	HollowAPIGenerator(java.lang.String apiClassname, java.lang.String packageName, HollowDataset dataset, java.util.Set<java.lang.String> parameterizedTypes, java.nio.file.Path destinationPath)

Method Summary

Modifier and Type	Method and Description
protected void	generateFile(java.io.File directory, HollowJavaFileGenerator generator) Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFile(HollowJavaFileGenerator)
void	generateFiles(java.io.File directory) Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFiles()
void	generateFiles(java.lang.String directory) Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFiles()
protected void	generateFilesForHollowSchemas(java.io.File directory) Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFilesForHollowSchemas()
protected void	generateSourceFile(HollowJavaFileGenerator generator)
void	generateSourceFiles() Generate all files under destinationPath
protected void	generateSourceFilesForHollowSchemas() Generate files based on dataset schemas under destinationPath
protected HollowFactoryJavaGenerator	getHollowFactoryGenerator(HollowSchema schema)
protected HollowJavaFileGenerator	getHollowObjectGenerator(HollowSchema schema)
protected HollowJavaFileGenerator	getStaticAPIGenerator(HollowSchema schema)
protected static boolean	hasCollectionsInDataSet(HollowDataset dataset) Determines whether DataSet contains any collections schema
static void	main(java.lang.String[] args) Usage: java HollowAPIGenerator --argName1=argValue1 --argName2==argValue2.
void	reservePrimaryKeyIndexForTypeWithPrimaryKey(boolean reservePrimaryKeyIndexForTypeWithPrimaryKey) Use this method to specify to only generate PrimaryKeyIndex for Types that has PrimaryKey defined Defaults to false to be backwards compatible
void	setClassPostfix(java.lang.String classPostfix) Use this method to override the default postfix "Hollow" for all generated Hollow object classes.
protected void	setCodeGeneratorConfig(CodeGeneratorConfig config) Set the CodeGeneratorConfig
void	setGetterPrefix(java.lang.String getterPrefix) Use this method to override the default prefix "_" for all getters on all generated Hollow object classes.
void	setRestrictApiToFieldType(boolean restrictApiToFieldType) If setRestrictApiToFieldType is true, api code only generates get<FieldName> with return type as per schema Defaults to false to be backwards compatible
void	setUseAggressiveSubstitutions(boolean useAggressiveSubstitutions) Use this method to override generated classnames for type names corresponding to any class in the java.lang package.
void	setUseBooleanFieldErgonomics(boolean useBooleanFieldErgonomics) Use this method to specify to use new boolean field ergonomics for generated API Defaults to false to be backwards compatible
void	setUseHollowPrimitiveTypes(boolean useHollowPrimitiveTypes) Use this method to specify to use Hollow Primitive Types instead of generating them per project Defaults to false to be backwards compatible
void	setUsePackageGrouping(boolean usePackageGrouping) Use this method to specify to use sub packages in generated code instead of single package Defaults to false to be backwards compatible

Methods inherited from class java.lang.Object

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

Field Detail

apiClassname

protected final java.lang.String apiClassname

packageName

protected final java.lang.String packageName

destinationPath

protected final java.nio.file.Path destinationPath

dataset

protected final HollowDataset dataset

parameterizedTypes

protected final java.util.Set<java.lang.String> parameterizedTypes

parameterizeClassNames

protected final boolean parameterizeClassNames

hasCollectionsInDataSet

protected final boolean hasCollectionsInDataSet

ergonomicShortcuts

protected final HollowErgonomicAPIShortcuts ergonomicShortcuts

config

protected CodeGeneratorConfig config

Constructor Detail

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset)

Deprecated. use HollowAPIGenerator(String, String, HollowDataset, Path) and use generateSourceFiles()

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset,
                          java.nio.file.Path destinationPath)

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

destinationPath - the directory under which the source files will be generated

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset,
                          boolean parameterizeAllClassNames)

Deprecated. use HollowAPIGenerator(String, String, HollowDataset, boolean, Path) and use generateSourceFiles()

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

parameterizeAllClassNames - if true, all methods which return a Hollow Object will be parameterized. This is useful when alternate implementations are desired for some types.

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset,
                          boolean parameterizeAllClassNames,
                          java.nio.file.Path destinationPath)

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

parameterizeAllClassNames - if true, all methods which return a Hollow Object will be parameterized. This is useful when alternate implementations are desired for some types.

destinationPath - the directory under which the source files will be generated

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset,
                          java.util.Set<java.lang.String> parameterizeSpecificTypeNames)

Deprecated. use HollowAPIGenerator(String, String, HollowDataset, Set, Path) and use generateSourceFiles()

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

parameterizeSpecificTypeNames - methods with matching names which return a Hollow Object will be parameterized. This is useful when alternate implementations are desired for some types.

HollowAPIGenerator

public HollowAPIGenerator(java.lang.String apiClassname,
                          java.lang.String packageName,
                          HollowDataset dataset,
                          java.util.Set<java.lang.String> parameterizedTypes,
                          java.nio.file.Path destinationPath)

Parameters:

apiClassname - the class name of the generated implementation of HollowAPI

packageName - the package name under which all generated classes will be placed

dataset - a HollowStateEngine containing the schemas which define the data model.

parameterizedTypes - the parameterized types

destinationPath - the directory under which the source files will be generated

HollowAPIGenerator

protected HollowAPIGenerator(java.lang.String apiClassname,
                             java.lang.String packageName,
                             HollowDataset dataset,
                             java.util.Set<java.lang.String> parameterizedTypes,
                             boolean parameterizeAllClassNames,
                             boolean useErgonomicShortcuts)

Deprecated. construct with a destinationPath and use generateSourceFiles()

Parameters:

apiClassname - the api class name

packageName - the api package name

dataset - the data set

parameterizedTypes - the set of parameterized types

parameterizeAllClassNames - true if class names should be parameterized

useErgonomicShortcuts - true if ergonomic shortcuts should be used

HollowAPIGenerator

protected HollowAPIGenerator(java.lang.String apiClassname,
                             java.lang.String packageName,
                             HollowDataset dataset,
                             java.util.Set<java.lang.String> parameterizedTypes,
                             boolean parameterizeAllClassNames,
                             boolean useErgonomicShortcuts,
                             java.nio.file.Path destinationPath)

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Usage: java HollowAPIGenerator --argName1=argValue1 --argName2==argValue2. See HollowAPIGenerator.GeneratorArguments for available arguments.

Parameters:

args - the arguments

Throws:

java.io.IOException - if a schema could not be read or the data model written

java.lang.ClassNotFoundException - if a class of a data model cannot be loaded

hasCollectionsInDataSet

protected static boolean hasCollectionsInDataSet(HollowDataset dataset)

Determines whether DataSet contains any collections schema

Parameters:

dataset - the data set

Returns:

true if the data set contains any collections schema

setCodeGeneratorConfig

protected void setCodeGeneratorConfig(CodeGeneratorConfig config)

Set the CodeGeneratorConfig

Parameters:

config - the configuration

setClassPostfix

public void setClassPostfix(java.lang.String classPostfix)

Use this method to override the default postfix "Hollow" for all generated Hollow object classes.

Parameters:

classPostfix - the postfix for all generated Hollow object classes

setGetterPrefix

public void setGetterPrefix(java.lang.String getterPrefix)

Use this method to override the default prefix "_" for all getters on all generated Hollow object classes.

Parameters:

getterPrefix - the prefix for all generated getters

setUseAggressiveSubstitutions

public void setUseAggressiveSubstitutions(boolean useAggressiveSubstitutions)

Use this method to override generated classnames for type names corresponding to any class in the java.lang package. Defaults to false, which overrides only type names corresponding to a few select classes in java.lang.

Parameters:

useAggressiveSubstitutions - true if applied.

setUseBooleanFieldErgonomics

public void setUseBooleanFieldErgonomics(boolean useBooleanFieldErgonomics)

Use this method to specify to use new boolean field ergonomics for generated API Defaults to false to be backwards compatible

Parameters:

useBooleanFieldErgonomics - true if applied.

setUsePackageGrouping

public void setUsePackageGrouping(boolean usePackageGrouping)

Use this method to specify to use sub packages in generated code instead of single package Defaults to false to be backwards compatible

Parameters:

usePackageGrouping - true if applied.

reservePrimaryKeyIndexForTypeWithPrimaryKey

public void reservePrimaryKeyIndexForTypeWithPrimaryKey(boolean reservePrimaryKeyIndexForTypeWithPrimaryKey)

Use this method to specify to only generate PrimaryKeyIndex for Types that has PrimaryKey defined Defaults to false to be backwards compatible

Parameters:

reservePrimaryKeyIndexForTypeWithPrimaryKey - true if applied.

setUseHollowPrimitiveTypes

public void setUseHollowPrimitiveTypes(boolean useHollowPrimitiveTypes)

Use this method to specify to use Hollow Primitive Types instead of generating them per project Defaults to false to be backwards compatible

Parameters:

useHollowPrimitiveTypes - true if applied.

setRestrictApiToFieldType

public void setRestrictApiToFieldType(boolean restrictApiToFieldType)

If setRestrictApiToFieldType is true, api code only generates get<FieldName> with return type as per schema Defaults to false to be backwards compatible

Parameters:

restrictApiToFieldType - true if applied.

generateSourceFiles

public void generateSourceFiles()
                         throws java.io.IOException

Generate all files under destinationPath

Throws:

java.io.IOException - if the files cannot be generated

generateFiles

public void generateFiles(java.lang.String directory)
                   throws java.io.IOException

Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFiles()

Generate files under the specified directory

Parameters:

directory - the directory under which to generate files

Throws:

java.io.IOException - if the files cannot be generated

generateFiles

public void generateFiles(java.io.File directory)
                   throws java.io.IOException

Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFiles()

Generate files under the specified directory

Parameters:

directory - the directory under which to generate files

Throws:

java.io.IOException - if the files cannot be generated

generateSourceFilesForHollowSchemas

protected void generateSourceFilesForHollowSchemas()
                                            throws java.io.IOException

Generate files based on dataset schemas under destinationPath

Throws:

java.io.IOException - if the files cannot be generated

generateFilesForHollowSchemas

protected void generateFilesForHollowSchemas(java.io.File directory)
                                      throws java.io.IOException

Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFilesForHollowSchemas()

Generate files based on dataset schemas under the specified directory

Parameters:

directory - the directory under which to generate files

Throws:

java.io.IOException - if the files cannot be generated

generateSourceFile

protected void generateSourceFile(HollowJavaFileGenerator generator)
                           throws java.io.IOException

Throws:

java.io.IOException

generateFile

protected void generateFile(java.io.File directory,
                            HollowJavaFileGenerator generator)
                     throws java.io.IOException

Deprecated. construct HollowAPIGenerator with a destinationPath then call generateSourceFile(HollowJavaFileGenerator)

Parameters:

directory - the directory under which to generate a file

generator - the file generator

Throws:

java.io.IOException - if the file cannot be generated

getStaticAPIGenerator

protected HollowJavaFileGenerator getStaticAPIGenerator(HollowSchema schema)

getHollowObjectGenerator

protected HollowJavaFileGenerator getHollowObjectGenerator(HollowSchema schema)

getHollowFactoryGenerator

protected HollowFactoryJavaGenerator getHollowFactoryGenerator(HollowSchema schema)