| <!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 CXF JavaDoc 3.1.0 API)</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 CXF JavaDoc 3.1.0 API)"; |
| } |
| //--> |
| </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 class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cxf/aegis/type/TypeCreator.html" title="interface in org.apache.cxf.aegis.type"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cxf/aegis/type/TypeUtil.html" title="class in org.apache.cxf.aegis.type"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/aegis/type/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">org.apache.cxf.aegis.type</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 Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/cxf/aegis/type/DefaultTypeMapping.html" title="class in org.apache.cxf.aegis.type">DefaultTypeMapping</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TypeMapping</span></pre> |
| <div class="block">Abstraction for the map between Java types (represented as |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect"><code>Type</code></a> and Aegis types.</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"> </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/7/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="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#getMappingIdentifierURI()">getMappingIdentifierURI</a></strong>()</code> |
| <div class="block">Each mapping has a URI that identifies it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#getType(javax.xml.namespace.QName)">getType</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#getType(java.lang.reflect.Type)">getType</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cxf/aegis/type/TypeCreator.html" title="interface in org.apache.cxf.aegis.type">TypeCreator</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#getTypeCreator()">getTypeCreator</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#getTypeQName(java.lang.reflect.Type)">getTypeQName</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> clazz)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#isRegistered(javax.xml.namespace.QName)">isRegistered</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType)</code> |
| <div class="block">Returns a flag indicating if this type mapping has a mapping for a particular |
| XML Schema QName.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#isRegistered(java.lang.reflect.Type)">isRegistered</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType)</code> |
| <div class="block">Returns a flag indicating if this type mapping has a mapping for a particular Java class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#register(org.apache.cxf.aegis.type.AegisType)">register</a></strong>(<a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</code> |
| <div class="block">Register a type that self-describes the schema type and the Java class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#register(java.lang.reflect.Type,%20javax.xml.namespace.QName,%20org.apache.cxf.aegis.type.AegisType)">register</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType, |
| <a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</code> |
| <div class="block">Register a type, manually specifying the java class, the schema type, |
| and the Aegis type object that provides serialization, deserialization, |
| and schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#removeType(org.apache.cxf.aegis.type.AegisType)">removeType</a></strong>(<a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/aegis/type/TypeMapping.html#setMappingIdentifierURI(java.lang.String)">setMappingIdentifierURI</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)</code> |
| <div class="block">This exists only to deal with an initialization order problem.</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="isRegistered(java.lang.reflect.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRegistered</h4> |
| <pre>boolean isRegistered(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType)</pre> |
| <div class="block">Returns a flag indicating if this type mapping has a mapping for a particular Java class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - the class.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there is a mapping for the type.</dd></dl> |
| </li> |
| </ul> |
| <a name="isRegistered(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRegistered</h4> |
| <pre>boolean isRegistered(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType)</pre> |
| <div class="block">Returns a flag indicating if this type mapping has a mapping for a particular |
| XML Schema QName.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>xmlType</code> - the QName.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there is a mapping for the type.</dd></dl> |
| </li> |
| </ul> |
| <a name="register(java.lang.reflect.Type, javax.xml.namespace.QName, org.apache.cxf.aegis.type.AegisType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>void register(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType, |
| <a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType, |
| <a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</pre> |
| <div class="block">Register a type, manually specifying the java class, the schema type, |
| and the Aegis type object that provides serialization, deserialization, |
| and schema.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaType</code> - Java class.</dd><dd><code>xmlType</code> - XML Schema type QName.</dd><dd><code>type</code> - Aegis type object.</dd></dl> |
| </li> |
| </ul> |
| <a name="register(org.apache.cxf.aegis.type.AegisType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>void register(<a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</pre> |
| <div class="block">Register a type that self-describes the schema type and the Java class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Aegis type object that</dd></dl> |
| </li> |
| </ul> |
| <a name="removeType(org.apache.cxf.aegis.type.AegisType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeType</h4> |
| <pre>void removeType(<a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> type)</pre> |
| </li> |
| </ul> |
| <a name="getType(java.lang.reflect.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre><a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> getType(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> javaType)</pre> |
| </li> |
| </ul> |
| <a name="getType(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre><a href="../../../../../org/apache/cxf/aegis/type/AegisType.html" title="class in org.apache.cxf.aegis.type">AegisType</a> getType(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> xmlType)</pre> |
| </li> |
| </ul> |
| <a name="getTypeQName(java.lang.reflect.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeQName</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> getTypeQName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a> clazz)</pre> |
| </li> |
| </ul> |
| <a name="getTypeCreator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeCreator</h4> |
| <pre><a href="../../../../../org/apache/cxf/aegis/type/TypeCreator.html" title="interface in org.apache.cxf.aegis.type">TypeCreator</a> getTypeCreator()</pre> |
| </li> |
| </ul> |
| <a name="getMappingIdentifierURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappingIdentifierURI</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMappingIdentifierURI()</pre> |
| <div class="block">Each mapping has a URI that identifies it. |
| The mapping for a service uses the service URI. |
| XML files can choose to only contribute mappings that match.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the URI.</dd></dl> |
| </li> |
| </ul> |
| <a name="setMappingIdentifierURI(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setMappingIdentifierURI</h4> |
| <pre>void setMappingIdentifierURI(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri)</pre> |
| <div class="block">This exists only to deal with an initialization order problem.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</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 class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/cxf/aegis/type/TypeCreator.html" title="interface in org.apache.cxf.aegis.type"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cxf/aegis/type/TypeUtil.html" title="class in org.apache.cxf.aegis.type"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cxf/aegis/type/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 ======= --> |
| <p class="legalCopy"><small>Apache CXF</small></p> |
| </body> |
| </html> |
