org.codehaus.mojo.jaxb2.schemageneration

Class SchemaGenerationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.jaxb2.AbstractJaxbMojo

org.codehaus.mojo.jaxb2.schemageneration.AbstractXsdGeneratorMojo

org.codehaus.mojo.jaxb2.schemageneration.SchemaGenerationMojo

All Implemented Interfaces:

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

@Mojo(name="schemagen",
      defaultPhase=GENERATE_RESOURCES,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class SchemaGenerationMojo
extends AbstractXsdGeneratorMojo

Mojo that creates XML schema(s) from compile-scope Java sources or binaries by invoking the JAXB SchemaGenerator. This implementation is tailored to use the JAXB Reference Implementation from project Kenai.

Note that the SchemaGenerationMojo was completely re-implemented for the 2.x versions. Its configuration semantics and parameter set is not necessarily backwards compatible with the 1.x plugin versions. If you are upgrading from version 1.x of the plugin, read the documentation carefully.

Author:

Lennart Jörelid

See Also:

The JAXB Reference Implementation

Field Summary

Fields

Modifier and Type	Field and Description
static String	STALE_FILENAME The last part of the stale fileName for this SchemaGenerationMojo.
static List<Filter<File>>	STANDARD_SOURCE_EXCLUDE_FILTERS Default exclude file name suffixes for sources, used unless overridden by an explicit configuration in the sourceExcludeSuffixes parameter.

Fields inherited from class org.codehaus.mojo.jaxb2.schemageneration.AbstractXsdGeneratorMojo

CLASS_INCLUDE_FILTERS, clearOutputDir, createJavaDocAnnotations, generateEpisode, javaDocRenderer, SCHEMAGEN_EMITTED_FILENAME, STANDARD_BYTECODE_EXCLUDE_FILTERS, STANDARD_JAVADOC_RENDERER, SYSTEM_TOOLS_CLASSLOADER_PACKAGES

Fields inherited from class org.codehaus.mojo.jaxb2.AbstractJaxbMojo

CONTAINS_WHITESPACE, extraFacets, locale, NEWLINE, PACKAGE_INFO_FILENAME, staleFileDirectory, STANDARD_EPISODE_FILENAME, STANDARD_EXCLUDE_FILTERS

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

ROLE

Constructor Summary

Constructors

Constructor and Description
SchemaGenerationMojo()

Method Summary

Modifier and Type	Method and Description
protected List<String>	getClasspath() Retrieves the configured List of paths from which this AbstractJaxbMojo and its internal toolset (XJC or SchemaGen) should read bytecode classes.
protected List<URL>	getCompiledClassNames() Finds a List containing URLs to compiled bytecode files within this Compilation Unit.
protected File	getOutputDirectory() Retrieves the directory where the generated files should be written to.
protected List<URL>	getSources() Override this method to acquire a List holding all URLs to the SchemaGen Java sources for which this AbstractXsdGeneratorMojo should generate Xml Schema Descriptor files.
protected String	getStaleFileName() Retrieves the last name part of the stale file.
protected File	getWorkDirectory()

Methods inherited from class org.codehaus.mojo.jaxb2.schemageneration.AbstractXsdGeneratorMojo

isReGenerationRequired, performExecution, shouldExecutionBeSkipped

Methods inherited from class org.codehaus.mojo.jaxb2.AbstractJaxbMojo

execute, getBuildContext, getEncoding, getEpisodeFile, getExecution, getProject, getStaleFile, logAndReturnToolArguments, logSystemPropertiesAndBasedir, warnAboutIncorrectPluginConfiguration

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 Detail

STALE_FILENAME

public static final String STALE_FILENAME

The last part of the stale fileName for this SchemaGenerationMojo.

See Also:

Constant Field Values

STANDARD_SOURCE_EXCLUDE_FILTERS

public static final List<Filter<File>> STANDARD_SOURCE_EXCLUDE_FILTERS

Default exclude file name suffixes for sources, used unless overridden by an explicit configuration in the sourceExcludeSuffixes parameter.

Constructor Detail

SchemaGenerationMojo

public SchemaGenerationMojo()

Method Detail

getCompiledClassNames

protected List<URL> getCompiledClassNames()

Finds a List containing URLs to compiled bytecode files within this Compilation Unit. Typically this equals the resolved files under the project's build directories, plus any JAR artifacts found on the classpath.

Specified by:

getCompiledClassNames in class AbstractXsdGeneratorMojo

Returns:

A non-null List containing URLs to bytecode files within this compilation unit. Typically this equals the resolved files under the project's build directories, plus any JAR artifacts found on the classpath.

getSources

protected List<URL> getSources()

Override this method to acquire a List holding all URLs to the SchemaGen Java sources for which this AbstractXsdGeneratorMojo should generate Xml Schema Descriptor files.

Specified by:

getSources in class AbstractXsdGeneratorMojo

Returns:

A non-null List holding URLs to sources for the XSD generation.

getOutputDirectory

protected File getOutputDirectory()

Retrieves the directory where the generated files should be written to.

Specified by:

getOutputDirectory in class AbstractJaxbMojo

Returns:

the directory where the generated files should be written to.

getClasspath

protected List<String> getClasspath()
                             throws org.apache.maven.plugin.MojoExecutionException

Retrieves the configured List of paths from which this AbstractJaxbMojo and its internal toolset (XJC or SchemaGen) should read bytecode classes.

Specified by:

getClasspath in class AbstractJaxbMojo

Returns:

the configured List of paths from which this AbstractJaxbMojo and its internal toolset (XJC or SchemaGen) should read classes.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the classpath could not be retrieved.

getStaleFileName

protected String getStaleFileName()

Retrieves the last name part of the stale file. The full name of the stale file will be generated by pre-pending "." + getExecution().getExecutionId() before this staleFileName.

Specified by:

getStaleFileName in class AbstractJaxbMojo

Returns:

The name of the stale file used by this AbstractJavaGeneratorMojo to detect staleness amongst its generated files.

getWorkDirectory

protected File getWorkDirectory()

Specified by:

getWorkDirectory in class AbstractXsdGeneratorMojo

Returns:

The working directory to which the SchemaGenerator should initially copy all its generated files, including bytecode files, compiled from java sources.