| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TypeMappingRegistry</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="TypeMappingRegistry"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/TypeMapping.html" title="interface in javax.xml.rpc.encoding"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/XMLType.html" title="class 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/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>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TypeMappingRegistry</span> |
| extends java.io.Serializable</pre> |
| <div class="block">The interface <code>javax.xml.rpc.encoding.TypeMappingRegistry</code> |
| defines a registry of TypeMapping instances for various encoding |
| styles.</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#clear--">clear</a></span>()</code> |
| <div class="block">Removes all registered TypeMappings and encodingStyleURIs |
| from this TypeMappingRegistry.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#createTypeMapping--">createTypeMapping</a></span>()</code> |
| <div class="block">Creates a new empty <code>TypeMapping</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#getDefaultTypeMapping--">getDefaultTypeMapping</a></span>()</code> |
| <div class="block">Gets the registered default <code>TypeMapping</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#getRegisteredEncodingStyleURIs--">getRegisteredEncodingStyleURIs</a></span>()</code> |
| <div class="block">Returns a list of registered encodingStyle URIs in this |
| <code>TypeMappingRegistry</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#getTypeMapping-java.lang.String-">getTypeMapping</a></span>(java.lang.String encodingStyleURI)</code> |
| <div class="block">Returns the registered <code>TypeMapping</code> for the specified |
| encodingStyle URI.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#register-java.lang.String-javax.xml.rpc.encoding.TypeMapping-">register</a></span>(java.lang.String 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 id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#registerDefault-javax.xml.rpc.encoding.TypeMapping-">registerDefault</a></span>(<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 id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#removeTypeMapping-javax.xml.rpc.encoding.TypeMapping-">removeTypeMapping</a></span>(<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 id="i8" 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><span class="memberNameLink"><a href="../../../../javax/xml/rpc/encoding/TypeMappingRegistry.html#unregisterTypeMapping-java.lang.String-">unregisterTypeMapping</a></span>(java.lang.String 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(java.lang.String 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="paramLabel">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="returnLabel">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="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 an error in 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="paramLabel">Parameters:</span></dt> |
| <dd><code>mapping</code> - TypeMapping instance</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 there is an error in 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="returnLabel">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>java.lang.String[] getRegisteredEncodingStyleURIs()</pre> |
| <div class="block">Returns a list of registered encodingStyle URIs in this |
| <code>TypeMappingRegistry</code> instance.</div> |
| <dl> |
| <dt><span class="returnLabel">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(java.lang.String 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="paramLabel">Parameters:</span></dt> |
| <dd><code>encodingStyleURI</code> - Encoding style specified as an URI</dd> |
| <dt><span class="returnLabel">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="returnLabel">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(java.lang.String encodingStyleURI)</pre> |
| <div class="block">Unregisters a TypeMapping instance, if present, from the |
| specified encodingStyleURI.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodingStyleURI</code> - Encoding style specified as an URI</dd> |
| <dt><span class="returnLabel">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="paramLabel">Parameters:</span></dt> |
| <dd><code>mapping</code> - TypeMapping to be removed</dd> |
| <dt><span class="returnLabel">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> |
| <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/TypeMapping.html" title="interface in javax.xml.rpc.encoding"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/rpc/encoding/XMLType.html" title="class 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/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 ======= --> |
| </body> |
| </html> |