Package org.codehaus.mojo.jaxb2.javageneration

Class TestXjcMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="testXjc",
      defaultPhase=GENERATE_TEST_SOURCES,
      requiresDependencyResolution=TEST,
      threadSafe=false)
public class TestXjcMojo
extends AbstractJavaGeneratorMojo

    Mojo that creates test-scope Java source or binaries from XML schema(s) by invoking the JAXB XJC binding compiler. This implementation is tailored to use the JAXB Reference Implementation from project Kenai.

    Note that the TestXjcMojo 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.

    See Also:
    The JAXB Reference Implementation

    • Field Detail

      • STALE_FILENAME

        public static final java.lang.String STALE_FILENAME
        The last part of the stale fileName for this TestXjcMojo.
        See Also:
        Constant Field Values

      • STANDARD_TEST_SOURCE_DIRECTORY

        public static final java.lang.String STANDARD_TEST_SOURCE_DIRECTORY
        Standard directory path (relative to basedir) searched recursively for test source files (typically XSDs), unless overridden by a testSources configuration element.
        See Also:
        Constant Field Values

      • STANDARD_TEST_SOURCE_EXCLUDE_FILTERS

        public static final java.util.List<Filter<java.io.File>> STANDARD_TEST_SOURCE_EXCLUDE_FILTERS

        Default exclude Filters for test sources, used unless overridden by an explicit configuration in the testSourceExcludeFilters parameter. The default values are found as follows:

             
         final List<Filter<File>> xjbTemp = new ArrayList<Filter<File>>();
         xjbTemp.addAll(AbstractJaxbMojo.STANDARD_EXCLUDE_FILTERS);
         xsdTemp.add(new PatternFileFilter(Arrays.asList("\\.xjb"), true));
         STANDARD_TEST_SOURCE_EXCLUDE_FILTERS = Collections.unmodifiableList(xsdTemp);
        See Also:
        AbstractJaxbMojo.STANDARD_EXCLUDE_FILTERS

      • STANDARD_TEST_XJB_DIRECTORY

        public static final java.lang.String STANDARD_TEST_XJB_DIRECTORY

        Standard directory path (relative to basedir) searched recursively for XJB files, unless overridden by an testXjbSources configuration element. As explained in the JAXB specification, XJB files (JAXB Xml Binding files) are used to configure parts of the Java source generation.

        See Also:
        Constant Field Values

      • STANDARD_TEST_XJB_EXCLUDE_FILTERS

        public static final java.util.List<Filter<java.io.File>> STANDARD_TEST_XJB_EXCLUDE_FILTERS

        Default List of exclude Filters for XJB files, unless overridden by providing an explicit configuration in the testXjbExcludeFilters parameter. The default values are found as follows:

             
         final List<Filter<File>> xjbTemp = new ArrayList<Filter<File>>();
         xjbTemp.addAll(AbstractJaxbMojo.STANDARD_EXCLUDE_FILTERS);
         xjbTemp.add(new PatternFileFilter(Arrays.asList("\\.xsd"), true));
         STANDARD_TEST_XJB_EXCLUDE_FILTERS = Collections.unmodifiableList(xjbTemp);
        See Also:
        AbstractJaxbMojo.STANDARD_EXCLUDE_FILTERS

      • outputDirectory

        @Parameter(defaultValue="${project.build.directory}/generated-test-sources/jaxb",
           required=true)
private java.io.File outputDirectory

        Corresponding XJC parameter: d.

        The working directory where the generated Java test source files are created.

      • testSources

        @Parameter(required=false)
private java.util.List<java.lang.String> testSources

        Parameter holding List of XSD paths to files and/or directories which should be recursively searched for XSD files. Only files or directories that actually exist will be included (in the case of files) or recursively searched for XSD files to include (in the case of directories). Configure using standard Maven structure for Lists:

         
   <configuration>
   ...
       <testSources>
          <testSource>some/explicit/relative/file.xsd</testSource>
          <testSource>/another/absolute/path/to/a/specification.xsd</testSource>
          <testSource>a/directory/holding/xsds</testSource>
      </testSources>
   </configuration>
        See Also:
        STANDARD_TEST_SOURCE_DIRECTORY

      • testXjbSources

        @Parameter(required=false)
private java.util.List<java.lang.String> testXjbSources

        Parameter holding List of XJB Files and/or directories which should be recursively searched for XJB files. Only files or directories that actually exist will be included (in the case of files) or recursively searched for XJB files to include (in the case of directories). JAXB binding files are used to configure parts of the Java source generation. Supply the configuration using the standard Maven structure for configuring plugin Lists:

         
   <configuration>
   ...
       <testXjbSources>
          <testXjbSource>bindings/aBindingConfiguration.xjb</testXjbSource>
          <testXjbSource>bindings/config/directory</testXjbSource>
      </testXjbSources>
   </configuration>
        See Also:
        STANDARD_TEST_XJB_DIRECTORY

      • testSourceExcludeFilters

        @Parameter(required=false)
private java.util.List<Filter<java.io.File>> testSourceExcludeFilters

        Parameter holding a List of Filters, used to match all files under the testSources directories which should not be considered XJC test source files. (The filters identify files to exclude, and hence this parameter is called testS§ourceExcludeFilters). If a file under any of the test source directories matches at least one of the Filters supplied in the testSourceExcludeFilters, it is not considered an XJC source file, and therefore excluded from processing.

        If not explicitly provided, the Mojo uses the value within STANDARD_TEST_SOURCE_EXCLUDE_FILTERS. The algorithm for finding XJC test sources is as follows:

        1. Find all files given in the testSources List. Any Directories provided are searched for files recursively.
        2. Exclude any found files matching any of the supplied testSourceExcludeFilters List.
        3. The remaining Files are submitted for processing by the XJC tool.

        Example: The following configuration would exclude any sources whose names end with txt or foo:

             
         <configuration>
         ...
              <testSourceExcludeFilters>
                  <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">txt</suffixFilter>
                  <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">foo</suffixFilter>
              </testSourceExcludeFilters>
         </configuration>
        See Also:
        STANDARD_TEST_SOURCE_EXCLUDE_FILTERS, PatternFileFilter, AbstractPatternFilter, AbstractFilter

      • testXjbExcludeFilters

        @Parameter(required=false)
private java.util.List<Filter<java.io.File>> testXjbExcludeFilters

        Parameter holding a List of Filters, used to match all files under the testXjbSources directories which should not be considered XJB files. (The filters identify files to exclude, and hence this parameter is called testXjbExcludeFilters). If a file matches at least one of the supplied Filters, it is not considered an XJB file, and therefore excluded from processing.

        If not explicitly provided, the Mojo uses the value within STANDARD_TEST_XJB_EXCLUDE_FILTERS.

        Example: The following configuration would exclude any XJB files whose names end with xml or foo:

             
         <configuration>
         ...
              <testXjbExcludeFilters>
                  <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">xml</suffixFilter>
                  <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">foo</suffixFilter>
              </sourceExcludeFilters>
         </testXjbExcludeFilters>
        See Also:
        STANDARD_TEST_XJB_EXCLUDE_FILTERS, PatternFileFilter, AbstractPatternFilter, AbstractFilter

      • skipTestXjc

        @Parameter(property="xjc.test.skip",
           defaultValue="false")
private boolean skipTestXjc
        Indicate if the XjcMojo execution should be skipped.

    • Constructor Detail

      • TestXjcMojo

        public TestXjcMojo()

    • Method Detail

      • shouldExecutionBeSkipped

        protected boolean shouldExecutionBeSkipped()
        Implement this method to check if this AbstractJaxbMojo should skip executing altogether.
        Specified by:
        shouldExecutionBeSkipped in class AbstractJaxbMojo
        Returns:
        true to indicate that this AbstractJaxbMojo should bail out of its execute method.

      • getSources

        protected java.util.List<java.net.URL> getSources()
        Override this method to acquire a List holding all URLs to the JAXB sources for which this AbstractJavaGeneratorMojo should generate Java files. Sources are assumed to be in the form given by the sourceType value.
        Specified by:
        getSources in class AbstractJavaGeneratorMojo
        Returns:
        A non-null List holding URLs to sources for the XJC generation.
        See Also:
        AbstractJavaGeneratorMojo.sourceType

      • getSourceXJBs

        protected java.util.List<java.io.File> getSourceXJBs()
        Override this method to retrieve a list of Files to all XJB files for which this AbstractJavaGeneratorMojo should generate Java files.
        Specified by:
        getSourceXJBs in class AbstractJavaGeneratorMojo
        Returns:
        A non-null List holding binding files.

      • getStaleFileName

        protected java.lang.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.

      • getOutputDirectory

        protected java.io.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 java.util.List<java.lang.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.

      • addGeneratedSourcesToProjectSourceRoot

        protected void addGeneratedSourcesToProjectSourceRoot()
        Adds any directories containing the generated XJC classes to the appropriate Project compilation sources; either TestCompileSourceRoot or CompileSourceRoot depending on the exact Mojo implementation of this AbstractJavaGeneratorMojo.
        Specified by:
        addGeneratedSourcesToProjectSourceRoot in class AbstractJavaGeneratorMojo

      • addResource

        protected void addResource​(org.apache.maven.model.Resource resource)
        Adds the supplied Resource to the project using the appropriate scope (i.e. resource or testResource) depending on the exact implementation of this AbstractJaxbMojo.
        Specified by:
        addResource in class AbstractJaxbMojo
        Parameters:
        resource - The resource to add.