CodeGenerator

```
public final class CodeGenerator

                    
```
JSON Schema Code Generator. The class may be parameterised either by constructor parameters or by setting the appropriate variables after construction.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`CodeGenerator.NestedClassNameOption`
`public final class`	`CodeGenerator.TargetIndex`
`public final class`	`CodeGenerator.NameGenerator`
`public final class`	`CodeGenerator.EnumDefault`	This class is intended to look like a StringValue, for when the default value of a string is an enum value.
`public abstract class`	`CodeGenerator.CustomClass`
`public final class`	`CodeGenerator.CustomClassByURI`
`public final class`	`CodeGenerator.CustomClassByFormat`
`public final class`	`CodeGenerator.CustomClassByExtension`
`public final class`	`CodeGenerator.AppendableFilter`
`public class`	`CodeGenerator.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private CodeGenerator.NestedClassNameOption`	`nestedClassNameOption`
`private Template`	`commentTemplate`
`private Parser`	`schemaParser`
`private Parser`	`templateParser`
`private Template`	`template`
`private String`	`interfaceTemplateName`
`private Template`	`interfaceTemplate`
`private Template`	`enumTemplateField`
`private Template`	`enumTemplate`
`private TargetFileName`	`indexFileName`
`private String`	`indexTemplateName`
`private Template`	`indexTemplateField`
`private Template`	`indexTemplate`
`private Function1<TargetFileName, Writer>`	`outputResolverField`
`private Function1<TargetFileName, Writer>`	`outputResolver`
`private final Integer`	`numTargets`
`private TargetLanguage`	`targetLanguage`
`private String`	`templateName`
`private String`	`enumTemplateName`
`private String`	`basePackageName`
`private String`	`baseDirectoryName`
`private Boolean`	`derivePackageFromStructure`
`private String`	`generatorComment`
`private ClassId`	`markerInterface`
`private final Logger`	`log`

Constructor Summary

Constructors
Constructor	Description
`CodeGenerator(TargetLanguage targetLanguage, String templateName, String enumTemplateName, String basePackageName, String baseDirectoryName, Boolean derivePackageFromStructure, String generatorComment, ClassId markerInterface, Logger log)`

Method Summary

Modifier and Type	Method	Description
`final CodeGenerator.NestedClassNameOption`	`getNestedClassNameOption()`
`final Unit`	`setNestedClassNameOption(CodeGenerator.NestedClassNameOption nestedClassNameOption)`
`final Template`	`getCommentTemplate()`
`final Unit`	`setCommentTemplate(Template commentTemplate)`
`final Parser`	`getSchemaParser()`
`final Unit`	`setSchemaParser(Parser schemaParser)`
`final Parser`	`getTemplateParser()`
`final Unit`	`setTemplateParser(Parser templateParser)`
`final Template`	`getTemplate()`
`final Unit`	`setTemplate(Template template)`
`final String`	`getInterfaceTemplateName()`
`final Unit`	`setInterfaceTemplateName(String interfaceTemplateName)`
`final Template`	`getInterfaceTemplate()`
`final Unit`	`setInterfaceTemplate(Template interfaceTemplate)`
`final Template`	`getEnumTemplateField()`
`final Unit`	`setEnumTemplateField(Template enumTemplateField)`
`final Template`	`getEnumTemplate()`
`final Unit`	`setEnumTemplate(Template enumTemplate)`
`final TargetFileName`	`getIndexFileName()`
`final Unit`	`setIndexFileName(TargetFileName indexFileName)`
`final String`	`getIndexTemplateName()`
`final Unit`	`setIndexTemplateName(String indexTemplateName)`
`final Template`	`getIndexTemplateField()`
`final Unit`	`setIndexTemplateField(Template indexTemplateField)`
`final Template`	`getIndexTemplate()`
`final Unit`	`setIndexTemplate(Template indexTemplate)`
`final Function1<TargetFileName, Writer>`	`getOutputResolverField()`
`final Unit`	`setOutputResolverField(Function1<TargetFileName, Writer> outputResolverField)`
`final Function1<TargetFileName, Writer>`	`getOutputResolver()`
`final Unit`	`setOutputResolver(Function1<TargetFileName, Writer> outputResolver)`
`final Integer`	`getNumTargets()`
`final TargetLanguage`	`getTargetLanguage()`	Target language
`final Unit`	`setTargetLanguage(TargetLanguage targetLanguage)`	Target language
`final String`	`getTemplateName()`	The primary template to use for the generation of a class
`final Unit`	`setTemplateName(String templateName)`	The primary template to use for the generation of a class
`final String`	`getEnumTemplateName()`	The primary template to use for the generation of an enum
`final Unit`	`setEnumTemplateName(String enumTemplateName)`	The primary template to use for the generation of an enum
`final String`	`getBasePackageName()`	The base package name for the generated classes
`final Unit`	`setBasePackageName(String basePackageName)`	The base package name for the generated classes
`final String`	`getBaseDirectoryName()`	The base output directory for generated files
`final Unit`	`setBaseDirectoryName(String baseDirectoryName)`	The base output directory for generated files
`final Boolean`	`getDerivePackageFromStructure()`	A boolean flag to indicate the schema files in subdirectories are to be output to sub-packages
`final Unit`	`setDerivePackageFromStructure(Boolean derivePackageFromStructure)`	A boolean flag to indicate the schema files in subdirectories are to be output to sub-packages
`final String`	`getGeneratorComment()`	A comment to add to the header of generated files
`final Unit`	`setGeneratorComment(String generatorComment)`	A comment to add to the header of generated files
`final ClassId`	`getMarkerInterface()`	An optional marker interface to add to each generated class
`final Unit`	`setMarkerInterface(ClassId markerInterface)`	An optional marker interface to add to each generated class
`final Logger`	`getLog()`	A Logger object for the output of logging messages
`final Unit`	`addClassNameMapping(URI uri, String name)`
`final Unit`	`setTemplateDirectory(File directory, String suffix)`
`final Unit`	`configure(File file, URI uri)`	Configure the `CodeGenerator` using a config file, specified by a File.
`final Unit`	`configure(Path path, URI uri)`	Configure the `CodeGenerator` using a config file, specified by a Path.
`final Unit`	`configure(JSONValue json, URI uri)`	Configure the `CodeGenerator` using a config file (in the form af a parsed JSON object).
`final Unit`	`clearTargets()`	Clear the target list.
`final Unit`	`addTarget(JSONSchema schema, String className, List<String> subDirectories, String source, JSONValue json)`	Add a target using the supplied details.
`final Unit`	`addTarget(URI uri)`	Add a target by URI.
`final Unit`	`generate(URI inputs)`	Generate classes for a set of schema files specified by URI.
`final Unit`	`generate(File inputFiles)`	Generate classes for a set of schema files (specified as a `vararg` array).
`final Unit`	`generate(List<File> inputFiles)`	Generate classes for a set of files (specified as a List).
`final Unit`	`addTargets(List<File> inputFiles)`	Add targets for a set of files (specified as a List).
`final Unit`	`generateFromPaths(Path inputPaths)`	Generate classes for a set of schema files (specified as a `vararg` array of Path).
`final Unit`	`generateFromPaths(List<Path> inputPaths)`	Generate classes for a set of files (specified as a List of Path).
`final Unit`	`addTargetsByPath(List<Path> inputPaths)`	Add targets for a set of files (specified as a List of Path).
`final Unit`	`generateAllTargets()`	Generate all targets added to the target list.
`final Unit`	`generateClass(JSONSchema schema, String className, List<String> subDirectories, JSONValue json)`	Generate a single class.
`final Unit`	`generateClasses(List<Pair<JSONSchema, String>> schemaList, List<String> subDirectories, JSONValue json, Function1<String, String> logCommentFunction)`	Generate classes as specified by a list of pairs - Schema and class name.
`final Unit`	`generateAll(JSONValue base, JSONPointer pointer, List<String> subDirectories, URI uri, Function1<String, Boolean> filter)`	Generate classes for all definitions in a composite file (e.g.
`final Unit`	`addCompositeTargets(URI uri, JSONPointer pointer, Function1<String, Boolean> filter)`	Add targets for all definitions in a composite file (e.g.
`final Unit`	`addCompositeTargets(JSONValue base, JSONPointer pointer, List<String> subDirectories, URI uri, Function1<String, Boolean> filter)`	Add targets for all definitions in a composite file (e.g.
`final Unit`	`addCustomClassByURI(URI uri, String qualifiedClassName)`
`final Unit`	`addCustomClassByURI(URI uri, String className, String packageName)`
`final Unit`	`addCustomClassByURI(URI uri, ClassId classId)`
`final Unit`	`addCustomClassByFormat(String name, String qualifiedClassName)`
`final Unit`	`addCustomClassByFormat(String name, String className, String packageName)`
`final Unit`	`addCustomClassByFormat(String name, ClassId classId)`
`final Unit`	`addCustomClassByExtension(String extensionId, Object extensionValue, String qualifiedClassName)`
`final Unit`	`addCustomClassByExtension(String extensionId, Object extensionValue, String className, String packageName)`
`final Unit`	`addCustomClassByExtension(String extensionId, Object extensionValue, ClassId classId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CodeGenerator
```
CodeGenerator(TargetLanguage targetLanguage, String templateName, String enumTemplateName, String basePackageName, String baseDirectoryName, Boolean derivePackageFromStructure, String generatorComment, ClassId markerInterface, Logger log)
```
- Method Detail
  - getNestedClassNameOption
```
 final CodeGenerator.NestedClassNameOption getNestedClassNameOption()
```
  - setNestedClassNameOption
```
 final Unit setNestedClassNameOption(CodeGenerator.NestedClassNameOption nestedClassNameOption)
```
  - getCommentTemplate
```
 final Template getCommentTemplate()
```
  - setCommentTemplate
```
 final Unit setCommentTemplate(Template commentTemplate)
```
  - getSchemaParser
```
 final Parser getSchemaParser()
```
  - setSchemaParser
```
 final Unit setSchemaParser(Parser schemaParser)
```
  - getTemplateParser
```
 final Parser getTemplateParser()
```
  - setTemplateParser
```
 final Unit setTemplateParser(Parser templateParser)
```
  - getTemplate
```
 final Template getTemplate()
```
  - setTemplate
```
 final Unit setTemplate(Template template)
```
  - getInterfaceTemplateName
```
 final String getInterfaceTemplateName()
```
  - setInterfaceTemplateName
```
 final Unit setInterfaceTemplateName(String interfaceTemplateName)
```
  - getInterfaceTemplate
```
 final Template getInterfaceTemplate()
```
  - setInterfaceTemplate
```
 final Unit setInterfaceTemplate(Template interfaceTemplate)
```
  - getEnumTemplateField
```
 final Template getEnumTemplateField()
```
  - setEnumTemplateField
```
 final Unit setEnumTemplateField(Template enumTemplateField)
```
  - getEnumTemplate
```
 final Template getEnumTemplate()
```
  - setEnumTemplate
```
 final Unit setEnumTemplate(Template enumTemplate)
```
  - getIndexFileName
```
 final TargetFileName getIndexFileName()
```
  - setIndexFileName
```
 final Unit setIndexFileName(TargetFileName indexFileName)
```
  - getIndexTemplateName
```
 final String getIndexTemplateName()
```
  - setIndexTemplateName
```
 final Unit setIndexTemplateName(String indexTemplateName)
```
  - getIndexTemplateField
```
 final Template getIndexTemplateField()
```
  - setIndexTemplateField
```
 final Unit setIndexTemplateField(Template indexTemplateField)
```
  - getIndexTemplate
```
 final Template getIndexTemplate()
```
  - setIndexTemplate
```
 final Unit setIndexTemplate(Template indexTemplate)
```
  - getOutputResolverField
```
 final Function1<TargetFileName, Writer> getOutputResolverField()
```
  - setOutputResolverField
```
 final Unit setOutputResolverField(Function1<TargetFileName, Writer> outputResolverField)
```
  - getOutputResolver
```
 final Function1<TargetFileName, Writer> getOutputResolver()
```
  - setOutputResolver
```
 final Unit setOutputResolver(Function1<TargetFileName, Writer> outputResolver)
```
  - getNumTargets
```
 final Integer getNumTargets()
```
  - getTargetLanguage
```
 final TargetLanguage getTargetLanguage()
```
    Target language
  - setTargetLanguage
```
 final Unit setTargetLanguage(TargetLanguage targetLanguage)
```
    Target language
  - getTemplateName
```
 final String getTemplateName()
```
    The primary template to use for the generation of a class
  - setTemplateName
```
 final Unit setTemplateName(String templateName)
```
    The primary template to use for the generation of a class
  - getEnumTemplateName
```
 final String getEnumTemplateName()
```
    The primary template to use for the generation of an enum
  - setEnumTemplateName
```
 final Unit setEnumTemplateName(String enumTemplateName)
```
    The primary template to use for the generation of an enum
  - getBasePackageName
```
 final String getBasePackageName()
```
    The base package name for the generated classes
  - setBasePackageName
```
 final Unit setBasePackageName(String basePackageName)
```
    The base package name for the generated classes
  - getBaseDirectoryName
```
 final String getBaseDirectoryName()
```
    The base output directory for generated files
  - setBaseDirectoryName
```
 final Unit setBaseDirectoryName(String baseDirectoryName)
```
    The base output directory for generated files
  - getDerivePackageFromStructure
```
 final Boolean getDerivePackageFromStructure()
```
    A boolean flag to indicate the schema files in subdirectories are to be output to sub-packages
  - setDerivePackageFromStructure
```
 final Unit setDerivePackageFromStructure(Boolean derivePackageFromStructure)
```
    A boolean flag to indicate the schema files in subdirectories are to be output to sub-packages
  - getGeneratorComment
```
 final String getGeneratorComment()
```
    A comment to add to the header of generated files
  - setGeneratorComment
```
 final Unit setGeneratorComment(String generatorComment)
```
    A comment to add to the header of generated files
  - getMarkerInterface
```
 final ClassId getMarkerInterface()
```
    An optional marker interface to add to each generated class
  - setMarkerInterface
```
 final Unit setMarkerInterface(ClassId markerInterface)
```
    An optional marker interface to add to each generated class
  - getLog
```
 final Logger getLog()
```
    A Logger object for the output of logging messages
  - addClassNameMapping
```
 final Unit addClassNameMapping(URI uri, String name)
```
  - setTemplateDirectory
```
 final Unit setTemplateDirectory(File directory, String suffix)
```
  - configure
```
 final Unit configure(File file, URI uri)
```
    Configure the CodeGenerator using a config file, specified by a File.
    
    Parameters:
    
    file - a File pointing to the JSON or YAML config file
    
    uri - an optional URI (for error reporting)
  - configure
```
 final Unit configure(Path path, URI uri)
```
    Configure the CodeGenerator using a config file, specified by a Path.
    
    Parameters:
    
    path - the Path to the JSON or YAML config file
    
    uri - an optional URI (for error reporting)
  - configure
```
 final Unit configure(JSONValue json, URI uri)
```
    Configure the CodeGenerator using a config file (in the form af a parsed JSON object).
    
    Parameters:
    
    json - the JSON object
    
    uri - an optional URI (for error reporting)
  - clearTargets
```
 final Unit clearTargets()
```
    Clear the target list.
  - addTarget
```
 final Unit addTarget(JSONSchema schema, String className, List<String> subDirectories, String source, JSONValue json)
```
    Add a target using the supplied details.
    
    Parameters:
    
    schema - the JSON schema
    
    className - the class name to use for the generated class
    
    subDirectories - the subdirectory names to use for package name determination
    
    source - an optional source comment string
    
    json - original JSON (for template expansion)
  - addTarget
```
 final Unit addTarget(URI uri)
```
    Add a target by URI.
    
    Parameters:
    
    uri - the URI
  - generate
```
 final Unit generate(URI inputs)
```
    Generate classes for a set of schema files specified by URI.
  - generate
```
 final Unit generate(File inputFiles)
```
    Generate classes for a set of schema files (specified as a vararg array). Directories will be traversed recursively.
    
    Parameters:
    
    inputFiles - the files
  - generate
```
 final Unit generate(List<File> inputFiles)
```
    Generate classes for a set of files (specified as a List). Directories will be traversed recursively.
    
    Parameters:
    
    inputFiles - the list of files
  - addTargets
```
 final Unit addTargets(List<File> inputFiles)
```
    Add targets for a set of files (specified as a List). Directories will be traversed recursively.
    
    Parameters:
    
    inputFiles - the list of files
  - generateFromPaths
```
 final Unit generateFromPaths(Path inputPaths)
```
    Generate classes for a set of schema files (specified as a vararg array of Path). Directories will be traversed recursively.
    
    Parameters:
    
    inputPaths - the files
  - generateFromPaths
```
 final Unit generateFromPaths(List<Path> inputPaths)
```
    Generate classes for a set of files (specified as a List of Path). Directories will be traversed recursively.
    
    Parameters:
    
    inputPaths - the list of files
  - addTargetsByPath
```
 final Unit addTargetsByPath(List<Path> inputPaths)
```
    Add targets for a set of files (specified as a List of Path). Directories will be traversed recursively.
    
    Parameters:
    
    inputPaths - the list of files
  - generateAllTargets
```
 final Unit generateAllTargets()
```
    Generate all targets added to the target list.
  - generateClass
```
 final Unit generateClass(JSONSchema schema, String className, List<String> subDirectories, JSONValue json)
```
    Generate a single class.
    
    Parameters:
    
    schema - the JSONSchema
    
    className - the class name
    
    subDirectories - list of subdirectory names to use for the output file
    
    json - original JSON (for template expansion)
  - generateClasses
```
 final Unit generateClasses(List<Pair<JSONSchema, String>> schemaList, List<String> subDirectories, JSONValue json, Function1<String, String> logCommentFunction)
```
    Generate classes as specified by a list of pairs - Schema and class name.
    
    Parameters:
    
    schemaList - list of Pair of JSONSchema and String (class name)
    
    subDirectories - list of subdirectory names to use for the output files
    
    json - original JSON (for template expansion)
    
    logCommentFunction - optional function to create logging comment
  - generateAll
```
 final Unit generateAll(JSONValue base, JSONPointer pointer, List<String> subDirectories, URI uri, Function1<String, Boolean> filter)
```
    Generate classes for all definitions in a composite file (e.g. schema definitions embedded in an OpenAPI or Swagger document).
    
    Parameters:
    
    base - the base of the composite object
    
    pointer - pointer to the structure containing the schema definitions (e.g.
    
    subDirectories - list of subdirectory names to use for the output files
    
    uri - the default URI of the document
    
    filter - optional filter to select which classes to include (by name)
  - addCompositeTargets
```
 final Unit addCompositeTargets(URI uri, JSONPointer pointer, Function1<String, Boolean> filter)
```
    Add targets for all definitions in a composite file (e.g. schema definitions embedded in an OpenAPI or Swagger document) for a file located by URI.
    
    Parameters:
    
    uri - the URI of the document
    
    pointer - pointer to the structure containing the schema definitions (e.g.
    
    filter - optional filter to select which classes to include (by name)
  - addCompositeTargets
```
 final Unit addCompositeTargets(JSONValue base, JSONPointer pointer, List<String> subDirectories, URI uri, Function1<String, Boolean> filter)
```
    Add targets for all definitions in a composite file (e.g. schema definitions embedded in an OpenAPI or Swagger document).
    
    Parameters:
    
    base - the base of the composite object
    
    pointer - pointer to the structure containing the schema definitions (e.g.
    
    subDirectories - list of subdirectory names to use for the output files
    
    uri - the default URI of the document
    
    filter - optional filter to select which classes to include (by name)
  - addCustomClassByURI
```
 final Unit addCustomClassByURI(URI uri, String qualifiedClassName)
```
  - addCustomClassByURI
```
 final Unit addCustomClassByURI(URI uri, String className, String packageName)
```
  - addCustomClassByURI
```
 final Unit addCustomClassByURI(URI uri, ClassId classId)
```
  - addCustomClassByFormat
```
 final Unit addCustomClassByFormat(String name, String qualifiedClassName)
```
  - addCustomClassByFormat
```
 final Unit addCustomClassByFormat(String name, String className, String packageName)
```
  - addCustomClassByFormat
```
 final Unit addCustomClassByFormat(String name, ClassId classId)
```
  - addCustomClassByExtension
```
 final Unit addCustomClassByExtension(String extensionId, Object extensionValue, String qualifiedClassName)
```
  - addCustomClassByExtension
```
 final Unit addCustomClassByExtension(String extensionId, Object extensionValue, String className, String packageName)
```
  - addCustomClassByExtension
```
 final Unit addCustomClassByExtension(String extensionId, Object extensionValue, ClassId classId)
```

Class CodeGenerator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodeGenerator

Method Detail

getNestedClassNameOption

setNestedClassNameOption

getCommentTemplate

setCommentTemplate

getSchemaParser

setSchemaParser

getTemplateParser

setTemplateParser

getTemplate

setTemplate

getInterfaceTemplateName

setInterfaceTemplateName

getInterfaceTemplate

setInterfaceTemplate

getEnumTemplateField

setEnumTemplateField

getEnumTemplate

setEnumTemplate

getIndexFileName

setIndexFileName

getIndexTemplateName

setIndexTemplateName

getIndexTemplateField

setIndexTemplateField

getIndexTemplate

setIndexTemplate

getOutputResolverField

setOutputResolverField

getOutputResolver

setOutputResolver

getNumTargets

getTargetLanguage

setTargetLanguage

getTemplateName

setTemplateName

getEnumTemplateName

setEnumTemplateName

getBasePackageName

setBasePackageName

getBaseDirectoryName

setBaseDirectoryName

getDerivePackageFromStructure

setDerivePackageFromStructure

getGeneratorComment

setGeneratorComment

getMarkerInterface

setMarkerInterface

getLog

addClassNameMapping

setTemplateDirectory

configure

configure

configure

clearTargets

addTarget

addTarget

generate

generate

generate

addTargets

generateFromPaths

generateFromPaths

addTargetsByPath

generateAllTargets

generateClass

generateClasses

generateAll

addCompositeTargets

addCompositeTargets

addCustomClassByURI

addCustomClassByURI