blob: adf4bd4b8f6d935ea7e3f9c0edc50d2333ec4fa3 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.11.1 at 2022-07-14
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20220714" />
<meta http-equiv="Content-Language" content="en" />
<title>axis2-xsd2java-maven-plugin &#x2013; axis2-xsd2java:generate-sources</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><a href="http://www.apache.org/" id="bannerLeft"><img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2"/></a></div>
<div class="pull-right"><a href="../../../" id="bannerRight"><img src="../../../images/axis.jpg" /></a></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2022-07-14<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.8.2<span class="divider">|</span></li>
<li class=""><a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class=""><a href="../../../../../../../../../../../../scm:git:https:/gitbox.apache.org/repos/asf/axis-site.git/index.html" title="Axis2/Java">Axis2/Java</a><span class="divider">/</span></li>
<li class=""><a href="index.html" title="axis2-xsd2java-maven-plugin">axis2-xsd2java-maven-plugin</a><span class="divider">/</span></li>
<li class="active ">axis2-xsd2java:generate-sources</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="index.html" title="About"><span class="none"></span>About</a> </li>
<li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a> </li>
<li><a href="plugin-info.html" title="Plugin Documentation"><span class="icon-chevron-down"></span>Plugin Documentation</a>
<ul class="nav nav-list">
<li class="active"><a href="#"><span class="none"></span>generate-sources</a>
</li>
<li><a href="generate-test-sources-mojo.html" title="generate-test-sources"><span class="none"></span>generate-test-sources</a> </li>
</ul>
</li>
<li class="nav-header">Apache</li>
<li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License"><span class="none"></span>License</a> </li>
<li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li>
<li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li>
<li><a href="http://www.apache.org/security/" class="externalLink" title="Security"><span class="none"></span>Security</a> </li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<section>
<h2><a name="axis2-xsd2java:generate-sources"></a>axis2-xsd2java:generate-sources</h2>
<p><b>Full name</b>:</p>
<p>org.apache.axis2:axis2-xsd2java-maven-plugin:1.8.2:generate-sources</p>
<p><b>Description</b>:</p>
<div>Generates Java classes from the specified schema files.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>The goal is thread-safe and supports parallel builds.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>generate-sources</code>.</li>
</ul>
<section>
<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td align="left"><code><a href="#xsdFiles">&lt;xsdFiles&gt;</a></code></td>
<td><code>File[]</code></td>
<td><code>-</code></td>
<td>The list of XSD files for which to generate the Java code.<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td align="left"><code><a href="#helperMode">&lt;helperMode&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>(no description)<br /></td>
</tr>
<tr class="a">
<td align="left"><code><a href="#ignoreUnexpected">&lt;ignoreUnexpected&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Specifies whether unexpected elements should be ignored (log
warning) instead of creating an exception.<br /></td>
</tr>
<tr class="b">
<td align="left"><code><a href="#mapperClassPackage">&lt;mapperClassPackage&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br /></td>
</tr>
<tr class="a">
<td align="left"><code><a href="#namespaceMappings">&lt;namespaceMappings&gt;</a></code></td>
<td><code>NamespaceMapping[]</code></td>
<td><code>-</code></td>
<td>Mapping of namespaces to target Java packages.<br /></td>
</tr>
<tr class="b">
<td align="left"><code><a href="#noNamespacePackageName">&lt;noNamespacePackageName&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The Java package to use for schema items without namespace.<br /></td>
</tr>
<tr class="a">
<td align="left"><code><a href="#outputDirectory">&lt;outputDirectory&gt;</a></code></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>The output directory for the generated Java code.<br /><b>Default value is</b>: <code>${project.build.directory}/generated-sources/xsd2java</code>.<br /></td>
</tr>
<tr class="b">
<td align="left"><code><a href="#packageName">&lt;packageName&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3ChelperMode.3E"></a><b><a name="helperMode">&lt;helperMode&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <code>boolean</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CignoreUnexpected.3E"></a><b><a name="ignoreUnexpected">&lt;ignoreUnexpected&gt;</a></b></h4>
<div>Specifies whether unexpected elements should be ignored (log
warning) instead of creating an exception.</div>
<ul>
<li><b>Type</b>: <code>boolean</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CmapperClassPackage.3E"></a><b><a name="mapperClassPackage">&lt;mapperClassPackage&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <code>java.lang.String</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CnamespaceMappings.3E"></a><b><a name="namespaceMappings">&lt;namespaceMappings&gt;</a></b></h4>
<div>Mapping of namespaces to target Java packages.</div>
<ul>
<li><b>Type</b>: <code>org.apache.axis2.maven.shared.NamespaceMapping[]</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CnoNamespacePackageName.3E"></a><b><a name="noNamespacePackageName">&lt;noNamespacePackageName&gt;</a></b></h4>
<div>The Java package to use for schema items without namespace.</div>
<ul>
<li><b>Type</b>: <code>java.lang.String</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CoutputDirectory.3E"></a><b><a name="outputDirectory">&lt;outputDirectory&gt;</a></b></h4>
<div>The output directory for the generated Java code.</div>
<ul>
<li><b>Type</b>: <code>java.io.File</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>Default</b>: <code>${project.build.directory}/generated-sources/xsd2java</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CpackageName.3E"></a><b><a name="packageName">&lt;packageName&gt;</a></b></h4>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <code>java.lang.String</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CxsdFiles.3E"></a><b><a name="xsdFiles">&lt;xsdFiles&gt;</a></b></h4>
<div>The list of XSD files for which to generate the Java code.</div>
<ul>
<li><b>Type</b>: <code>java.io.File[]</code></li>
<li><b>Required</b>: <code>Yes</code></li>
</ul>
</section></section>
</section>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &copy;2004&#x2013;2022
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.</p>
</div>
</div>
</footer>
</body>
</html>