Class ModelloJsonSchemaGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.modello.maven.AbstractModelloGeneratorMojo

org.codehaus.modello.maven.ModelloJsonSchemaGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="jsonschema",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public final class ModelloJsonSchemaGeneratorMojo
extends AbstractModelloGeneratorMojo

Creates a JSON Schema from the model.

Since:

1.8

Field Summary

Fields

Modifier and Type	Field	Description
private String	jsonSchemaFileName
private File	outputDirectory	The output directory of the generated JSON Schema.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ModelloJsonSchemaGeneratorMojo()

Method Summary

Modifier and Type	Method	Description
protected void	customizeParameters(Map<String,Object> parameters)	Override this method to customize the values in the properties set.
protected String	getGeneratorType()
File	getOutputDirectory()

Methods inherited from class AbstractModelloGeneratorMojo

createParameters, execute, getBasedir, getModelloCore, getModels, getPackageWithVersion, getProject, getVersion, producesCompilableResult, producesResources, setBasedir, setBuildContext, setModelloCore, setModels, setPackagedVersions, setPackageWithVersion, setProject, setVersion

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-site/jsonschema",
           required=true)
private File outputDirectory

The output directory of the generated JSON Schema. Hint: if you want to publish the schema automatically with the site, configure this parameter to ${basedir}/target/generated-site/resources/jsonschema.

jsonSchemaFileName

@Parameter
private String jsonSchemaFileName

Constructor Details

ModelloJsonSchemaGeneratorMojo

public ModelloJsonSchemaGeneratorMojo()

Method Details

customizeParameters

protected void customizeParameters(Map<String,Object> parameters)

Description copied from class: AbstractModelloGeneratorMojo

Override this method to customize the values in the properties set.

This method will be called after the parameters have been populated with the parameters in the abstract mojo.

Overrides:

customizeParameters in class AbstractModelloGeneratorMojo

Parameters:

parameters - the parameters to customize

getGeneratorType

protected String getGeneratorType()

Specified by:

getGeneratorType in class AbstractModelloGeneratorMojo

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractModelloGeneratorMojo