Jsonschema2PojoMojo (jsonschema2pojo 1.1.2 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.jsonschema2pojo.maven.Jsonschema2PojoMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, GenerationConfig
```
public class Jsonschema2PojoMojo
extends org.apache.maven.plugin.AbstractMojo
implements GenerationConfig
```
When invoked, this goal reads one or more JSON Schema documents and generates DTO style Java classes for data binding.

See Also:

Mojo API Specification

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor and Description

Jsonschema2PojoMojo()

Constructors
Constructor and Description
`Jsonschema2PojoMojo()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`execute()` Executes the plugin, to read the given source and behavioural properties and generate POJOs.
`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`	`isUseCommonsLang3()` Deprecated.
`boolean`	`isUseDoubleNumbers()` Gets the 'useDoubleNumbers' configuration option.
`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.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

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

- Constructor Detail
  - Jsonschema2PojoMojo
```
public Jsonschema2PojoMojo()
```
- Method Detail
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
```
    Executes the plugin, to read the given source and behavioural properties and generate POJOs. The current implementation acts as a wrapper around the command line interface.
    
    Specified by:
    
    execute in interface org.apache.maven.plugin.Mojo
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - isGenerateBuilders
```
public boolean isGenerateBuilders()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'generateBuilders' configuration option.
    
    Specified by:
    
    isGenerateBuilders in interface GenerationConfig
    
    Returns:
    
    Whether to generate builder-style methods of the form withXxx(value) (that return this), alongside the standard, void-return setters.
  - isIncludeTypeInfo
```
public boolean isIncludeTypeInfo()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeTypeInfo' configuration option.
    
    Specified by:
    
    isIncludeTypeInfo in interface GenerationConfig
    
    Returns:
    
    whether to include json type information. Commonly used to support polymorphic type deserialization.
    
    See Also:
    
    https://github.com/FasterXML/jackson-docs/wiki/JacksonPolymorphicDeserialization
  - isIncludeConstructorPropertiesAnnotation
```
public boolean isIncludeConstructorPropertiesAnnotation()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeConstructorPropertiesAnnotation' configuration option.
    
    Specified by:
    
    isIncludeConstructorPropertiesAnnotation in interface GenerationConfig
    
    Returns:
    
    whether to include JDK Constructor Properties. Used by serialization libraries to get parameter names of constructors at runtime. (Not Available on Android)
    
    See Also:
    
    https://docs.oracle.com/javase/7/docs/api/java/beans/ConstructorProperties.html
  - getTargetDirectory
```
public File getTargetDirectory()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'targetDirectory' configuration option.
    
    Specified by:
    
    getTargetDirectory in interface GenerationConfig
    
    Returns:
    
    The target directory into which generated types will be written (may or may not exist before types are written)
  - getSource
```
public Iterator<URL> getSource()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'source' configuration option.
    
    Specified by:
    
    getSource in interface GenerationConfig
    
    Returns:
    
    The source file(s) or directory(ies) from which JSON Schema will be read.
  - isUsePrimitives
```
public boolean isUsePrimitives()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'usePrimitives' configuration option.
    
    Specified by:
    
    isUsePrimitives in interface GenerationConfig
    
    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).
  - getTargetPackage
```
public String getTargetPackage()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'targetPackage' configuration option.
    
    Specified by:
    
    getTargetPackage in interface GenerationConfig
    
    Returns:
    
    The java package used for generated types.
  - getPropertyWordDelimiters
```
public char[] getPropertyWordDelimiters()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'propertyWordDelimiters' configuration option.
    
    Specified by:
    
    getPropertyWordDelimiters in interface GenerationConfig
    
    Returns:
    
    an array of characters that should act as word delimiters when choosing java bean property names.
  - isUseLongIntegers
```
public boolean isUseLongIntegers()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useLongIntegers' configuration option.
    
    Specified by:
    
    isUseLongIntegers in interface GenerationConfig
    
    Returns:
    
    Whether to use the java type long (or Long) instead of int (or Integer) when representing the JSON Schema type 'integer'.
  - isUseDoubleNumbers
```
public boolean isUseDoubleNumbers()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useDoubleNumbers' configuration option.
    
    Specified by:
    
    isUseDoubleNumbers in interface GenerationConfig
    
    Returns:
    
    Whether to use the java type double (or Double) instead of float (or Float) when representing the JSON Schema type 'number'.
  - isIncludeHashcodeAndEquals
```
public boolean isIncludeHashcodeAndEquals()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeHashcodeAndEquals' configuration option.
    
    Specified by:
    
    isIncludeHashcodeAndEquals in interface GenerationConfig
    
    Returns:
    
    Whether to use include hashCode and equals methods in generated Java types.
  - isIncludeToString
```
public boolean isIncludeToString()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeToString' configuration option.
    
    Specified by:
    
    isIncludeToString in interface GenerationConfig
    
    Returns:
    
    Whether to use include a toString method in generated Java types.
  - getToStringExcludes
```
public String[] getToStringExcludes()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'toStringExcludes' configuration option.
    
    Specified by:
    
    getToStringExcludes in interface GenerationConfig
    
    Returns:
    
    An array of strings representing fields that should be excluded from toString methods
  - getAnnotationStyle
```
public AnnotationStyle getAnnotationStyle()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'annotationStyle' configuration option.
    Specified by:
    
    getAnnotationStyle in interface GenerationConfig
    
    Returns:
    The style of annotations to use in the generated Java types.
    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)
    See Also:
    
    AnnotatorFactory
  - isUseTitleAsClassname
```
public boolean isUseTitleAsClassname()
```
    Description copied from interface: GenerationConfig
    
    When true the title is used as class name.
    
    Specified by:
    
    isUseTitleAsClassname in interface GenerationConfig
  - getInclusionLevel
```
public InclusionLevel getInclusionLevel()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'inclusionLevel' option for Jackson serializer.
    Specified by:
    
    getInclusionLevel in interface GenerationConfig
    
    Returns:
    Level of inclusion to set in the generated Java types.
    Supported values
    
    ALWAYS
    
    NON_ABSENT
    
    NON_DEFAULT
    
    NON_EMPTY
    
    NON_NULL
    
    USE_DEFAULTS
    See Also:
    
    InclusionLevel
  - getCustomAnnotator
```
public Class<? extends Annotator> getCustomAnnotator()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'customAnnotator' configuration option.
    
    Specified by:
    
    getCustomAnnotator in interface GenerationConfig
    
    Returns:
    
    An annotator that will be used in addition to the one chosen by GenerationConfig.getAnnotationStyle()
  - getCustomRuleFactory
```
public Class<? extends RuleFactory> getCustomRuleFactory()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'customRuleFactory' configuration option.
    
    Specified by:
    
    getCustomRuleFactory in interface GenerationConfig
    
    Returns:
    
    An Rule Factory that will be used for the creation of generation rules.
  - isIncludeJsr303Annotations
```
public boolean isIncludeJsr303Annotations()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeJsr303Annotations' configuration option.
    
    Specified by:
    
    isIncludeJsr303Annotations in interface GenerationConfig
    
    Returns:
    
    Whether to include JSR-303 annotations (for schema rules like minimum, maximum, etc) in generated Java types.
  - isIncludeJsr305Annotations
```
public boolean isIncludeJsr305Annotations()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeJsr305Annotations' configuration option.
    
    Specified by:
    
    isIncludeJsr305Annotations in interface GenerationConfig
    
    Returns:
    
    Whether to include JSR-305 annotations (for schema rules like Nullable, NonNull, etc) in generated Java types.
  - isUseOptionalForGetters
```
public boolean isUseOptionalForGetters()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useOptionalForGetters' configuration option.
    
    Specified by:
    
    isUseOptionalForGetters in interface GenerationConfig
    
    Returns:
    
    Whether to use Optional as return type for getters of non-required fields.
  - getSourceType
```
public SourceType getSourceType()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'sourceType' configuration option.
    Specified by:
    
    getSourceType in interface GenerationConfig
    
    Returns:
    The type of input documents that will be read
    Supported values:
    
    jsonschema
    
    json
  - isRemoveOldOutput
```
public boolean isRemoveOldOutput()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'removeOldOutput' configuration option.
    
    Specified by:
    
    isRemoveOldOutput in interface GenerationConfig
    
    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
```
public String getOutputEncoding()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'outputEncoding' configuration option.
    
    Specified by:
    
    getOutputEncoding in interface GenerationConfig
    
    Returns:
    
    The character encoding that should be used when writing the generated Java source files.
  - isUseJodaDates
```
public boolean isUseJodaDates()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useJodaDates' configuration option.
    
    Specified by:
    
    isUseJodaDates in interface GenerationConfig
    
    Returns:
    
    Whether to use DateTime instead of Date when adding date type fields to generated Java types.
  - isUseJodaLocalDates
```
public boolean isUseJodaLocalDates()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useJodaLocalDates' configuration option.
    
    Specified by:
    
    isUseJodaLocalDates in interface GenerationConfig
    
    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
```
public boolean isUseJodaLocalTimes()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useJodaLocalTimes' configuration option.
    
    Specified by:
    
    isUseJodaLocalTimes in interface GenerationConfig
    
    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
```
@Deprecated
public boolean isUseCommonsLang3()
```
    Deprecated.
  - isParcelable
```
public boolean isParcelable()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'parcelable' configuration option.
    
    Specified by:
    
    isParcelable in interface GenerationConfig
    
    Returns:
    
    Whether to make the generated types 'parcelable' (for Android development)
  - isSerializable
```
public boolean isSerializable()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'serializable' configuration option.
    
    Specified by:
    
    isSerializable in interface GenerationConfig
    
    Returns:
    
    Whether to make the generated types 'serializable'
  - getFileFilter
```
public FileFilter getFileFilter()
```
    Description copied from interface: GenerationConfig
    
    Gets the file filter used to isolate the schema mapping files in the source directories.
    
    Specified by:
    
    getFileFilter in interface GenerationConfig
    
    Returns:
    
    the file filter use when scanning for schema files.
  - isInitializeCollections
```
public boolean isInitializeCollections()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'initializeCollections' configuration option.
    
    Specified by:
    
    isInitializeCollections in interface GenerationConfig
    
    Returns:
    
    Whether to initialize collections with empty instance or null.
  - getClassNamePrefix
```
public String getClassNamePrefix()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'getClassNamePrefix' configuration option.
    
    Specified by:
    
    getClassNamePrefix in interface GenerationConfig
    
    Returns:
    
    Whether to add a prefix to generated classes.
  - getClassNameSuffix
```
public String getClassNameSuffix()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'getClassNameSuffix' configuration option.
    
    Specified by:
    
    getClassNameSuffix in interface GenerationConfig
    
    Returns:
    
    Whether to add a suffix to generated classes.
  - getFileExtensions
```
public String[] getFileExtensions()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'fileExtensions' configuration option.
    
    Specified by:
    
    getFileExtensions in interface GenerationConfig
    
    Returns:
    
    An array of strings that should be considered as file extensions and therefore not included in class names.
  - isIncludeConstructors
```
public boolean isIncludeConstructors()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeConstructors' configuration option.
    
    Specified by:
    
    isIncludeConstructors in interface GenerationConfig
    
    Returns:
    
    Whether to generate constructors or not.
  - isConstructorsRequiredPropertiesOnly
```
public boolean isConstructorsRequiredPropertiesOnly()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'constructorsRequiredPropertiesOnly' configuration option. This is a legacy configuration option used to turn on the GenerationConfig.isIncludeAllPropertiesConstructor() and off the GenerationConfig.isIncludeAllPropertiesConstructor() configuration options. It is specifically tied to the GenerationConfig.isIncludeConstructors() property, and will do nothing if that property is not enabled
    
    Specified by:
    
    isConstructorsRequiredPropertiesOnly in interface GenerationConfig
  - isIncludeRequiredPropertiesConstructor
```
public boolean isIncludeRequiredPropertiesConstructor()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option. This property works in collaboration with the GenerationConfig.isIncludeConstructors() configuration option and is incompatible with GenerationConfig.isConstructorsRequiredPropertiesOnly(), and will have no effect if GenerationConfig.isIncludeConstructors() is not set to true. If GenerationConfig.isIncludeConstructors() is set to true then this configuration determines whether the resulting object should include a constructor with only the required properties as parameters.
    
    Specified by:
    
    isIncludeRequiredPropertiesConstructor in interface GenerationConfig
  - isIncludeAllPropertiesConstructor
```
public boolean isIncludeAllPropertiesConstructor()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option. This property works in collaboration with the GenerationConfig.isIncludeConstructors() configuration option and is incompatible with GenerationConfig.isConstructorsRequiredPropertiesOnly(), and will have no effect if GenerationConfig.isIncludeConstructors() is not set to true. If GenerationConfig.isIncludeConstructors() is set to true then this configuration determines whether the resulting object should include a constructor with all listed properties as parameters.
    
    Specified by:
    
    isIncludeAllPropertiesConstructor in interface GenerationConfig
  - isIncludeCopyConstructor
```
public boolean isIncludeCopyConstructor()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'constructorsIncludeRequiredPropertiesConstructor' configuration option. This property works in collaboration with the GenerationConfig.isIncludeConstructors() configuration option and is incompatible with GenerationConfig.isConstructorsRequiredPropertiesOnly(), and will have no effect if GenerationConfig.isIncludeConstructors() is not set to true. If GenerationConfig.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.
    
    Specified by:
    
    isIncludeCopyConstructor in interface GenerationConfig
  - isIncludeAdditionalProperties
```
public boolean isIncludeAdditionalProperties()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeAdditionalProperties' configuration option.
    
    Specified by:
    
    isIncludeAdditionalProperties in interface GenerationConfig
    
    Returns:
    
    Whether to allow 'additional properties' support in objects. Setting this to false will disable additional properties support, regardless of the input schema(s).
  - isIncludeGetters
```
public boolean isIncludeGetters()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeGetters' configuration option.
    
    Specified by:
    
    isIncludeGetters in interface GenerationConfig
    
    Returns:
    
    Whether to include getters or to omit these accessor methods and create public fields instead.
  - isIncludeSetters
```
public boolean isIncludeSetters()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'includeSetters' configuration option.
    
    Specified by:
    
    isIncludeSetters in interface GenerationConfig
    
    Returns:
    
    Whether to include setters or to omit these accessor methods and create public fields instead.
  - getTargetVersion
```
public String getTargetVersion()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'targetVersion' configuration option.
    
    Specified by:
    
    getTargetVersion in interface GenerationConfig
    
    Returns:
    
    The target version for generated source files.
  - isIncludeDynamicAccessors
```
public boolean isIncludeDynamicAccessors()
```
    Description copied from interface: GenerationConfig
    
    Gets the `includeDynamicAccessors` configuration option
    
    Specified by:
    
    isIncludeDynamicAccessors in interface GenerationConfig
    
    Returns:
    
    Whether to include dynamic getters, setters, and builders or to omit these methods.
  - isIncludeDynamicGetters
```
public boolean isIncludeDynamicGetters()
```
    Description copied from interface: GenerationConfig
    
    Gets the `includeDynamicGetters` configuration option.
    
    Specified by:
    
    isIncludeDynamicGetters in interface GenerationConfig
    
    Returns:
    
    Whether to include dynamic getters or to omit these methods
  - isIncludeDynamicSetters
```
public boolean isIncludeDynamicSetters()
```
    Description copied from interface: GenerationConfig
    
    Gets the `includeDynamicSetters` configuration option.
    
    Specified by:
    
    isIncludeDynamicSetters in interface GenerationConfig
    
    Returns:
    
    Whether to include dynamic setters or to omit these methods
  - isIncludeDynamicBuilders
```
public boolean isIncludeDynamicBuilders()
```
    Description copied from interface: GenerationConfig
    
    Gets the `includeDynamicBuilders` configuration option.
    
    Specified by:
    
    isIncludeDynamicBuilders in interface GenerationConfig
    
    Returns:
    
    Whether to include dynamic builders or to omit these methods
  - getDateTimeType
```
public String getDateTimeType()
```
    Description copied from interface: GenerationConfig
    Gets the `dateTimeType` configuration option.
    Example values:
    - org.joda.time.LocalDateTime (Joda)
    - java.time.LocalDateTime (JSR310)
    - null (default behavior)
    Specified by:
    
    getDateTimeType in interface GenerationConfig
    
    Returns:
    
    The java type to use instead of Date when adding date type fields to generate Java types.
  - getDateType
```
public String getDateType()
```
    Description copied from interface: GenerationConfig
    Gets the `dateType` configuration option.
    Example values:
    - org.joda.time.LocalDate (Joda)
    - java.time.LocalDate (JSR310)
    - null (default behavior)
    Specified by:
    
    getDateType in interface GenerationConfig
    
    Returns:
    
    The java type to use instead of string when adding string type fields with a format of date (not date-time) to generated Java types.
  - getTimeType
```
public String getTimeType()
```
    Description copied from interface: GenerationConfig
    Gets the `timeType` configuration option.
    Example values:
    - org.joda.time.LocalTime (Joda)
    - java.time.LocalTime (JSR310)
    - null (default behavior)
    Specified by:
    
    getTimeType in interface GenerationConfig
    
    Returns:
    
    The java type to use instead of string when adding string type fields with a format of time (not date-time) to generated Java types.
  - isUseBigIntegers
```
public boolean isUseBigIntegers()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useBigIntegers' configuration option.
    
    Specified by:
    
    isUseBigIntegers in interface GenerationConfig
    
    Returns:
    
    Whether to use the java type BigInteger instead of int (or Integer) when representing the JSON Schema type 'integer'. Note that this configuration overrides GenerationConfig.isUseLongIntegers().
  - isUseBigDecimals
```
public boolean isUseBigDecimals()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useBigDecimals' configuration option.
    
    Specified by:
    
    isUseBigDecimals in interface GenerationConfig
    
    Returns:
    
    Whether to use the java type BigDecimal instead of float (or Float) when representing the JSON Schema type 'number'. Note that this configuration overrides GenerationConfig.isUseDoubleNumbers().
  - isFormatDateTimes
```
public boolean isFormatDateTimes()
```
    Description copied from interface: GenerationConfig
    
    Gets the `formatDateTime` configuration option
    
    Specified by:
    
    isFormatDateTimes in interface GenerationConfig
    
    Returns:
    
    Whether the fields of type date-type have the @JsonFormat annotation with pattern set to the default value of yyyy-MM-dd'T'HH:mm:ss.SSSZ
  - isFormatDates
```
public boolean isFormatDates()
```
    Description copied from interface: GenerationConfig
    
    Gets the `formatDates` configuration option
    
    Specified by:
    
    isFormatDates in interface GenerationConfig
    
    Returns:
    
    Whether the fields of type date have the @JsonFormat annotation with pattern set to the default value of yyyy-MM-dd
  - isFormatTimes
```
public boolean isFormatTimes()
```
    Description copied from interface: GenerationConfig
    
    Gets the `formatTimes` configuration option
    
    Specified by:
    
    isFormatTimes in interface GenerationConfig
    
    Returns:
    
    Whether the fields of type time have the @JsonFormat annotation with pattern set to the default value of HH:mm:ss.SSS
  - getCustomDatePattern
```
public String getCustomDatePattern()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'customDatePattern' configuration option
    
    Specified by:
    
    getCustomDatePattern in interface GenerationConfig
    
    Returns:
    
    The custom format that dates will use when types are serialized. Requires support from your JSON binding library.
  - getCustomTimePattern
```
public String getCustomTimePattern()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'customTimePattern' configuration option
    
    Specified by:
    
    getCustomTimePattern in interface GenerationConfig
    
    Returns:
    
    The custom format that times will use when types are serialized. Requires support from your JSON binding library.
  - getCustomDateTimePattern
```
public String getCustomDateTimePattern()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'customDateTimePattern' configuration option
    
    Specified by:
    
    getCustomDateTimePattern in interface GenerationConfig
    
    Returns:
    
    The custom format that dates will use when types are serialized. Requires support from your JSON binding library.
  - getRefFragmentPathDelimiters
```
public String getRefFragmentPathDelimiters()
```
    Description copied from interface: GenerationConfig
    
    Gets the `refFragmentPathDelimiters` configuration option.
    
    Specified by:
    
    getRefFragmentPathDelimiters in interface GenerationConfig
    
    Returns:
    
    A string containing any characters that should act as path delimiters when resolving $ref fragments. By default, #, / and . are used in an attempt to support JSON Pointer and JSON Path.
  - getSourceSortOrder
```
public SourceSortOrder getSourceSortOrder()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'sourceSortOrder' configuration option.
    Specified by:
    
    getSourceSortOrder in interface GenerationConfig
    
    Returns:
    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.)
  - getFormatTypeMapping
```
public Map<String,String> getFormatTypeMapping()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'formatTypeMapping' configuration option.
    
    Specified by:
    
    getFormatTypeMapping in interface GenerationConfig
    
    Returns:
    
    An optional mapping from format identifier (e.g. 'uri') to fully qualified type name (e.g. 'java.net.URI').
  - isUseInnerClassBuilders
```
public boolean isUseInnerClassBuilders()
```
    Description copied from interface: GenerationConfig
    
    If set to true, then the gang of four builder pattern will be used to generate builders on generated classes. Note: This property works in collaboration with the GenerationConfig.isGenerateBuilders() method. If the GenerationConfig.isGenerateBuilders() is false, then this property will not do anything.
    
    Specified by:
    
    isUseInnerClassBuilders in interface GenerationConfig
    
    Returns:
    
    whether to include the gang of four builder patter on the generated classes. The default value for this is false.
  - isIncludeGeneratedAnnotation
```
public boolean isIncludeGeneratedAnnotation()
```
    Description copied from interface: GenerationConfig
    
    Whether to mark generated classes with the annotation javax.annotation.@Generated
    
    Specified by:
    
    isIncludeGeneratedAnnotation in interface GenerationConfig
  - isUseJakartaValidation
```
public boolean isUseJakartaValidation()
```
    Description copied from interface: GenerationConfig
    
    Gets the 'useJakartaValidation' configuration option. This property works in collaboration with the GenerationConfig.isIncludeJsr303Annotations() configuration option. If the GenerationConfig.isIncludeJsr303Annotations() returns false, then this configuration option will not affect anything.
    
    Specified by:
    
    isUseJakartaValidation in interface GenerationConfig
    
    Returns:
    
    Whether to use JSR-303 annotations from jakarta.validation package instead of javax.validation package when adding JSR-303 annotations to generated Java types

Class Jsonschema2PojoMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

Jsonschema2PojoMojo

Method Detail

execute

isGenerateBuilders

isIncludeTypeInfo

isIncludeConstructorPropertiesAnnotation

getTargetDirectory

getSource

isUsePrimitives

getTargetPackage

getPropertyWordDelimiters

isUseLongIntegers

isUseDoubleNumbers

isIncludeHashcodeAndEquals

isIncludeToString

getToStringExcludes

getAnnotationStyle

isUseTitleAsClassname

getInclusionLevel

getCustomAnnotator

getCustomRuleFactory

isIncludeJsr303Annotations

isIncludeJsr305Annotations

isUseOptionalForGetters

getSourceType

isRemoveOldOutput

getOutputEncoding

isUseJodaDates

isUseJodaLocalDates

isUseJodaLocalTimes

isUseCommonsLang3

isParcelable

isSerializable

getFileFilter

isInitializeCollections

getClassNamePrefix

getClassNameSuffix

getFileExtensions

isIncludeConstructors

isConstructorsRequiredPropertiesOnly

isIncludeRequiredPropertiesConstructor

isIncludeAllPropertiesConstructor

isIncludeCopyConstructor

isIncludeAdditionalProperties

isIncludeGetters

isIncludeSetters

getTargetVersion

isIncludeDynamicAccessors

isIncludeDynamicGetters

isIncludeDynamicSetters

isIncludeDynamicBuilders

getDateTimeType

getDateType

getTimeType

isUseBigIntegers

isUseBigDecimals

isFormatDateTimes

isFormatDates

isFormatTimes

getCustomDatePattern

getCustomTimePattern

getCustomDateTimePattern

getRefFragmentPathDelimiters

getSourceSortOrder

getFormatTypeMapping

isUseInnerClassBuilders

isIncludeGeneratedAnnotation

isUseJakartaValidation