GenerationConfig (jsonschema2pojo 0.5.1 API)

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

All Methods Instance Methods Abstract Methods
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.
`InclusionLevel`	`getInclusionLevel()` Gets the 'inclusionLevel' option for Jackson1 and Jackson2 serializers.
`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.
`Language`	`getTargetLanguage()` Gets the 'targetLanguage' 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`	`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` configuration option
`boolean`	`isIncludeDynamicBuilders()` Gets the `includeDynamicBuilders` configuration option.
`boolean`	`isIncludeDynamicGetters()` Gets the `includeDynamicGetters` configuration option.
`boolean`	`isIncludeDynamicSetters()` Gets the `includeDynamicSetters` configuration option.
`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`	`isIncludeSetters()` Gets the 'includeSetters' 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`	`isSerializable()` Gets the 'serializable' configuration option.
`boolean`	`isUseBigDecimals()` Gets the 'useBigDecimals' configuration option.
`boolean`	`isUseBigIntegers()` Gets the 'useBigIntegers' 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'.
  - isUseBigIntegers
```
boolean isUseBigIntegers()
```
    Gets the 'useBigIntegers' configuration option.
    
    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 isUseLongIntegers().
  - 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'.
  - isUseBigDecimals
```
boolean isUseBigDecimals()
```
    Gets the 'useBigDecimals' configuration option.
    
    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 isUseDoubleNumbers().
  - 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.
  - getToStringExcludes
```
String[] getToStringExcludes()
```
    Gets the 'toStringExcludes' configuration option.
    
    Returns:
    
    An array of strings representing fields that should be excluded from toString methods
  - 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)
    
    moshi1 (apply annotations from the moshi library)
    
    none (apply no annotations at all)
    See Also:
    
    AnnotatorFactory
  - getInclusionLevel
```
InclusionLevel getInclusionLevel()
```
    Gets the 'inclusionLevel' option for Jackson1 and Jackson2 serializers.
    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
```
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.
  - isIncludeJsr305Annotations
```
boolean isIncludeJsr305Annotations()
```
    Gets the 'includeJsr305Annotations' configuration option.
    
    Returns:
    
    Whether to include JSR-305 annotations (for schema rules like Nullable, NonNull, 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 org.joda.time.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 org.joda.time.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 org.joda.time.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)
  - isSerializable
```
boolean isSerializable()
```
    Gets the 'serializable' configuration option.
    
    Returns:
    
    Whether to make the generated types 'serializable'
  - 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 add a prefix to generated classes.
  - getClassNameSuffix
```
String getClassNameSuffix()
```
    Gets the 'getClassNameSuffix' configuration option.
    
    Returns:
    
    Whether to add a suffix to generated classes.
  - getFileExtensions
```
String[] getFileExtensions()
```
    Gets the 'fileExtensions' configuration option.
    
    Returns:
    
    An array of strings that should be considered as file extensions and therefore not included in class names.
  - 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.
  - isIncludeGetters
```
boolean isIncludeGetters()
```
    Gets the 'includeGetters' configuration option.
    
    Returns:
    
    Whether to include getters or to omit these accessor methods and create public fields instead.
  - isIncludeSetters
```
boolean isIncludeSetters()
```
    Gets the 'includeSetters' configuration option.
    
    Returns:
    
    Whether to include 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` configuration option
    
    Returns:
    
    Whether to include dynamic getters, setters, and builders or to omit these methods.
  - isIncludeDynamicGetters
```
boolean isIncludeDynamicGetters()
```
    Gets the `includeDynamicGetters` configuration option.
    
    Returns:
    
    Whether to include dynamic getters or to omit these methods
  - isIncludeDynamicSetters
```
boolean isIncludeDynamicSetters()
```
    Gets the `includeDynamicSetters` configuration option.
    
    Returns:
    
    Whether to include dynamic setters or to omit these methods
  - isIncludeDynamicBuilders
```
boolean isIncludeDynamicBuilders()
```
    Gets the `includeDynamicBuilders` configuration option.
    
    Returns:
    
    Whether to include dynamic builders or to omit these methods
  - getDateTimeType
```
String getDateTimeType()
```
    Gets the `dateTimeType` configuration option.
    Example values:
    - org.joda.time.LocalDateTime (Joda)
    - java.time.LocalDateTime (JSR310)
    - null (default behavior)
    Returns:
    
    The java type to use instead of Date when adding date type fields to generate Java types.
  - getDateType
```
String getDateType()
```
    Gets the `dateType` configuration option.
    Example values:
    - org.joda.time.LocalDate (Joda)
    - java.time.LocalDate (JSR310)
    - null (default behavior)
    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
```
String getTimeType()
```
    Gets the `timeType` configuration option.
    Example values:
    - org.joda.time.LocalTime (Joda)
    - java.time.LocalTime (JSR310)
    - null (default behavior)
    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.
  - isFormatDates
```
boolean isFormatDates()
```
    Gets the `formatDates` configuration option
    
    Returns:
    
    Whether the fields of type date have the @JsonFormat annotation with pattern set to the default value of yyyy-MM-dd
  - isFormatTimes
```
boolean isFormatTimes()
```
    Gets the `formatTimes` configuration option
    
    Returns:
    
    Whether the fields of type time have the @JsonFormat annotation with pattern set to the default value of HH:mm:ss.SSS
  - isFormatDateTimes
```
boolean isFormatDateTimes()
```
    Gets the `formatDateTime` configuration option
    
    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
  - getCustomDatePattern
```
String getCustomDatePattern()
```
    Gets the 'customDatePattern' configuration option
    
    Returns:
    
    The custom format that dates will use when types are serialized. Requires support from your JSON binding library.
  - getCustomTimePattern
```
String getCustomTimePattern()
```
    Gets the 'customTimePattern' configuration option
    
    Returns:
    
    The custom format that times will use when types are serialized. Requires support from your JSON binding library.
  - getCustomDateTimePattern
```
String getCustomDateTimePattern()
```
    Gets the 'customDateTimePattern' configuration option
    
    Returns:
    
    The custom format that dates will use when types are serialized. Requires support from your JSON binding library.
  - getRefFragmentPathDelimiters
```
String getRefFragmentPathDelimiters()
```
    Gets the `refFragmentPathDelimiters` configuration option.
    
    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
```
SourceSortOrder getSourceSortOrder()
```
    Gets the 'sourceSortOrder' configuration option.
    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.)
  - getTargetLanguage
```
Language getTargetLanguage()
```
    Gets the 'targetLanguage' configuration option.
    Returns:
    The type of code that will be generated.
    Supported values:
    
    JAVA (Generate .java source files)
    
    SCALA (Generate .scala source files, using scalagen)

Interface GenerationConfig

Method Summary

Method Detail

isGenerateBuilders

isUsePrimitives

getSource

getTargetDirectory

getTargetPackage

getPropertyWordDelimiters

isUseLongIntegers

isUseBigIntegers

isUseDoubleNumbers

isUseBigDecimals

isIncludeHashcodeAndEquals

isIncludeToString

getToStringExcludes

getAnnotationStyle

getInclusionLevel

getCustomAnnotator

getCustomRuleFactory

isIncludeJsr303Annotations

isIncludeJsr305Annotations

getSourceType

isRemoveOldOutput

getOutputEncoding

isUseJodaDates

isUseJodaLocalDates

isUseJodaLocalTimes

isUseCommonsLang3

isParcelable

isSerializable

getFileFilter

isInitializeCollections

getClassNamePrefix

getClassNameSuffix

getFileExtensions

isIncludeConstructors

isConstructorsRequiredPropertiesOnly

isIncludeAdditionalProperties

isIncludeAccessors

isIncludeGetters

isIncludeSetters

getTargetVersion

isIncludeDynamicAccessors

isIncludeDynamicGetters

isIncludeDynamicSetters

isIncludeDynamicBuilders

getDateTimeType

getDateType

getTimeType

isFormatDates

isFormatTimes

isFormatDateTimes

getCustomDatePattern

getCustomTimePattern

getCustomDateTimePattern

getRefFragmentPathDelimiters

getSourceSortOrder

getTargetLanguage