| <!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>BlockFactory (Apache Axis2)</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="BlockFactory (Apache Axis2)"; |
| } |
| //--> |
| </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/BlockFactory.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/axis2/jaxws/message/factory/ClassFinderFactory.html" title="class in org.apache.axis2.jaxws.message.factory"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/axis2/jaxws/message/factory/BlockFactory.html" target="_top">Frames</a></li> |
| <li><a href="BlockFactory.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.axis2.jaxws.message.factory</div> |
| <h2 title="Interface BlockFactory" class="title">Interface BlockFactory</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/axis2/jaxws/message/factory/DataSourceBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">DataSourceBlockFactory</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/factory/JAXBBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">JAXBBlockFactory</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/factory/OMBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">OMBlockFactory</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/factory/SOAPEnvelopeBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">SOAPEnvelopeBlockFactory</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/factory/SourceBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">SourceBlockFactory</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/factory/XMLStringBlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">XMLStringBlockFactory</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.impl">BlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/DataSourceBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">DataSourceBlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/JAXBBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">JAXBBlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/OMBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">OMBlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/SOAPEnvelopeBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SOAPEnvelopeBlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/SourceBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SourceBlockFactoryImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/XMLStringBlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">XMLStringBlockFactoryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">BlockFactory</span></pre> |
| <div class="block">BlockFactory |
| <p/> |
| Interface to create Block objects An object is created from either a reader, another Block or the |
| BusinessObject. Some business objects (like JAXB) have an associated context object |
| (JAXBContext), these are also passed to the createMethods. |
| <p/> |
| The implementation of BlockFactories should always be singleton objects and never carry any |
| instance data. |
| <p/> |
| The FactoryRegistry should be used to get access to a Factory</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/axis2/jaxws/registry/FactoryRegistry.html" title="class in org.apache.axis2.jaxws.registry"><code>FactoryRegistry</code></a></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><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html#createFrom(org.apache.axis2.jaxws.message.Block, java.lang.Object)">createFrom</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> other, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context)</code> |
| <div class="block">createBlock from another Block If the other Block was created with the same factory and has the |
| same context, the other Block is returned.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html#createFrom(java.lang.Object, java.lang.Object, javax.xml.namespace.QName)">createFrom</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> businessObject, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName)</code> |
| <div class="block">Create from business object</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html#createFrom(org.apache.axiom.om.OMElement, java.lang.Object, javax.xml.namespace.QName)">createFrom</a></strong>(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a> omElement, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName)</code> |
| <div class="block">createBlock from XMLStreamReader</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html#createFrom(javax.xml.stream.XMLStreamReader, java.lang.Object, javax.xml.namespace.QName)">createFrom</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</a> reader, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName)</code> |
| <div class="block">createBlock from XMLStreamReader</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html#isElement()">isElement</a></strong>()</code> </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="createFrom(javax.xml.stream.XMLStreamReader, java.lang.Object, javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFrom</h4> |
| <pre><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> createFrom(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</a> reader, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName) |
| throws <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a>, |
| <a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre> |
| <div class="block">createBlock from XMLStreamReader</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - XMLStreamReader</dd><dd><code>context</code> - Associated Context or null</dd><dd><code>QName</code> - must be supplied if known</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createFrom(org.apache.axiom.om.OMElement, java.lang.Object, javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFrom</h4> |
| <pre><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> createFrom(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a> omElement, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName) |
| throws <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a>, |
| <a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre> |
| <div class="block">createBlock from XMLStreamReader</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>omElement</code> - OMElement</dd><dd><code>context</code> - Associated Context or null</dd><dd><code>QName</code> - must be supplied if known</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createFrom(org.apache.axis2.jaxws.message.Block, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFrom</h4> |
| <pre><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> createFrom(<a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> other, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context) |
| throws <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a>, |
| <a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre> |
| <div class="block">createBlock from another Block If the other Block was created with the same factory and has the |
| same context, the other Block is returned. If the other Block was created by a different factory |
| or diffent context, a new block is returned (and the other block is consumed)</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Block</dd><dd><code>context</code> - Associated Context or null</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createFrom(java.lang.Object, java.lang.Object, javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFrom</h4> |
| <pre><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> createFrom(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> businessObject, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> context, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a> qName) |
| throws <a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></pre> |
| <div class="block">Create from business object</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>businessObject</code> - </dd><dd><code>context</code> - Associated Context or null</dd><dd><code>QName</code> - must be supplied if known</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="isElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isElement</h4> |
| <pre>boolean isElement()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if business object must be rendered as an element |
| example JAXBFactory ...true |
| example SourceFactory...false</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/BlockFactory.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/axis2/jaxws/message/factory/ClassFinderFactory.html" title="class in org.apache.axis2.jaxws.message.factory"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/axis2/jaxws/message/factory/BlockFactory.html" target="_top">Frames</a></li> |
| <li><a href="BlockFactory.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="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |