| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TypeMapping</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TypeMapping"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html" title="interface in javax.xml.rpc.encoding"><span class="typeNameLink">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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">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> |
| </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getDeserializer-java.lang.Class-javax.xml.namespace.QName-">getDeserializer</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType)</code> |
| <div class="block">Gets the DeserializerFactory registered for the specified |
| pair of Java type and XML data type.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSerializer-java.lang.Class-javax.xml.namespace.QName-">getSerializer</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType)</code> |
| <div class="block">Gets the SerializerFactory registered for the specified |
| pair of Java type and XML data type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#getSupportedEncodings--">getSupportedEncodings</a></span>()</code> |
| <div class="block">Returns the encodingStyle URIs (as String[]) supported by |
| this TypeMapping instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#isRegistered-java.lang.Class-javax.xml.namespace.QName-">isRegistered</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType)</code> |
| <div class="block">Checks whether or not type mapping between specified XML |
| type and Java type is registered.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#register-java.lang.Class-javax.xml.namespace.QName-javax.xml.rpc.encoding.SerializerFactory-javax.xml.rpc.encoding.DeserializerFactory-">register</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType, |
| <a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a> sf, |
| <a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a> 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 id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeDeserializer-java.lang.Class-javax.xml.namespace.QName-">removeDeserializer</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType)</code> |
| <div class="block">Removes the DeserializerFactory registered for the specified |
| pair of Java type and XML data type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#removeSerializer-java.lang.Class-javax.xml.namespace.QName-">removeSerializer</a></span>(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType)</code> |
| <div class="block">Removes the SerializerFactory registered for the specified |
| pair of Java type and XML data type.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html#setSupportedEncodings-java.lang.String:A-">setSupportedEncodings</a></span>(java.lang.String[] 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>java.lang.String[] 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="returnLabel">Returns:</span></dt> |
| <dd>Array of encodingStyle URIs for the supported |
| encoding styles</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSupportedEncodings-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSupportedEncodings</h4> |
| <pre>void setSupportedEncodings(java.lang.String[] 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="paramLabel">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 isRegistered(java.lang.Class javaType, |
| javax.xml.namespace.QName 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="paramLabel">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="returnLabel">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 register(java.lang.Class javaType, |
| javax.xml.namespace.QName xmlType, |
| <a href="../../../../javax/xml/rpc/encoding/SerializerFactory.html" title="interface in javax.xml.rpc.encoding">SerializerFactory</a> sf, |
| <a href="../../../../javax/xml/rpc/encoding/DeserializerFactory.html" title="interface in javax.xml.rpc.encoding">DeserializerFactory</a> 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="paramLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - If any error during the 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> getSerializer(java.lang.Class javaType, |
| javax.xml.namespace.QName 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="paramLabel">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="returnLabel">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> getDeserializer(java.lang.Class javaType, |
| javax.xml.namespace.QName 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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>Registered DeserializerFactory 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 removeSerializer(java.lang.Class javaType, |
| javax.xml.namespace.QName 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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - If there is error in removing 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 removeDeserializer(java.lang.Class javaType, |
| javax.xml.namespace.QName 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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - If there is 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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html" title="interface in javax.xml.rpc.encoding"><span class="typeNameLink">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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |