Add the output directory to the project as a source root, so that the generated java types are compiled and included in the project artifact.

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

Supported values:

• jackson2 (apply annotations from the Jackson 2.x library)
• jackson3 (apply annotations from the Jackson 2.x library, and from Jackson 3.x databind for data-binding annotations)
• jackson (alias for jackson2)
• jsonb (apply annotations from the JSON-B 1.x library)
• jsonb2 (apply annotations from the JSON-B 2.x library)
• gson (apply annotations from the gson library)
• moshi1 (apply annotations from the moshi 1.x library)
• none (apply no annotations at all)

Whether to add a prefix to generated classes.

Whether to add a suffix to generated classes.

The 'constructorsRequiredPropertiesOnly' configuration option. This is a legacy configuration option used to turn on isIncludeRequiredPropertiesConstructor() and off the isIncludeAllPropertiesConstructor() configuration options. It is specifically tied to the isIncludeConstructors() property, and will do nothing if that property is not enabled

A fully qualified class name, referring to a custom annotator class that implements org.jsonschema2pojo.Annotator and will be used in addition to the one chosen by annotationStyle.

If you want to use the custom annotator alone, set annotationStyle to none.

A custom pattern to use when formatting date fields during serialization. Requires support from your JSON binding library.

A custom pattern to use when formatting date-time fields during serialization. Requires support from your JSON binding library.

A fully qualified class name, referring to an class that extends org.jsonschema2pojo.rules.RuleFactory and will be used to create instances of Rules used for code generation.

A custom pattern to use when formatting time fields during serialization. Requires support from your JSON binding library.

What type to use instead of string when adding string type fields of format date-time to generated Java types.

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

List of file patterns to exclude. This only applies to the initial scan of the file system and will not prevent inclusion through a "$ref" in one of the schemas.

The strings (no preceeding dot) that should be considered as file name extensions, and therefore ignored, when creating Java class names.

Whether the fields of type `date` are formatted during serialization with a default pattern of yyyy-MM-dd'T'HH:mm:ss.SSSZ.

Whether the fields of type `date` are formatted during serialization with a default pattern of yyyy-MM-dd.

Whether the fields of type `time` are formatted during serialization with a default pattern of HH:mm:ss.SSS.

No description.

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

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

The 'includeAllPropertiesConstructor' configuration option. This property works in collaboration with the 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.

No description.

Whether to generate constructors or not

The 'includeCopyConstructor' configuration option. This property works in collaboration with the 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.

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

Whether to include dynamic builders or to omit these methods.

Whether to include dynamic getters or to omit these methods.

Whether to include dynamic setters or to omit these methods.

Whether to include a javax.annotation.Generated (Java 8 and lower) or javax.annotation.processing.Generated (Java 9+) in on generated types. See also: targetVersion.

Whether to include getters or to omit this accessor method and create public fields instead

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

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

Schema rules and the annotation they produce:

• maximum = @DecimalMax
• minimum = @DecimalMin
• minItems,maxItems = @Size
• minLength,maxLength = @Size
• pattern = @Pattern
• required = @NotNull

Any Java fields which are an object or array of objects will be annotated with @Valid to support validation of an entire document tree.

Whether to include JSR-305 annotations (for schema rules like Nullable, NonNull, etc) in generated Java types.

The 'includeRequiredPropertiesConstructor' configuration option. This property works in collaboration with the 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.

Whether to include setters or to omit this accessor method and create public fields instead

Whether to include a toString method in generated Java types.

Whether to include json type information; often required to support polymorphic type handling.

By default the type information is stored in the @class property, this can be overridden in the deserializationClassProperty of the schema.

List of file patterns to include.

The Level of inclusion to set in the generated Java types for Jackson serializers.

Supported values

• ALWAYS
• NON_ABSENT
• NON_DEFAULT
• NON_EMPTY
• NON_NULL
• USE_DEFAULTS

Whether to initialize Set and List fields as empty collections, or leave them as null.

Target directory for generated Java source files.

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

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

The characters that should be considered as word delimiters when creating Java Bean property names from JSON property names. If blank or not set, JSON properties will be considered to contain a single word when creating Java Bean property names.

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.

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.

Whether to make the generated types 'serializable'.

Skip plugin execution (don't read/validate any schema files, don't generate any java types).

Location of the JSON Schema file(s). Note: this may refer to a single file or a directory of files.

An array of locations of the JSON Schema file(s). Note: each item may refer to a single file or a directory of files.

The sort order to be applied when recursively processing the source files. By default the OS can influence the processing order. 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.)

The type of input documents that will be read

Supported values:

• jsonschema (schema documents, containing formal rules that describe the structure of JSON data)
• json (documents that represent an example of the kind of JSON data that the generated Java types will be mapped to)
• yamlschema (JSON schema documents, represented as YAML)
• yaml (documents that represent an example of the kind of YAML (or JSON) data that the generated Java types will be mapped to)

Package name used for generated Java classes (for types where a fully qualified name has not been supplied in the schema using the 'javaType' property).

The target version for generated source files, used whenever decisions are made about generating source code that may be incompatible with older JVMs. Acceptable values include e.g. 1.6, 1.8, 8, 9, 10, 11.

If not set, the value of targetVersion is auto-detected. For auto-detection, the first value found in the following list will be used:

1. maven.compiler.source property
2. maven.compiler.release property
3. maven-compiler-plugin 'source' configuration option
4. maven-compiler-plugin 'release' configuration option
5. the current JVM version

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

The fields to be excluded from toString generation

Whether to use the java type java.math.BigDecimal instead of float (or Float) when representing the JSON Schema type 'number'. Note that this configuration overrides isUseDoubleNumbers().

Whether to use the java type java.math.BigInteger instead of int (or Integer) when representing the JSON Schema type 'integer'. Note that this configuration overrides isUseLongIntegers().

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

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 isGenerateBuilders() method. If the isGenerateBuilders() is false, then this property will not do anything.

Whether to use annotations from jakarta.validation package instead of javax.validation package when adding JSR-303 annotations to generated Java types. This property works in collaboration with the isIncludeJsr303Annotations() configuration option. If the isIncludeJsr303Annotations() returns false, then this configuration option will not affect anything.

Whether to use org.joda.time.DateTime instead of java.util.Date when adding date type fields to generated Java types.

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

Whether to use org.joda.time.LocalTime instead of string when adding string type fields of format time (not date-time) to generated Java types.

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

Whether to use java.util.Optional as return type for getters of non-required fields.

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).

Use the title as class name. Otherwise, the property and file name is used.