blob: 9771888355b059b2b22a57c2eac6c5c74436c02e [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>TypeMapping (Apache Axis)</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="TypeMapping (Apache Axis)";
}
//-->
</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/TypeMapping.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/axis/encoding/TextSerializationContext.html" title="class in org.apache.axis.encoding"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/encoding/TypeMappingDelegate.html" title="class in org.apache.axis.encoding"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/encoding/TypeMapping.html" target="_top">Frames</a></li>
<li><a href="TypeMapping.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.axis.encoding</div>
<h2 title="Interface TypeMapping" class="title">Interface TypeMapping</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TypeMapping</span>
extends <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">This interface describes the AXIS TypeMapping.</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><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getAllClasses()">getAllClasses</a></strong>()</code>
<div class="block">Returns an array of all the classes contained within this mapping</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getClassForQName(javax.xml.namespace.QName)">getClassForQName</a></strong>(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)</code>
<div class="block">Gets the Class mapped to QName.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getClassForQName(javax.xml.namespace.QName,%20java.lang.Class)">getClassForQName</a></strong>(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getDeserializer(javax.xml.namespace.QName)">getDeserializer</a></strong>(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)</code>
<div class="block">Gets the DeserializerFactory registered for the specified XML data type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getSerializer(java.lang.Class)">getSerializer</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</code>
<div class="block">Gets the SerializerFactory registered for the specified pair
of Java type and XML data type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getTypeQName(java.lang.Class)">getTypeQName</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</code>
<div class="block">Gets the QName for the type mapped to Class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getTypeQNameExact(java.lang.Class)">getTypeQNameExact</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</code>
<div class="block">Get the QName for this Java class, but only return a specific
mapping if there is one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis/encoding/TypeMapping.html#getXMLType(java.lang.Class,%20javax.xml.namespace.QName,%20boolean)">getXMLType</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType,
<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType,
boolean&nbsp;encoded)</code>
<div class="block">Get the exact XML type QName which will be used when serializing a
given Class to a given type QName.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.xml.rpc.encoding.TypeMapping">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.rpc.encoding.<a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></h3>
<code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getDeserializer(java.lang.Class,%20javax.xml.namespace.QName)">getDeserializer</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSerializer(java.lang.Class,%20javax.xml.namespace.QName)">getSerializer</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSupportedEncodings()">getSupportedEncodings</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#isRegistered(java.lang.Class,%20javax.xml.namespace.QName)">isRegistered</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#register(java.lang.Class,%20javax.xml.namespace.QName,%20javax.xml.rpc.encoding.SerializerFactory,%20javax.xml.rpc.encoding.DeserializerFactory)">register</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeDeserializer(java.lang.Class,%20javax.xml.namespace.QName)">removeDeserializer</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeSerializer(java.lang.Class,%20javax.xml.namespace.QName)">removeSerializer</a>, <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#setSupportedEncodings(java.lang.String[])">setSupportedEncodings</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="getSerializer(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSerializer</h4>
<pre><a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a>&nbsp;getSerializer(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)
throws <a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></pre>
<div class="block">Gets the SerializerFactory registered for the specified pair
of Java type and XML data type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - - Class of the Java type</dd>
<dt><span class="strong">Returns:</span></dt><dd>Registered SerializerFactory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - - If there is no registered SerializerFactory
for this pair of Java type and XML data type
java.lang.IllegalArgumentException
If invalid or unsupported XML/Java type is specified</dd></dl>
</li>
</ul>
<a name="getDeserializer(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeserializer</h4>
<pre><a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a>&nbsp;getDeserializer(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)
throws <a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></pre>
<div class="block">Gets the DeserializerFactory registered for the specified XML data type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlType</code> - - Qualified name of the XML data type</dd>
<dt><span class="strong">Returns:</span></dt><dd>Registered DeserializerFactory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - - If there is no registered DeserializerFactory
for this pair of Java type and XML data type
java.lang.IllegalArgumentException -
If invalid or unsupported XML/Java type is specified</dd></dl>
</li>
</ul>
<a name="getTypeQName(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeQName</h4>
<pre><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;getTypeQName(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</pre>
<div class="block">Gets the QName for the type mapped to Class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - class or type</dd>
<dt><span class="strong">Returns:</span></dt><dd>xmlType qname or null</dd></dl>
</li>
</ul>
<a name="getTypeQNameExact(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeQNameExact</h4>
<pre><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;getTypeQNameExact(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</pre>
<div class="block">Get the QName for this Java class, but only return a specific
mapping if there is one. In other words, don't do special array
processing, etc.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getClassForQName(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassForQName</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getClassForQName(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)</pre>
<div class="block">Gets the Class mapped to QName.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlType</code> - qname or null</dd>
<dt><span class="strong">Returns:</span></dt><dd>javaType class for type or null for no mapping</dd></dl>
</li>
</ul>
<a name="getClassForQName(javax.xml.namespace.QName, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassForQName</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getClassForQName(<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType)</pre>
</li>
</ul>
<a name="getAllClasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllClasses</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]&nbsp;getAllClasses()</pre>
<div class="block">Returns an array of all the classes contained within this mapping</div>
</li>
</ul>
<a name="getXMLType(java.lang.Class, javax.xml.namespace.QName, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getXMLType</h4>
<pre><a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;getXMLType(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;javaType,
<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType,
boolean&nbsp;encoded)
throws <a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></pre>
<div class="block">Get the exact XML type QName which will be used when serializing a
given Class to a given type QName. In other words, if we have:
Class TypeQName
----------------------
Base myNS:Base
Child myNS:Child
and call getXMLType(Child.class, BASE_QNAME), we should get
CHILD_QNAME.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - </dd><dd><code>xmlType</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the type's QName</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code></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/TypeMapping.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/axis/encoding/TextSerializationContext.html" title="class in org.apache.axis.encoding"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis/encoding/TypeMappingDelegate.html" title="class in org.apache.axis.encoding"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis/encoding/TypeMapping.html" target="_top">Frames</a></li>
<li><a href="TypeMapping.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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>