org.jsonschema2pojo.ant

Class Jsonschema2PojoTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.jsonschema2pojo.ant.Jsonschema2PojoTask

All Implemented Interfaces:

Cloneable, GenerationConfig

public class Jsonschema2PojoTask
extends org.apache.tools.ant.Task
implements GenerationConfig

When invoked, this task reads one or more JSON Schema documents and generates DTO style Java classes for data binding.

See jsonschema2pojo.googlecode.com.

See Also:

Writing Your Own Task

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
Jsonschema2PojoTask()

Method Summary

Modifier and Type	Method and Description
org.apache.tools.ant.types.Path	createClasspath()
void	execute() Execute this task (it's expected that all relevant setters will have been called by Ant to provide task configuration before this method is called).
AnnotationStyle	getAnnotationStyle()
String	getClassNamePrefix()
String	getClassNameSuffix()
org.apache.tools.ant.types.Path	getClasspath()
Class<? extends Annotator>	getCustomAnnotator()
Class<? extends RuleFactory>	getCustomRuleFactory()
FileFilter	getFileFilter()
String	getOutputEncoding()
char[]	getPropertyWordDelimiters()
Iterator<URL>	getSource()
SourceType	getSourceType()
File	getTargetDirectory()
String	getTargetPackage()
boolean	isConstructorsRequiredPropertiesOnly() Gets the 'constructorsRequiredPropertiesOnly' configuration option
boolean	isGenerateBuilders()
boolean	isIncludeConstructors()
boolean	isIncludeHashcodeAndEquals()
boolean	isIncludeJsr303Annotations()
boolean	isIncludeToString()
boolean	isInitializeCollections()
boolean	isRemoveOldOutput()
boolean	isSkip() Should this task be skipped? (don't read schemas, don't generate types)
boolean	isUseCommonsLang3()
boolean	isUseDoubleNumbers()
boolean	isUseJodaDates()
boolean	isUseJodaLocalDates()
boolean	isUseJodaLocalTimes()
boolean	isUseLongIntegers()
boolean	isUsePrimitives()
void	setAnnotationStyle(AnnotationStyle annotationStyle) Sets the 'annotationStyle' property of this class
void	setClasspath(org.apache.tools.ant.types.Path classpath)
void	setClasspathRef(org.apache.tools.ant.types.Reference classpathRef)
void	setConstructorsRequiredPropertiesOnly(boolean constructorsRequiredPropertiesOnly) Sets the 'constructorsRequiredPropertiesOnly' property of this class.
void	setCustomAnnotator(String customAnnotator) Sets the 'customAnnotator' property of this class
void	setCustomRuleFactory(String customRuleFactory)
void	setGenerateBuilders(boolean generateBuilders) Sets the 'generateBuilders' property of this class.
void	setIncludeConstructors(boolean includeConstructors) Sets the 'includeConstructors' property of this class
void	setIncludeHashcodeAndEquals(boolean includeHashcodeAndEquals) Sets the 'includeHashcodeAndEquals' property of this class
void	setIncludeJsr303Annotations(boolean includeJsr303Annotations) Sets the 'includeJsr303Annotations' property of this class
void	setIncludeToString(boolean includeToString) Sets the 'includeToString' property of this class
void	setInitializeCollections(boolean initializeCollections) Sets the 'initializeCollections' property of this class
void	setOutputEncoding(String outputEncoding) Sets the 'outputEncoding' property of this class
void	setPropertyWordDelimiters(String propertyWordDelimiters)
void	setRemoveOldOutput(boolean removeOldOutput) Sets the 'removeOldOutput' property of this class
void	setSkip(boolean skip) Sets the 'skip' property of this task.
void	setSource(String source) Sets schema file (or directory containing schema files) that should be used for input.
void	setSourceType(SourceType sourceType) Sets the 'sourceType' property of this class
void	setTargetDirectory(File targetDirectory) Sets the target (output) directory for generated source files.
void	setTargetPackage(String targetPackage) Sets the target package for generated types.
void	setUseCommonsLang3(boolean useCommonsLang3) Sets the 'useCommonsLang3' property of this class
void	setUseDoubleNumbers(boolean useDoubleNumbers) Sets the 'useDoubleNumbers' property of this class
void	setUseJodaDates(boolean useJodaDates) Sets the 'useJodaDates' property of this class
void	setUseJodaLocalDates(boolean useJodaLocalDates) Sets the 'useJodaLocalDates' property of this class
void	setUseJodaLocalTimes(boolean useJodaLocalTimes) Sets the 'useJodaLocalTimes' property of this class
void	setUseLongIntegers(boolean useLongIntegers) Sets the 'useLongIntegers' property of this class
void	setUsePrimitives(boolean usePrimitives) Sets the 'usePrimitives' property of this class.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsonschema2PojoTask

public Jsonschema2PojoTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute this task (it's expected that all relevant setters will have been called by Ant to provide task configuration before this method is called).

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - if this task cannot be completed due to some error reading schemas, generating types or writing output .java files.

setIncludeConstructors

public void setIncludeConstructors(boolean includeConstructors)

Sets the 'includeConstructors' property of this class

Parameters:

includeConstructors - Whether to generate constructors or not.

setConstructorsRequiredPropertiesOnly

public void setConstructorsRequiredPropertiesOnly(boolean constructorsRequiredPropertiesOnly)

Sets the 'constructorsRequiredPropertiesOnly' property of this class.

Parameters:

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

setGenerateBuilders

public void setGenerateBuilders(boolean generateBuilders)

Sets the 'generateBuilders' property of this class.

Parameters:

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

Default: false.

setUsePrimitives

public void setUsePrimitives(boolean usePrimitives)

Sets the 'usePrimitives' property of this class.

Parameters:

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

Default: false.

setUseLongIntegers

public void setUseLongIntegers(boolean useLongIntegers)

Sets the 'useLongIntegers' property of this class

Parameters:

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

setUseDoubleNumbers

public void setUseDoubleNumbers(boolean useDoubleNumbers)

Sets the 'useDoubleNumbers' property of this class

Parameters:

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

setSource

public void setSource(String source)

Sets schema file (or directory containing schema files) that should be used for input.

Parameters:

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

setTargetDirectory

public void setTargetDirectory(File targetDirectory)

Sets the target (output) directory for generated source files.

Parameters:

targetDirectory - Target directory for generated Java source files.

setTargetPackage

public void setTargetPackage(String targetPackage)

Sets the target package for generated types.

Parameters:

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

setSkip

public void setSkip(boolean skip)

Sets the 'skip' property of this task.

Parameters:

skip - whether to skip execution of this task

setPropertyWordDelimiters

public void setPropertyWordDelimiters(String propertyWordDelimiters)

Parameters:

propertyWordDelimiters - a string containing all of 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.

setIncludeHashcodeAndEquals

public void setIncludeHashcodeAndEquals(boolean includeHashcodeAndEquals)

Sets the 'includeHashcodeAndEquals' property of this class

Parameters:

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

setIncludeToString

public void setIncludeToString(boolean includeToString)

Sets the 'includeToString' property of this class

Parameters:

includeToString - Whether to include a toString method in generated Java types.

setAnnotationStyle

public void setAnnotationStyle(AnnotationStyle annotationStyle)

Sets the 'annotationStyle' property of this class

Parameters:

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

setCustomAnnotator

public void setCustomAnnotator(String customAnnotator)

Sets the 'customAnnotator' property of this class

Parameters:

customAnnotator - A custom annotator to use to annotate the generated types

setCustomRuleFactory

public void setCustomRuleFactory(String customRuleFactory)

setIncludeJsr303Annotations

public void setIncludeJsr303Annotations(boolean includeJsr303Annotations)

Sets the 'includeJsr303Annotations' property of this class

Parameters:

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

setSourceType

public void setSourceType(SourceType sourceType)

Sets the 'sourceType' property of this class

Parameters:

sourceType - The type of input documents that will be read

Supported values:

• jsonschema
• json

setRemoveOldOutput

public void setRemoveOldOutput(boolean removeOldOutput)

Sets the 'removeOldOutput' property of this class

Parameters:

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

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Sets the 'outputEncoding' property of this class

Parameters:

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

setUseJodaDates

public void setUseJodaDates(boolean useJodaDates)

Sets the 'useJodaDates' property of this class

Parameters:

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

setUseJodaLocalDates

public void setUseJodaLocalDates(boolean useJodaLocalDates)

Sets the 'useJodaLocalDates' property of this class

Parameters:

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

setUseJodaLocalTimes

public void setUseJodaLocalTimes(boolean useJodaLocalTimes)

Sets the 'useJodaLocalTimes' property of this class

Parameters:

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

setUseCommonsLang3

public void setUseCommonsLang3(boolean useCommonsLang3)

Sets the 'useCommonsLang3' property of this class

Parameters:

useCommonsLang3 - Whether to use commons-lang 3.x imports instead of commons-lang 2.x imports when adding equals, hashCode and toString methods.

setInitializeCollections

public void setInitializeCollections(boolean initializeCollections)

Sets the 'initializeCollections' property of this class

Parameters:

initializeCollections - Whether to initialize collections with empty instance or null.

isGenerateBuilders

public boolean isGenerateBuilders()

Specified by:

isGenerateBuilders in interface GenerationConfig

isUsePrimitives

public boolean isUsePrimitives()

Specified by:

isUsePrimitives in interface GenerationConfig

getSource

public Iterator<URL> getSource()

Specified by:

getSource in interface GenerationConfig

getTargetDirectory

public File getTargetDirectory()

Specified by:

getTargetDirectory in interface GenerationConfig

getTargetPackage

public String getTargetPackage()

Specified by:

getTargetPackage in interface GenerationConfig

getPropertyWordDelimiters

public char[] getPropertyWordDelimiters()

Specified by:

getPropertyWordDelimiters in interface GenerationConfig

isSkip

public boolean isSkip()

Should this task be skipped? (don't read schemas, don't generate types)

Returns:

true if this task is disabled

isUseLongIntegers

public boolean isUseLongIntegers()

Specified by:

isUseLongIntegers in interface GenerationConfig

isUseDoubleNumbers

public boolean isUseDoubleNumbers()

Specified by:

isUseDoubleNumbers in interface GenerationConfig

isIncludeHashcodeAndEquals

public boolean isIncludeHashcodeAndEquals()

Specified by:

isIncludeHashcodeAndEquals in interface GenerationConfig

isIncludeToString

public boolean isIncludeToString()

Specified by:

isIncludeToString in interface GenerationConfig

getAnnotationStyle

public AnnotationStyle getAnnotationStyle()

Specified by:

getAnnotationStyle in interface GenerationConfig

getCustomAnnotator

public Class<? extends Annotator> getCustomAnnotator()

Specified by:

getCustomAnnotator in interface GenerationConfig

getCustomRuleFactory

public Class<? extends RuleFactory> getCustomRuleFactory()

Specified by:

getCustomRuleFactory in interface GenerationConfig

isIncludeJsr303Annotations

public boolean isIncludeJsr303Annotations()

Specified by:

isIncludeJsr303Annotations in interface GenerationConfig

getSourceType

public SourceType getSourceType()

Specified by:

getSourceType in interface GenerationConfig

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference classpathRef)

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

isRemoveOldOutput

public boolean isRemoveOldOutput()

Specified by:

isRemoveOldOutput in interface GenerationConfig

getOutputEncoding

public String getOutputEncoding()

Specified by:

getOutputEncoding in interface GenerationConfig

isUseJodaDates

public boolean isUseJodaDates()

Specified by:

isUseJodaDates in interface GenerationConfig

isUseJodaLocalDates

public boolean isUseJodaLocalDates()

Specified by:

isUseJodaLocalDates in interface GenerationConfig

isUseJodaLocalTimes

public boolean isUseJodaLocalTimes()

Specified by:

isUseJodaLocalTimes in interface GenerationConfig

isUseCommonsLang3

public boolean isUseCommonsLang3()

Specified by:

isUseCommonsLang3 in interface GenerationConfig

getFileFilter

public FileFilter getFileFilter()

Specified by:

getFileFilter in interface GenerationConfig

isInitializeCollections

public boolean isInitializeCollections()

Specified by:

isInitializeCollections in interface GenerationConfig

getClassNamePrefix

public String getClassNamePrefix()

Specified by:

getClassNamePrefix in interface GenerationConfig

getClassNameSuffix

public String getClassNameSuffix()

Specified by:

getClassNameSuffix in interface GenerationConfig

isIncludeConstructors

public boolean isIncludeConstructors()

Specified by:

isIncludeConstructors in interface GenerationConfig

isConstructorsRequiredPropertiesOnly

public boolean isConstructorsRequiredPropertiesOnly()

Gets the 'constructorsRequiredPropertiesOnly' configuration option

Specified by:

isConstructorsRequiredPropertiesOnly in interface GenerationConfig

Returns:

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