Package gov.nist.secauto.metaschema.maven.plugin

Class GenerateSchemaMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

gov.nist.secauto.metaschema.maven.plugin.AbstractMetaschemaMojo

gov.nist.secauto.metaschema.maven.plugin.GenerateSchemaMojo

All Implemented Interfaces:

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

@Mojo(name="generate-schemas",
      defaultPhase=GENERATE_RESOURCES)
public class GenerateSchemaMojo
extends AbstractMetaschemaMojo

Goal which generates XML and JSON schemas for a given set of Metaschema modules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GenerateSchemaMojo.SchemaFormat

Field Summary

Fields inherited from class gov.nist.secauto.metaschema.maven.plugin.AbstractMetaschemaMojo

excludes, includes, staleFileDirectory

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateSchemaMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected void	generate(Set<IModule> modules)	Performs schema generation using the provided Metaschema modules.
protected String	getStaleFileName()	Gets the last part of the stale filename.
protected boolean	isInlineChoiceDefinitions()	Determine if inlining choice definitions is required.
protected boolean	isInlineDefinitions()	Determine if inlining definitions is required.

Methods inherited from class gov.nist.secauto.metaschema.maven.plugin.AbstractMetaschemaMojo

getBuildContext, getConstraints, getEncoding, getMavenProject, getModuleSources, getMojoExecution, getOutputDirectory, getStaleFile, isGenerationRequired, newModuleLoader, setOutputDirectory, shouldExecutionBeSkipped

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

Constructor Details

GenerateSchemaMojo

public GenerateSchemaMojo()

Method Details

isInlineDefinitions

protected boolean isInlineDefinitions()

Determine if inlining definitions is required.

Returns:

true if inlining definitions is required, or false otherwise

isInlineChoiceDefinitions

protected boolean isInlineChoiceDefinitions()

Determine if inlining choice definitions is required.

Returns:

true if inlining choice definitions is required, or false otherwise

getStaleFileName

protected String getStaleFileName()

Gets the last part of the stale filename.

The full stale filename will be generated by pre-pending "." + getExecution().getExecutionId() to this staleFileName.

Specified by:

getStaleFileName in class AbstractMetaschemaMojo

Returns:

the stale filename postfix

generate

protected void generate(@NonNull
 Set<IModule> modules)
                 throws org.apache.maven.plugin.MojoExecutionException

Performs schema generation using the provided Metaschema modules.

Parameters:

modules - the Metaschema modules to generate the schema for

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurred during generation

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException