Google Git
Sign in
apache / axis-site / 4f0291d5a8fb9397112130e7927cf2f4e55d8bf2 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / jaxws / runtime / description / marshal / impl / PackageSetBuilder.html
blob: 8ad851fce566c60da5f849b011bbad6958afbe43 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PackageSetBuilder (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PackageSetBuilder (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PackageSetBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/MarshalServiceRuntimeDescriptionImpl.html" title="class in org.apache.axis2.jaxws.runtime.description.marshal.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PropertyDescriptorMapBuilder.html" title="class in org.apache.axis2.jaxws.runtime.description.marshal.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html" target="_top">Frames</a></li>
<li><a href="PackageSetBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.axis2.jaxws.runtime.description.marshal.impl</div>
<h2 title="Class PackageSetBuilder" class="title">Class PackageSetBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.jaxws.runtime.description.marshal.impl.PackageSetBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">PackageSetBuilder</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">In order to marshal or unmarshal the user data, we need to know the set of packages involved.
The set of packages is used to construct an appropriate JAXBContext object during the
marshalling/unmarshalling.
<p/>
There are two ways to get this data.
<p/>
Schema Walk (preferred): Get the list of packages by walking the schemas that are referenced by
the wsdl (or generated wsdl). Each schema represents a different package. The package is
obtained using the jaxb customization or JAXB default ns<->package rule.
<p/>
Annotation Walk(secondary) : Walk the list of Endpoints, Operations, Parameters, etc. and build a
list of packages by looking at the classes involved.
<p/>
The Schema Walk is faster and more complete, but relies on the presence of the schema or wsdl.
<p/>
The Annotation Walk is slower and is not complete. For example, the annotation walk may not
discover the packages for derived types that are defined in a different schema than the formal
parameter types.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html#getPackageFromClass(java.lang.Class)">getPackageFromClass</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return the package associated with the class name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html#getPackageFromClassName(java.lang.String)">getPackageFromClassName</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;className)</code>
<div class="block">Return the package associated with the class name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TreeSet.html?is-external=true" title="class or interface in java.util">TreeSet</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html#getPackagesFromAnnotations(org.apache.axis2.jaxws.description.ServiceDescription, org.apache.axis2.jaxws.runtime.description.marshal.MarshalServiceRuntimeDescription)">getPackagesFromAnnotations</a></strong>(<a href="../../../../../../../../org/apache/axis2/jaxws/description/ServiceDescription.html" title="interface in org.apache.axis2.jaxws.description">ServiceDescription</a>&nbsp;serviceDesc,
<a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/MarshalServiceRuntimeDescription.html" title="interface in org.apache.axis2.jaxws.runtime.description.marshal">MarshalServiceRuntimeDescription</a>&nbsp;msrd)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/TreeSet.html?is-external=true" title="class or interface in java.util">TreeSet</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html#getPackagesFromSchema(org.apache.axis2.jaxws.description.ServiceDescription)">getPackagesFromSchema</a></strong>(<a href="../../../../../../../../org/apache/axis2/jaxws/description/ServiceDescription.html" title="interface in org.apache.axis2.jaxws.description">ServiceDescription</a>&nbsp;serviceDesc)</code>
<div class="block">Walks the schemas of the serviceDesc's wsdl (or generated wsdl) to determine the list of
packages.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPackagesFromSchema(org.apache.axis2.jaxws.description.ServiceDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPackagesFromSchema</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/TreeSet.html?is-external=true" title="class or interface in java.util">TreeSet</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getPackagesFromSchema(<a href="../../../../../../../../org/apache/axis2/jaxws/description/ServiceDescription.html" title="interface in org.apache.axis2.jaxws.description">ServiceDescription</a>&nbsp;serviceDesc)</pre>
<div class="block">Walks the schemas of the serviceDesc's wsdl (or generated wsdl) to determine the list of
packages. This is the preferred algorithm for discovering the package set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceDesc</code> - ServiceDescription</dd>
<dt><span class="strong">Returns:</span></dt><dd>Set of Packages</dd></dl>
</li>
</ul>
<a name="getPackagesFromAnnotations(org.apache.axis2.jaxws.description.ServiceDescription, org.apache.axis2.jaxws.runtime.description.marshal.MarshalServiceRuntimeDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPackagesFromAnnotations</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/TreeSet.html?is-external=true" title="class or interface in java.util">TreeSet</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getPackagesFromAnnotations(<a href="../../../../../../../../org/apache/axis2/jaxws/description/ServiceDescription.html" title="interface in org.apache.axis2.jaxws.description">ServiceDescription</a>&nbsp;serviceDesc,
<a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/MarshalServiceRuntimeDescription.html" title="interface in org.apache.axis2.jaxws.runtime.description.marshal">MarshalServiceRuntimeDescription</a>&nbsp;msrd)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceDescription</code> - ServiceDescription</dd>
<dt><span class="strong">Returns:</span></dt><dd>Set of Packages</dd></dl>
</li>
</ul>
<a name="getPackageFromClassName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPackageFromClassName</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPackageFromClassName(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;className)</pre>
<div class="block">Return the package associated with the class name. The className may not be specified (in
which case a null Package is returned).
If class has anunnamed package return ""</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>className</code> - String (may be null or empty)</dd>
<dt><span class="strong">Returns:</span></dt><dd>String or null if problems occur</dd></dl>
</li>
</ul>
<a name="getPackageFromClass(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPackageFromClass</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPackageFromClass(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return the package associated with the class name. The className may not be specified (in
which case a null Package is returned). if class has unnamed package return ""</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cls</code> - Class</dd>
<dt><span class="strong">Returns:</span></dt><dd>String or null</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PackageSetBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/MarshalServiceRuntimeDescriptionImpl.html" title="class in org.apache.axis2.jaxws.runtime.description.marshal.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../org/apache/axis2/jaxws/runtime/description/marshal/impl/PropertyDescriptorMapBuilder.html" title="class in org.apache.axis2.jaxws.runtime.description.marshal.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/axis2/jaxws/runtime/description/marshal/impl/PackageSetBuilder.html" target="_top">Frames</a></li>
<li><a href="PackageSetBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>