public interface GenerationConfig
Devs: add to this interface if you need to introduce a new config property.
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.
|
String |
getCustomDatePattern()
Gets the 'customDatePattern' configuration option
|
String |
getCustomDateTimePattern()
Gets the 'customDateTimePattern' configuration option
|
Class<? extends RuleFactory> |
getCustomRuleFactory()
Gets the 'customRuleFactory' configuration option.
|
String |
getCustomTimePattern()
Gets the 'customTimePattern' configuration option
|
String |
getDateTimeType()
Gets the `dateTimeType` configuration option.
|
String |
getDateType()
Gets the `dateType` configuration option.
|
String[] |
getFileExtensions()
Gets the 'fileExtensions' configuration option.
|
FileFilter |
getFileFilter()
Gets the file filter used to isolate the schema mapping files in the
source directories.
|
Map<String,String> |
getFormatTypeMapping()
Gets the 'formatTypeMapping' configuration option.
|
InclusionLevel |
getInclusionLevel()
Gets the 'inclusionLevel' option for Jackson serializer.
|
String |
getOutputEncoding()
Gets the 'outputEncoding' configuration option.
|
char[] |
getPropertyWordDelimiters()
Gets the 'propertyWordDelimiters' configuration option.
|
String |
getRefFragmentPathDelimiters()
Gets the `refFragmentPathDelimiters` configuration option.
|
Iterator<URL> |
getSource()
Gets the 'source' configuration option.
|
SourceSortOrder |
getSourceSortOrder()
Gets the 'sourceSortOrder' 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()
Gets the `timeType` configuration option.
|
String[] |
getToStringExcludes()
Gets the 'toStringExcludes' configuration option.
|
boolean |
isConstructorsRequiredPropertiesOnly()
Gets the 'constructorsRequiredPropertiesOnly' configuration option.
|
boolean |
isFormatDates()
Gets the `formatDates` configuration option
|
boolean |
isFormatDateTimes()
Gets the `formatDateTime` configuration option
|
boolean |
isFormatTimes()
Gets the `formatTimes` configuration option
|
boolean |
isGenerateBuilders()
Gets the 'generateBuilders' configuration option.
|
boolean |
isIncludeAdditionalProperties()
Gets the 'includeAdditionalProperties' configuration option.
|
boolean |
isIncludeAllPropertiesConstructor()
Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option.
|
boolean |
isIncludeConstructorPropertiesAnnotation()
Gets the 'includeConstructorPropertiesAnnotation' configuration option.
|
boolean |
isIncludeConstructors()
Gets the 'includeConstructors' configuration option.
|
boolean |
isIncludeCopyConstructor()
Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option.
|
boolean |
isIncludeDynamicAccessors()
Gets the `includeDynamicAccessors` configuration option
|
boolean |
isIncludeDynamicBuilders()
Gets the `includeDynamicBuilders` configuration option.
|
boolean |
isIncludeDynamicGetters()
Gets the `includeDynamicGetters` configuration option.
|
boolean |
isIncludeDynamicSetters()
Gets the `includeDynamicSetters` configuration option.
|
boolean |
isIncludeGeneratedAnnotation()
Whether to mark generated classes with the annotation
javax.annotation.@Generated |
boolean |
isIncludeGetters()
Gets the 'includeGetters' configuration option.
|
boolean |
isIncludeHashcodeAndEquals()
Gets the 'includeHashcodeAndEquals' configuration option.
|
boolean |
isIncludeJsr303Annotations()
Gets the 'includeJsr303Annotations' configuration option.
|
boolean |
isIncludeJsr305Annotations()
Gets the 'includeJsr305Annotations' configuration option.
|
boolean |
isIncludeRequiredPropertiesConstructor()
Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option.
|
boolean |
isIncludeSetters()
Gets the 'includeSetters' configuration option.
|
boolean |
isIncludeToString()
Gets the 'includeToString' configuration option.
|
boolean |
isIncludeTypeInfo()
Gets the 'includeTypeInfo' configuration option.
|
boolean |
isInitializeCollections()
Gets the 'initializeCollections' configuration option.
|
boolean |
isParcelable()
Gets the 'parcelable' configuration option.
|
boolean |
isRemoveOldOutput()
Gets the 'removeOldOutput' configuration option.
|
boolean |
isSerializable()
Gets the 'serializable' configuration option.
|
boolean |
isUseBigDecimals()
Gets the 'useBigDecimals' configuration option.
|
boolean |
isUseBigIntegers()
Gets the 'useBigIntegers' configuration option.
|
boolean |
isUseDoubleNumbers()
Gets the 'useDoubleNumbers' configuration option.
|
default boolean |
isUseInnerClassBuilders()
If set to true, then the gang of four builder pattern will be used to generate builders on generated classes.
|
boolean |
isUseJakartaValidation()
Gets the 'useJakartaValidation' 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 |
isUseOptionalForGetters()
Gets the 'useOptionalForGetters' configuration option.
|
boolean |
isUsePrimitives()
Gets the 'usePrimitives' configuration option.
|
boolean |
isUseTitleAsClassname()
When
true the title is used as class name. |
boolean isGenerateBuilders()
withXxx(value)
(that return this
),
alongside the standard, void-return setters.boolean isIncludeTypeInfo()
boolean isIncludeConstructorPropertiesAnnotation()
boolean isUsePrimitives()
long
, double
, boolean
) instead of wrapper types where possible
when generating bean properties (has the side-effect of making
those properties non-null).Iterator<URL> getSource()
File getTargetDirectory()
String getTargetPackage()
char[] getPropertyWordDelimiters()
boolean isUseLongIntegers()
boolean isUseBigIntegers()
BigInteger
instead
of int
(or Integer
) when
representing the JSON Schema type 'integer'. Note that this
configuration overrides isUseLongIntegers()
.boolean isUseDoubleNumbers()
boolean isUseBigDecimals()
BigDecimal
instead
of float
(or Float
) when
representing the JSON Schema type 'number'. Note that this
configuration overrides isUseDoubleNumbers()
.boolean isIncludeHashcodeAndEquals()
hashCode
and
equals
methods in generated Java types.boolean isIncludeToString()
toString
method in
generated Java types.String[] getToStringExcludes()
AnnotationStyle getAnnotationStyle()
Supported values:
jackson
(alias for jackson2)
jackson2
(apply annotations from the
Jackson 2.x library)gson
(apply annotations from the
gson
library)moshi1
(apply annotations from the
moshi library)none
(apply no annotations at all)AnnotatorFactory
boolean isUseTitleAsClassname()
true
the title is used as class name.InclusionLevel getInclusionLevel()
Supported values
ALWAYS
NON_ABSENT
NON_DEFAULT
NON_EMPTY
NON_NULL
USE_DEFAULTS
InclusionLevel
Class<? extends Annotator> getCustomAnnotator()
getAnnotationStyle()
Class<? extends RuleFactory> getCustomRuleFactory()
boolean isIncludeJsr303Annotations()
boolean isIncludeJsr305Annotations()
boolean isUseOptionalForGetters()
Optional
as return type for
getters of non-required fields.SourceType getSourceType()
Supported values:
jsonschema
json
boolean isRemoveOldOutput()
String getOutputEncoding()
boolean isUseJodaDates()
DateTime
instead of
Date
when adding date type fields to generated
Java types.boolean isUseJodaLocalDates()
LocalDate
instead of string
when adding string type fields with a format of date (not
date-time) to generated Java types.boolean isUseJodaLocalTimes()
LocalTime
instead of string
when adding string type fields with a format of time (not
date-time) to generated Java types.boolean isParcelable()
boolean isSerializable()
FileFilter getFileFilter()
boolean isInitializeCollections()
String getClassNamePrefix()
String getClassNameSuffix()
String[] getFileExtensions()
boolean isIncludeConstructors()
boolean isConstructorsRequiredPropertiesOnly()
isIncludeAllPropertiesConstructor()
and off the isIncludeAllPropertiesConstructor()
configuration options.
It is specifically tied to the isIncludeConstructors()
property, and will do nothing if that property is not enabledboolean isIncludeRequiredPropertiesConstructor()
isIncludeConstructors()
configuration option and is incompatible with isConstructorsRequiredPropertiesOnly()
, and will have no effect
if isIncludeConstructors()
is not set to true. If isIncludeConstructors()
is set to true then this configuration determines
whether the resulting object should include a constructor with only the required properties as parameters.boolean isIncludeAllPropertiesConstructor()
isIncludeConstructors()
configuration option and is incompatible with isConstructorsRequiredPropertiesOnly()
, and will have no effect
if isIncludeConstructors()
is not set to true. If isIncludeConstructors()
is set to true then this configuration determines
whether the resulting object should include a constructor with all listed properties as parameters.boolean isIncludeCopyConstructor()
isIncludeConstructors()
configuration option and is incompatible with isConstructorsRequiredPropertiesOnly()
, and will have no effect
if isIncludeConstructors()
is not set to true. If isIncludeConstructors()
is set to true then this configuration determines
whether the resulting object should include a constructor the class itself as a parameter, with the expectation that all properties from the
originating class will assigned to the new class.boolean isIncludeAdditionalProperties()
boolean isIncludeGetters()
boolean isIncludeSetters()
String getTargetVersion()
boolean isIncludeDynamicAccessors()
boolean isIncludeDynamicGetters()
boolean isIncludeDynamicSetters()
boolean isIncludeDynamicBuilders()
String getDateTimeType()
Example values:
org.joda.time.LocalDateTime
(Joda)java.time.LocalDateTime
(JSR310)null
(default behavior)Date
when
adding date type fields to generate Java types.String getDateType()
Example values:
org.joda.time.LocalDate
(Joda)java.time.LocalDate
(JSR310)null
(default behavior)String getTimeType()
Example values:
org.joda.time.LocalTime
(Joda)java.time.LocalTime
(JSR310)null
(default behavior)boolean isFormatDates()
date
have the
@JsonFormat
annotation with pattern set to the
default value of yyyy-MM-dd
boolean isFormatTimes()
time
have the
@JsonFormat
annotation with pattern set to the
default value of HH:mm:ss.SSS
boolean isFormatDateTimes()
date-type
have the
@JsonFormat
annotation with pattern set to the
default value of yyyy-MM-dd'T'HH:mm:ss.SSSZ
String getCustomDatePattern()
String getCustomTimePattern()
String getCustomDateTimePattern()
String getRefFragmentPathDelimiters()
SourceSortOrder getSourceSortOrder()
Supported values:
OS
(Let the OS influence the order the source files are processed.)FILES_FIRST
(Case sensitive sort, visit the files first. The source files are processed in a breadth
first sort order.)SUBDIRS_FIRST
(Case sensitive sort, visit the sub-directories before the files. The source files are
processed in a depth first sort order.)Map<String,String> getFormatTypeMapping()
default boolean isUseInnerClassBuilders()
isGenerateBuilders()
method. If the isGenerateBuilders()
is false,
then this property will not do anything.boolean isIncludeGeneratedAnnotation()
javax.annotation.@Generated
boolean isUseJakartaValidation()
isIncludeJsr303Annotations()
configuration option.
If the isIncludeJsr303Annotations()
returns false
, then this configuration option will not affect anything.jakarta.validation
package instead of javax.validation
package when adding JSR-303 annotations to generated Java typesCopyright © 2022. All rights reserved.