Package io.wcm.caravan.maven.plugins.haldocs

Class GenerateJsonSchemaMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.wcm.caravan.maven.plugins.haldocs.GenerateJsonSchemaMojo

All Implemented Interfaces:

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

@Mojo(name="generate-json-schema",
      defaultPhase=PROCESS_CLASSES,
      requiresProject=true,
      threadSafe=true)
public class GenerateJsonSchemaMojo
extends org.apache.maven.plugin.AbstractMojo

Generates JSON schema files for Java POJOs using Jackson 'jackson-module-jsonSchema'. The generated files are attached as resources and included in the JAR file.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.maven.project.MavenProject	project

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateJsonSchemaMojo()

Method Summary

Modifier and Type	Method	Description
protected void	addResource(String sourceDirectory, String targetPath)	Attach directory with generated resoruces to project to include it in JAR file.
void	execute()
protected URL[]	getCompileClasspathElementURLs()	Get a List of URLs of all "compile" dependencies of this project.
protected File	getGeneratedResourcesDirectory()	Get folder to temporarily generate the resources to.
protected String	getGeneratedResourcesDirectoryPath()

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

Field Details

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

Constructor Details

GenerateJsonSchemaMojo

public GenerateJsonSchemaMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getGeneratedResourcesDirectoryPath

protected String getGeneratedResourcesDirectoryPath()

Returns:

Path name of directory for generated resources

getCompileClasspathElementURLs

protected URL[] getCompileClasspathElementURLs()
                                        throws org.apache.maven.artifact.DependencyResolutionRequiredException

Get a List of URLs of all "compile" dependencies of this project.

Returns:

Class path URLs

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

addResource

protected void addResource(String sourceDirectory,
 String targetPath)

Attach directory with generated resoruces to project to include it in JAR file.

Parameters:

sourceDirectory - Source directory

targetPath - Target path in JAR file

getGeneratedResourcesDirectory

protected File getGeneratedResourcesDirectory()

Get folder to temporarily generate the resources to.

Returns:

Folder