| <!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>TypeMappingRegistry (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="TypeMappingRegistry (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/TypeMappingRegistry.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/TypeMapping.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/XMLType.html" title="class 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/TypeMappingRegistry.html" target="_top">Frames</a></li> |
| <li><a href="TypeMappingRegistry.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 TypeMappingRegistry" class="title">Interface TypeMappingRegistry</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></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/axis/encoding/TypeMappingRegistry.html" title="interface in org.apache.axis.encoding">TypeMappingRegistry</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/axis/encoding/TypeMappingRegistryImpl.html" title="class in org.apache.axis.encoding">TypeMappingRegistryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TypeMappingRegistry</span> |
| extends <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">The interface <code>javax.xml.rpc.encoding.TypeMappingRegistry</code> |
| defines a registry of TypeMapping instances for various encoding |
| styles.</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"> </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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#clear()">clear</a></strong>()</code> |
| <div class="block">Removes all registered TypeMappings and encodingStyleURIs |
| from this TypeMappingRegistry.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#createTypeMapping()">createTypeMapping</a></strong>()</code> |
| <div class="block">Creates a new empty <code>TypeMapping</code> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#getDefaultTypeMapping()">getDefaultTypeMapping</a></strong>()</code> |
| <div class="block">Gets the registered default <code>TypeMapping</code> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/TypeMappingRegistry.html#getRegisteredEncodingStyleURIs()">getRegisteredEncodingStyleURIs</a></strong>()</code> |
| <div class="block">Returns a list of registered encodingStyle URIs in this |
| <code>TypeMappingRegistry</code> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#getTypeMapping(java.lang.String)">getTypeMapping</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> encodingStyleURI)</code> |
| <div class="block">Returns the registered <code>TypeMapping</code> for the specified |
| encodingStyle URI.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#register(java.lang.String,%20javax.xml.rpc.encoding.TypeMapping)">register</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> encodingStyleURI, |
| <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</code> |
| <div class="block">Registers a <code>TypeMapping</code> instance with the |
| <code>TypeMappingRegistry</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#registerDefault(javax.xml.rpc.encoding.TypeMapping)">registerDefault</a></strong>(<a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</code> |
| <div class="block">Registers the <code>TypeMapping</code> instance that is default |
| for all encoding styles supported by the |
| <code>TypeMappingRegistry</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#removeTypeMapping(javax.xml.rpc.encoding.TypeMapping)">removeTypeMapping</a></strong>(<a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</code> |
| <div class="block">Removes a <code>TypeMapping</code> from the TypeMappingRegistry.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#unregisterTypeMapping(java.lang.String)">unregisterTypeMapping</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> encodingStyleURI)</code> |
| <div class="block">Unregisters a TypeMapping instance, if present, from the specified |
| encodingStyleURI.</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="register(java.lang.String, javax.xml.rpc.encoding.TypeMapping)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> register(<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> encodingStyleURI, |
| <a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</pre> |
| <div class="block">Registers a <code>TypeMapping</code> instance with the |
| <code>TypeMappingRegistry</code>. This method replaces any |
| existing registered <code>TypeMapping</code> instance for |
| the specified <code>encodingStyleURI</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>encodingStyleURI</code> - An encoding style specified as an URI. |
| An example is "http://schemas.xmlsoap.org/soap/encoding/"</dd><dd><code>mapping</code> - TypeMapping instance</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Previous TypeMapping associated with the specified |
| <code>encodingStyleURI</code>, or <code>null</code> |
| if there was no TypeMapping associated with the specified |
| <code>encodingStyleURI</code></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 |
| the registration of the <code>TypeMapping</code> for |
| the specified <code>encodingStyleURI</code></dd></dl> |
| </li> |
| </ul> |
| <a name="registerDefault(javax.xml.rpc.encoding.TypeMapping)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerDefault</h4> |
| <pre>void registerDefault(<a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</pre> |
| <div class="block">Registers the <code>TypeMapping</code> instance that is default |
| for all encoding styles supported by the |
| <code>TypeMappingRegistry</code>. A default <code>TypeMapping</code> |
| should include serializers and deserializers that are independent |
| of and usable with any encoding style. Successive invocations |
| of the <code>registerDefault</code> method replace any existing |
| default <code>TypeMapping</code> instance. |
| <p> |
| If the default <code>TypeMapping</code> is registered, any |
| other TypeMapping instances registered through the |
| <code>TypeMappingRegistry.register</code> method (for a set |
| of encodingStyle URIs) override the default <code>TypeMapping</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mapping</code> - TypeMapping instance</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 the registration of the default |
| <code>TypeMapping</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getDefaultTypeMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultTypeMapping</h4> |
| <pre><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> getDefaultTypeMapping()</pre> |
| <div class="block">Gets the registered default <code>TypeMapping</code> instance. |
| This method returns <code>null</code> if there is no registered |
| default TypeMapping in the registry.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The registered default <code>TypeMapping</code> instance |
| or <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="getRegisteredEncodingStyleURIs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegisteredEncodingStyleURIs</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>[] getRegisteredEncodingStyleURIs()</pre> |
| <div class="block">Returns a list of registered encodingStyle URIs in this |
| <code>TypeMappingRegistry</code> instance.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Array of the registered encodingStyle URIs</dd></dl> |
| </li> |
| </ul> |
| <a name="getTypeMapping(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeMapping</h4> |
| <pre><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> getTypeMapping(<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> encodingStyleURI)</pre> |
| <div class="block">Returns the registered <code>TypeMapping</code> for the specified |
| encodingStyle URI. If there is no registered <code>TypeMapping</code> |
| for the specified <code>encodingStyleURI</code>, this method |
| returns <code>null</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>encodingStyleURI</code> - Encoding style specified as an URI</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>TypeMapping for the specified encodingStyleURI or |
| <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="createTypeMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTypeMapping</h4> |
| <pre><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> createTypeMapping()</pre> |
| <div class="block">Creates a new empty <code>TypeMapping</code> object.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>TypeMapping instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="unregisterTypeMapping(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterTypeMapping</h4> |
| <pre><a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> unregisterTypeMapping(<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> encodingStyleURI)</pre> |
| <div class="block">Unregisters a TypeMapping instance, if present, from the specified |
| encodingStyleURI.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>encodingStyleURI</code> - Encoding style specified as an URI</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>TypeMapping</code> instance that has been unregistered |
| or <code>null</code> if there was no TypeMapping |
| registered for the specified <code>encodingStyleURI</code></dd></dl> |
| </li> |
| </ul> |
| <a name="removeTypeMapping(javax.xml.rpc.encoding.TypeMapping)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTypeMapping</h4> |
| <pre>boolean removeTypeMapping(<a href="../../../../javax/xml/rpc/encoding/TypeMapping.html" title="interface in javax.xml.rpc.encoding">TypeMapping</a> mapping)</pre> |
| <div class="block">Removes a <code>TypeMapping</code> from the TypeMappingRegistry. A |
| <code>TypeMapping</code> is associated with 1 or more |
| encodingStyleURIs. This method unregisters the specified |
| <code>TypeMapping</code> instance from all associated |
| <code>encodingStyleURIs</code> and then removes this |
| TypeMapping instance from the registry.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mapping</code> - TypeMapping to remove</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if specified <code>TypeMapping</code> |
| is removed from the TypeMappingRegistry; <code>false</code> |
| if the specified <code>TypeMapping</code> was not in the |
| <code>TypeMappingRegistry</code></dd></dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>void clear()</pre> |
| <div class="block">Removes all registered TypeMappings and encodingStyleURIs |
| from this TypeMappingRegistry.</div> |
| </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/TypeMappingRegistry.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/TypeMapping.html" title="interface in javax.xml.rpc.encoding"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/XMLType.html" title="class 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/TypeMappingRegistry.html" target="_top">Frames</a></li> |
| <li><a href="TypeMappingRegistry.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 ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |