org.jsonschema2pojo

Interface GenerationConfig

All Known Implementing Classes:

Arguments, DefaultGenerationConfig, Jsonschema2PojoMojo, Jsonschema2PojoTask

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

Modifier and Type	Method and Description
AnnotationStyle	getAnnotationStyle() Gets the 'annotationStyle' configuration option.
String	getClassNamePrefix() Gets the 'getClassNamePrefix' configuration option.
String	getClassNameSuffix() Gets the 'getClassNameSuffix' configuration option.
Class<? extends Annotator>	getCustomAnnotator() Gets the 'customAnnotator' configuration option.
Class<? extends RuleFactory>	getCustomRuleFactory() Gets the 'customRuleFactory' configuration option.
String	getDateTimeType() Allow to specifiy a class for date-time jsonschema type.
String	getDateType() Allow to specifiy a class for date-time jsonschema type.
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<URL>	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.
String	getTargetVersion() Gets the 'targetVersion' configuration option
String	getTimeType() Allow to specifiy a class for date-time jsonschema type.
boolean	isConstructorsRequiredPropertiesOnly() Gets the 'constructorsRequiredPropertiesOnly' configuration option
boolean	isGenerateBuilders() Gets the 'generateBuilders' configuration option.
boolean	isIncludeAccessors() Gets the 'includeAccessors' configuration option
boolean	isIncludeAdditionalProperties() Gets the 'includeAdditionalProperties' configuration option
boolean	isIncludeConstructors() Gets the 'includeConstructors' configuration option
boolean	isIncludeDynamicAccessors() Gets the `includeDynamicAccessors` configuraiton 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	isParcelable() Gets the 'parcelable' 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	isUseJodaLocalDates() Gets the 'useJodaLocalDates' configuration option.
boolean	isUseJodaLocalTimes() Gets the 'useJodaLocalTimes' 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<URL> 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.

isUseJodaLocalDates

boolean isUseJodaLocalDates()

Gets the 'useJodaLocalDates' configuration option.

Returns:

Whether to use LocalDate instead of string when adding string type fields with a format of date (not date-time) to generated Java types.

isUseJodaLocalTimes

boolean isUseJodaLocalTimes()

Gets the 'useJodaLocalTimes' configuration option.

Returns:

Whether to use LocalTime instead of string when adding string type fields with a format of time (not date-time) 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.

isParcelable

boolean isParcelable()

Gets the 'parcelable' configuration option.

Returns:

Whether to make the generated types 'parcelable' (for Android development)

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.

getClassNamePrefix

String getClassNamePrefix()

Gets the 'getClassNamePrefix' configuration option.

Returns:

Whether to initialize collections with empty instance or null.

getClassNameSuffix

String getClassNameSuffix()

Gets the 'getClassNameSuffix' configuration option.

Returns:

Whether to initialize collections with empty instance or null.

isIncludeConstructors

boolean isIncludeConstructors()

Gets the 'includeConstructors' configuration option

Returns:

Whether to generate constructors or not.

isConstructorsRequiredPropertiesOnly

boolean isConstructorsRequiredPropertiesOnly()

Gets the 'constructorsRequiredPropertiesOnly' configuration option

Returns:

Whether generated constructors should have parameters for all properties, or only required ones.

isIncludeAdditionalProperties

boolean isIncludeAdditionalProperties()

Gets the 'includeAdditionalProperties' configuration option

Returns:

Whether to allow 'additional properties' support in objects. Setting this to false will disable additional properties support, regardless of the input schema(s).

isIncludeAccessors

boolean isIncludeAccessors()

Gets the 'includeAccessors' configuration option

Returns:

Whether to include getters/setters or to omit these accessor methods and create public fields instead.

getTargetVersion

String getTargetVersion()

Gets the 'targetVersion' configuration option

Returns:

The target version for generated source files.

isIncludeDynamicAccessors

boolean isIncludeDynamicAccessors()

Gets the `includeDynamicAccessors` configuraiton option

Returns:

Whether to include dynamic getters, setters, and builders or to omit these methods.

getDateTimeType

String getDateTimeType()

Allow to specifiy a class for date-time jsonschema type. Could be JSR310, Joda, ... [org.joda.time.LocalDateTime,java.time.LocalDateTime, ...] java.time.* require JVM8 or greater

Returns:

getDateType

String getDateType()

Allow to specifiy a class for date-time jsonschema type. Could be JSR310, Joda, ... [org.joda.time.LocalDate,java.time.LocalDate, ...] java.time.* require JVM8 or greater

Returns:

getTimeType

String getTimeType()

Allow to specifiy a class for date-time jsonschema type. Could be JSR310, Joda, ... [org.joda.time.LocalTime,java.time.LocalTime, ...] java.time.* require JVM8 or greater

Returns: