Google Git
Sign in
apache / axis-site / 3093048f5b6dcd87d976050a42adfd57786946ac / . / axis / java / apiDocs / javax / xml / rpc / encoding / TypeMapping.html
blob: 1eb1f4726d601dd817129a4ab4a91a9b6238ec13 [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="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/rpc/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">javax.xml.rpc.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 Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/axis/encoding/TypeMapping.html" title="interface in org.apache.axis.encoding">TypeMapping</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis/encoding/TypeMappingDelegate.html" title="class in org.apache.axis.encoding">TypeMappingDelegate</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TypeMapping</span></pre>
<div class="block">The <code>javax.xml.rpc.encoding.TypeMapping</code> is the base
interface for the representation of a type mapping. A TypeMapping
implementation class may support one or more encoding styles.
<p>
For its supported encoding styles, a TypeMapping instance
maintains a set of tuples of the type {Java type,
<code>SerializerFactory</code>,
<code>DeserializerFactory</code>, XML type}.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>1.0</dd></dl>
</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="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getDeserializer(java.lang.Class,%20javax.xml.namespace.QName)">getDeserializer</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)</code>
<div class="block">Gets the DeserializerFactory 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/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSerializer(java.lang.Class,%20javax.xml.namespace.QName)">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,
<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)</code>
<div class="block">Gets the SerializerFactory registered for the specified
pair of Java type and XML data type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/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="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSupportedEncodings()">getSupportedEncodings</a></strong>()</code>
<div class="block">Returns the encodingStyle URIs (as String[]) supported by
this TypeMapping instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#isRegistered(java.lang.Class,%20javax.xml.namespace.QName)">isRegistered</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)</code>
<div class="block">Checks whether or not type mapping between specified XML
type and Java type is registered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><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></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,
<a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a>&nbsp;sf,
<a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a>&nbsp;dsf)</code>
<div class="block">Registers SerializerFactory and DeserializerFactory for a
specific type mapping between an XML type and Java type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeDeserializer(java.lang.Class,%20javax.xml.namespace.QName)">removeDeserializer</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)</code>
<div class="block">Removes the DeserializerFactory registered for the specified
pair of Java type and XML data type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeSerializer(java.lang.Class,%20javax.xml.namespace.QName)">removeSerializer</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)</code>
<div class="block">Removes the SerializerFactory registered for the specified
pair of Java type and XML data type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#setSupportedEncodings(java.lang.String[])">setSupportedEncodings</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;encodingStyleURIs)</code>
<div class="block">Sets the encodingStyle URIs supported by this TypeMapping
instance.</div>
</td>
</tr>
</table>
</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="getSupportedEncodings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedEncodings</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getSupportedEncodings()</pre>
<div class="block">Returns the encodingStyle URIs (as String[]) supported by
this TypeMapping instance. A TypeMapping that contains only
encoding style independent serializers and deserializers
returns <code>null</code> from this method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Array of encodingStyle URIs for the supported
encoding styles</dd></dl>
</li>
</ul>
<a name="setSupportedEncodings(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSupportedEncodings</h4>
<pre>void&nbsp;setSupportedEncodings(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;encodingStyleURIs)</pre>
<div class="block">Sets the encodingStyle URIs supported by this TypeMapping
instance. A TypeMapping that contains only encoding
independent serializers and deserializers requires
<code>null</code> as the parameter for this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encodingStyleURIs</code> - Array of encodingStyle URIs for the
supported encoding styles</dd></dl>
</li>
</ul>
<a name="isRegistered(java.lang.Class, javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegistered</h4>
<pre>boolean&nbsp;isRegistered(<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)</pre>
<div class="block">Checks whether or not type mapping between specified XML
type and Java type is registered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - Class of the Java type</dd><dd><code>xmlType</code> - Qualified name of the XML data type</dd>
<dt><span class="strong">Returns:</span></dt><dd>boolean; <code>true</code> if type mapping between the
specified XML type and Java type is registered;
otherwise <code>false</code></dd></dl>
</li>
</ul>
<a name="register(java.lang.Class, javax.xml.namespace.QName, javax.xml.rpc.encoding.SerializerFactory, javax.xml.rpc.encoding.DeserializerFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>void&nbsp;register(<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,
<a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a>&nbsp;sf,
<a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a>&nbsp;dsf)</pre>
<div class="block">Registers SerializerFactory and DeserializerFactory for a
specific type mapping between an XML type and Java type.
This method replaces any existing registered SerializerFactory
DeserializerFactory instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - Class of the Java type</dd><dd><code>xmlType</code> - Qualified name of the XML data type</dd><dd><code>sf</code> - SerializerFactory</dd><dd><code>dsf</code> - 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 are any errors that
prevent registration</dd></dl>
</li>
</ul>
<a name="getSerializer(java.lang.Class, javax.xml.namespace.QName)">
<!-- -->
</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,
<a href="../../../../javax/xml/namespace/QName.html" title="class in javax.xml.namespace">QName</a>&nbsp;xmlType)</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><dd><code>xmlType</code> - Qualified name of the XML data type</dd>
<dt><span class="strong">Returns:</span></dt><dd>Registered SerializerFactory or <code>null</code>
if there is no registered factory</dd></dl>
</li>
</ul>
<a name="getDeserializer(java.lang.Class, 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="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)</pre>
<div class="block">Gets the DeserializerFactory 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><dd><code>xmlType</code> - Qualified name of the XML data type</dd>
<dt><span class="strong">Returns:</span></dt><dd>Registered SerializerFactory or <code>null</code>
if there is no registered factory</dd></dl>
</li>
</ul>
<a name="removeSerializer(java.lang.Class, javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSerializer</h4>
<pre>void&nbsp;removeSerializer(<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)</pre>
<div class="block">Removes 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><dd><code>xmlType</code> - Qualified name of the XML data type</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 any error that prevents
removal of the registered SerializerFactory</dd></dl>
</li>
</ul>
<a name="removeDeserializer(java.lang.Class, javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeDeserializer</h4>
<pre>void&nbsp;removeDeserializer(<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)</pre>
<div class="block">Removes the DeserializerFactory 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><dd><code>xmlType</code> - Qualified name of the XML data type</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 any error in removing
the registered DeserializerFactory</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="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/rpc/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>