org.jsonschema2pojo

Interface GenerationConfig

All Known Implementing Classes:

DefaultGenerationConfig

public interface GenerationConfig

Defines the configuration options for Java type generation, including source and target paths/packages and all behavioural options (e.g should builders be generated, should primitives be used, etc).

Devs: add to this interface if you need to introduce a new config property.

Method Summary

Methods

Modifier and Type	Method and Description
AnnotationStyle	getAnnotationStyle() Gets the 'annotationStyle' configuration option.
Class<? extends Annotator>	getCustomAnnotator() Gets the 'customAnnotator' configuration option.
Class<? extends RuleFactory>	getCustomRuleFactory() Gets the 'customRuleFactory' configuration option.
FileFilter	getFileFilter() Gets the file filter used to isolate the schema mapping files in the source directories.
String	getOutputEncoding() Gets the 'outputEncoding' configuration option.
char[]	getPropertyWordDelimiters() Gets the 'propertyWordDelimiters' configuration option.
Iterator<File>	getSource() Gets the 'source' configuration option.
SourceType	getSourceType() Gets the 'sourceType' configuration option.
File	getTargetDirectory() Gets the 'targetDirectory' configuration option.
String	getTargetPackage() Gets the 'targetPackage' configuration option.
boolean	isGenerateBuilders() Gets the 'generateBuilders' configuration option.
boolean	isIncludeHashcodeAndEquals() Gets the 'includeHashcodeAndEquals' configuration option.
boolean	isIncludeJsr303Annotations() Gets the 'includeJsr303Annotations' configuration option.
boolean	isIncludeToString() Gets the 'includeToString' configuration option.
boolean	isInitializeCollections() Gets the 'initializeCollections' configuration option.
boolean	isRemoveOldOutput() Gets the 'removeOldOutput' configuration option.
boolean	isUseCommonsLang3() Gets the 'useCommonsLang3' configuration option.
boolean	isUseDoubleNumbers() Gets the 'useDoubleNumbers' configuration option.
boolean	isUseJodaDates() Gets the 'useJodaDates' configuration option.
boolean	isUseLongIntegers() Gets the 'useLongIntegers' configuration option.
boolean	isUsePrimitives() Gets the 'usePrimitives' configuration option.

Method Detail

isGenerateBuilders

boolean isGenerateBuilders()

Gets the 'generateBuilders' configuration option.

Returns:

Whether to generate builder-style methods of the form withXxx(value) (that return this), alongside the standard, void-return setters.

isUsePrimitives

boolean isUsePrimitives()

Gets the 'usePrimitives' configuration option.

Returns:

whether to use primitives (long, double , boolean) instead of wrapper types where possible when generating bean properties (has the side-effect of making those properties non-null).

getSource

Iterator<File> getSource()

Gets the 'source' configuration option.

Returns:

The source file(s) or directory(ies) from which JSON Schema will be read.

getTargetDirectory

File getTargetDirectory()

Gets the 'targetDirectory' configuration option.

Returns:

The target directory into which generated types will be written (may or may not exist before types are written)

getTargetPackage

String getTargetPackage()

Gets the 'targetPackage' configuration option.

Returns:

The java package used for generated types.

getPropertyWordDelimiters

char[] getPropertyWordDelimiters()

Gets the 'propertyWordDelimiters' configuration option.

Returns:

an array of characters that should act as word delimiters when choosing java bean property names.

isUseLongIntegers

boolean isUseLongIntegers()

Gets the 'useLongIntegers' configuration option.

Returns:

Whether to use the java type long (or Long) instead of int (or Integer) when representing the JSON Schema type 'integer'.

isUseDoubleNumbers

boolean isUseDoubleNumbers()

Gets the 'useDoubleNumbers' configuration option.

Returns:

Whether to use the java type double (or Double) instead of float (or Float) when representing the JSON Schema type 'number'.

isIncludeHashcodeAndEquals

boolean isIncludeHashcodeAndEquals()

Gets the 'includeHashcodeAndEquals' configuration option.

Returns:

Whether to use include hashCode and equals methods in generated Java types.

isIncludeToString

boolean isIncludeToString()

Gets the 'includeToString' configuration option.

Returns:

Whether to use include a toString method in generated Java types.

getAnnotationStyle

AnnotationStyle getAnnotationStyle()

Gets the 'annotationStyle' configuration option.

Returns:

The style of annotations to use in the generated Java types.

Supported values:

• jackson1 (apply annotations from the Jackson 1.x library)
• jackson2 (apply annotations from the Jackson 2.x library)
• gson (apply annotations from the gson library)
• none (apply no annotations at all)

See Also:

AnnotatorFactory

getCustomAnnotator

Class<? extends Annotator> getCustomAnnotator()

Gets the 'customAnnotator' configuration option.

Returns:

An annotator that will be used in addition to the one chosen by getAnnotationStyle()

getCustomRuleFactory

Class<? extends RuleFactory> getCustomRuleFactory()

Gets the 'customRuleFactory' configuration option.

Returns:

An Rule Factory that will be used for the creation of generation rules.

isIncludeJsr303Annotations

boolean isIncludeJsr303Annotations()

Gets the 'includeJsr303Annotations' configuration option.

Returns:

Whether to include JSR-303 annotations (for schema rules like minimum, maximum, etc) in generated Java types.

getSourceType

SourceType getSourceType()

Gets the 'sourceType' configuration option.

Returns:

The type of input documents that will be read

Supported values:

• jsonschema
• json

isRemoveOldOutput

boolean isRemoveOldOutput()

Gets the 'removeOldOutput' configuration option.

Returns:

Whether to empty the target directory before generation occurs, to clear out all source files that have been generated previously. Be warned, when activated this option will cause jsonschema2pojo to indiscriminately delete the entire contents of the target directory (all files and folders) before it begins generating sources.

getOutputEncoding

String getOutputEncoding()

Gets the 'outputEncoding' configuration option.

Returns:

The character encoding that should be used when writing the generated Java source files.

isUseJodaDates

boolean isUseJodaDates()

Gets the 'useJodaDates' configuration option.

Returns:

Whether to use DateTime instead of Date when adding date type fields to generated Java types.

isUseCommonsLang3

boolean isUseCommonsLang3()

Gets the 'useCommonsLang3' configuration option.

Returns:

Whether to use commons-lang 3.x imports instead of commons-lang 2.x imports when adding equals, hashCode and toString methods.

getFileFilter

FileFilter getFileFilter()

Gets the file filter used to isolate the schema mapping files in the source directories.

Returns:

the file filter use when scanning for schema files.

isInitializeCollections

boolean isInitializeCollections()

Gets the 'initializeCollections' configuration option.

Returns:

Whether to initialize collections with empty instance or null.