| <!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>BlockImpl (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="BlockImpl (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/BlockImpl.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="../../../../../../org/apache/axis2/jaxws/message/impl/BlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.impl"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/axis2/jaxws/message/impl/MessageFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.impl"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/axis2/jaxws/message/impl/BlockImpl.html" target="_top">Frames</a></li> |
| <li><a href="BlockImpl.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.impl</div> |
| <h2 title="Class BlockImpl" class="title">Class BlockImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.axis2.jaxws.message.impl.BlockImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/DataSourceBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">DataSourceBlockImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/JAXBBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">JAXBBlockImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/OMBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">OMBlockImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/SOAPEnvelopeBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SOAPEnvelopeBlockImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/SourceBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SourceBlockImpl</a>, <a href="../../../../../../org/apache/axis2/jaxws/message/databinding/impl/XMLStringBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">XMLStringBlockImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">BlockImpl</span> |
| extends <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> |
| implements <a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></pre> |
| <div class="block">BlockImpl Abstract Base class for various Block Implementations. |
| <p/> |
| The base class takes care of controlling the transformations between BusinessObject, |
| XMLStreamReader and SOAPElement A derived class must minimally define the following: |
| _getBOFromReader _getReaderFromBO _outputFromBO |
| <p/> |
| In addtion, the derived class may want to override the following: _getBOFromBO ...if the |
| BusinessObject is consumed when read (i.e. it is an InputSource) |
| <p/> |
| The derived classes don't have direct access to the instance data. This ensures that BlockImpl |
| controls the transformations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#busContext">busContext</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#busObject">busObject</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#consumed">consumed</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#factory">factory</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#omElement">omElement</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#parent">parent</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#qName">qName</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.axiom.om.OMDataSourceExt"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.axiom.om.<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></h3> |
| <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#LOSSY_PREFIX" title="class or interface in org.apache.axiom.om">LOSSY_PREFIX</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#BlockImpl(java.lang.Object, java.lang.Object, javax.xml.namespace.QName, org.apache.axis2.jaxws.message.factory.BlockFactory)">BlockImpl</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> busObject, |
| <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> busContext, |
| <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, |
| <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory)</code> |
| <div class="block">A Block has the following components</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#BlockImpl(org.apache.axiom.om.OMElement, java.lang.Object, javax.xml.namespace.QName, org.apache.axis2.jaxws.message.factory.BlockFactory)">BlockImpl</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> busContext, |
| <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, |
| <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory)</code> |
| <div class="block">A Block has the following components</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_getBOFromBO(java.lang.Object, java.lang.Object, boolean)">_getBOFromBO</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> busObject, |
| <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> busContext, |
| boolean consume)</code> |
| <div class="block">The default implementation is to return the business object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_getBOFromOM(org.apache.axiom.om.OMElement, java.lang.Object)">_getBOFromOM</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> busContext)</code> |
| <div class="block">Default method for getting business object from OM.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected abstract <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_getBOFromReader(javax.xml.stream.XMLStreamReader, java.lang.Object)">_getBOFromReader</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> busContext)</code> |
| <div class="block">The derived class must provide an implementation that builds the business object from the |
| reader</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_getOMFromBO(java.lang.Object, java.lang.Object)">_getOMFromBO</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> busObject, |
| <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> busContext)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected abstract <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_getReaderFromBO(java.lang.Object, java.lang.Object)">_getReaderFromBO</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> busObj, |
| <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> busContext)</code> |
| <div class="block">Get an XMLStreamReader for the BusinessObject The derived Block must implement this method</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_outputFromBO(java.lang.Object, java.lang.Object, javax.xml.stream.XMLStreamWriter)">_outputFromBO</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> busObject, |
| <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> busContext, |
| <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer)</code> |
| <div class="block">Output BusinessObject contents to a Writer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_outputFromOM(org.apache.axiom.om.OMElement, javax.xml.stream.XMLStreamWriter, boolean)">_outputFromOM</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/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer, |
| boolean consume)</code> |
| <div class="block">Output OMElement contents to a Writer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_outputFromReader(javax.xml.stream.XMLStreamReader, javax.xml.stream.XMLStreamWriter)">_outputFromReader</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/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer)</code> |
| <div class="block">Output Reader contents to a Writer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_postPivot_getXMLStreamReader()">_postPivot_getXMLStreamReader</a></strong>()</code> |
| <div class="block">Called if we have passed the pivot point but someone wants to output the block.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#_postPivot_outputTo(javax.xml.stream.XMLStreamWriter)">_postPivot_outputTo</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer)</code> |
| <div class="block">Called if we have passed the pivot point but someone wants to output the block.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#copy()">copy</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getBlockFactory()">getBlockFactory</a></strong>()</code> |
| <div class="block">Get BlockFactory</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getBusinessContext()">getBusinessContext</a></strong>()</code> |
| <div class="block">GetBusinesContext Some business objects have an associated context object (i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getBusinessObject(boolean)">getBusinessObject</a></strong>(boolean consume)</code> |
| <div class="block">Get a reference to the Business Object represented by this Block</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getOMElement()">getOMElement</a></strong>()</code> |
| <div class="block">Get the OMElement represented by this Block.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getParent()">getParent</a></strong>()</code> |
| <div class="block">Get the Message associated with this block</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getProperty(java.lang.String)">getProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getQName()">getQName</a></strong>()</code> |
| <div class="block">Get the QName (namespace, localpart) of the Block.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getReader()">getReader</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#getXMLStreamReader(boolean)">getXMLStreamReader</a></strong>(boolean consume)</code> |
| <div class="block">Get the XMLStreamReader represented by this Block</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/impl/BlockImpl.html#hasProperty(java.lang.String)">hasProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#isBusinessObject()">isBusinessObject</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#isConsumed()">isConsumed</a></strong>()</code> |
| <div class="block">isConsumed Return true if the block is consumed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#isQNameAvailable()">isQNameAvailable</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#outputTo(javax.xml.stream.XMLStreamWriter, boolean)">outputTo</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer, |
| boolean consume)</code> |
| <div class="block">Write out the Block</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#serialize(java.io.OutputStream, org.apache.axiom.om.OMOutputFormat)">serialize</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output, |
| <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMOutputFormat.html?is-external=true" title="class or interface in org.apache.axiom.om">OMOutputFormat</a> format)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#serialize(java.io.Writer, org.apache.axiom.om.OMOutputFormat)">serialize</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writerTarget, |
| <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMOutputFormat.html?is-external=true" title="class or interface in org.apache.axiom.om">OMOutputFormat</a> format)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#serialize(javax.xml.stream.XMLStreamWriter)">serialize</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#setConsumed(boolean)">setConsumed</a></strong>(boolean consume)</code> |
| <div class="block">Once consumed, all instance data objects are nullified to prevent subsequent access</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> p)</code> |
| <div class="block">Set the Message associated with this block (This method is intended to be called by the |
| Message Implementation only)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#setProperty(java.lang.String, java.lang.Object)">setProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <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> value)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/message/impl/BlockImpl.html#setQName(javax.xml.namespace.QName)">setQName</a></strong>(<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">This method is intended for derived objects to set the qName</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/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/axis2/jaxws/message/impl/BlockImpl.html#traceString(java.lang.String)">traceString</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indent)</code> |
| <div class="block">Get a traceString...the trace string dumps the contents of the Block without forcing an |
| underlying ill-performant transformation of the message.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.jaxws.message.Block"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axis2.jaxws.message.<a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></h3> |
| <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#isElementData()">isElementData</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.axiom.om.OMDataSourceExt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axiom.om.<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></h3> |
| <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#close()" title="class or interface in org.apache.axiom.om">close</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#getObject()" title="class or interface in org.apache.axiom.om">getObject</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#getXMLBytes(java.lang.String)" title="class or interface in org.apache.axiom.om">getXMLBytes</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#getXMLInputStream(java.lang.String)" title="class or interface in org.apache.axiom.om">getXMLInputStream</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#isDestructiveRead()" title="class or interface in org.apache.axiom.om">isDestructiveRead</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#isDestructiveWrite()" title="class or interface in org.apache.axiom.om">isDestructiveWrite</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="busObject"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>busObject</h4> |
| <pre>protected <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> busObject</pre> |
| </li> |
| </ul> |
| <a name="busContext"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>busContext</h4> |
| <pre>protected <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> busContext</pre> |
| </li> |
| </ul> |
| <a name="omElement"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>omElement</h4> |
| <pre>protected <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</pre> |
| </li> |
| </ul> |
| <a name="qName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>qName</h4> |
| <pre>protected <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</pre> |
| </li> |
| </ul> |
| <a name="factory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>factory</h4> |
| <pre>protected <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory</pre> |
| </li> |
| </ul> |
| <a name="consumed"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consumed</h4> |
| <pre>protected boolean consumed</pre> |
| </li> |
| </ul> |
| <a name="parent"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parent</h4> |
| <pre>protected <a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> parent</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BlockImpl(java.lang.Object, java.lang.Object, javax.xml.namespace.QName, org.apache.axis2.jaxws.message.factory.BlockFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BlockImpl</h4> |
| <pre>protected BlockImpl(<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> busObject, |
| <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> busContext, |
| <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, |
| <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory)</pre> |
| <div class="block">A Block has the following components</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>busObject</code> - </dd><dd><code>busContext</code> - or null</dd><dd><code>qName</code> - or null if unknown</dd><dd><code>factory</code> - that creates the Block</dd></dl> |
| </li> |
| </ul> |
| <a name="BlockImpl(org.apache.axiom.om.OMElement, java.lang.Object, javax.xml.namespace.QName, org.apache.axis2.jaxws.message.factory.BlockFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BlockImpl</h4> |
| <pre>protected BlockImpl(<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> busContext, |
| <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, |
| <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory)</pre> |
| <div class="block">A Block has the following components</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - </dd><dd><code>busContext</code> - or null</dd><dd><code>qName</code> - or null if unknown</dd><dd><code>factory</code> - that creates the Block</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBlockFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlockFactory</h4> |
| <pre>public <a href="../../../../../../org/apache/axis2/jaxws/message/factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> getBlockFactory()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBlockFactory()">Block</a></code></strong></div> |
| <div class="block">Get BlockFactory</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBlockFactory()">getBlockFactory</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>BlockFactory that created the Block</dd></dl> |
| </li> |
| </ul> |
| <a name="getBusinessContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBusinessContext</h4> |
| <pre>public <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> getBusinessContext()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBusinessContext()">Block</a></code></strong></div> |
| <div class="block">GetBusinesContext Some business objects have an associated context object (i.e. JAXBContext)</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBusinessContext()">getBusinessContext</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Context Object or null</dd></dl> |
| </li> |
| </ul> |
| <a name="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre>public <a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> getParent()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getParent()">Block</a></code></strong></div> |
| <div class="block">Get the Message associated with this block</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getParent()">getParent</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Message</dd></dl> |
| </li> |
| </ul> |
| <a name="setParent(org.apache.axis2.jaxws.message.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParent</h4> |
| <pre>public void setParent(<a href="../../../../../../org/apache/axis2/jaxws/message/Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> p)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#setParent(org.apache.axis2.jaxws.message.Message)">Block</a></code></strong></div> |
| <div class="block">Set the Message associated with this block (This method is intended to be called by the |
| Message Implementation only)</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBusinessObject(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBusinessObject</h4> |
| <pre>public <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> getBusinessObject(boolean consume) |
| 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"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBusinessObject(boolean)">Block</a></code></strong></div> |
| <div class="block">Get a reference to the Business Object represented by this Block</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getBusinessObject(boolean)">getBusinessObject</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>consume</code> - true if this is the last request on the block.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Object (JAXB, String etc.)</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="getQName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQName</h4> |
| <pre>public <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> getQName() |
| 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"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getQName()">Block</a></code></strong></div> |
| <div class="block">Get the QName (namespace, localpart) of the Block. Do not depend on prefix being set correctly. |
| Asking for the QName can cause a performant hit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getQName()">getQName</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>QName of the block</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <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><dt><span class="strong">See Also:</span></dt><dd><code>isQNameAvailable</code></dd></dl> |
| </li> |
| </ul> |
| <a name="setQName(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQName</h4> |
| <pre>protected void setQName(<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)</pre> |
| <div class="block">This method is intended for derived objects to set the qName</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>qName</code> - </dd></dl> |
| </li> |
| </ul> |
| <a name="getXMLStreamReader(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLStreamReader</h4> |
| <pre>public <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> getXMLStreamReader(boolean consume) |
| 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"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getXMLStreamReader(boolean)">Block</a></code></strong></div> |
| <div class="block">Get the XMLStreamReader represented by this Block</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getXMLStreamReader(boolean)">getXMLStreamReader</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>consume</code> - true if this is the last request on the block.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>XMLStreamReader</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="getReader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <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> getReader() |
| 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></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true#getReader()" title="class or interface in org.apache.axiom.om">getReader</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a></code></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></dl> |
| </li> |
| </ul> |
| <a name="serialize(java.io.OutputStream, org.apache.axiom.om.OMOutputFormat)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>public void serialize(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output, |
| <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMOutputFormat.html?is-external=true" title="class or interface in org.apache.axiom.om">OMOutputFormat</a> format) |
| 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></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true#serialize(java.io.OutputStream, org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om">serialize</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a></code></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></dl> |
| </li> |
| </ul> |
| <a name="serialize(java.io.Writer, org.apache.axiom.om.OMOutputFormat)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>public void serialize(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writerTarget, |
| <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMOutputFormat.html?is-external=true" title="class or interface in org.apache.axiom.om">OMOutputFormat</a> format) |
| 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></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true#serialize(java.io.Writer, org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om">serialize</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a></code></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></dl> |
| </li> |
| </ul> |
| <a name="serialize(javax.xml.stream.XMLStreamWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>public void serialize(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer) |
| 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></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true#serialize(javax.xml.stream.XMLStreamWriter)" title="class or interface in org.apache.axiom.om">serialize</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a></code></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></dl> |
| </li> |
| </ul> |
| <a name="getOMElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOMElement</h4> |
| <pre>public <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> getOMElement() |
| 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"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getOMElement()">Block</a></code></strong></div> |
| <div class="block">Get the OMElement represented by this Block. This call always consumes the block because you are |
| taking control of the underlying OM</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#getOMElement()">getOMElement</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd></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="isConsumed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConsumed</h4> |
| <pre>public boolean isConsumed()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#isConsumed()">Block</a></code></strong></div> |
| <div class="block">isConsumed Return true if the block is consumed. Once consumed, the information in the block |
| is no longer available.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#isConsumed()">isConsumed</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the block is consumed (a method was called with consume=true)</dd></dl> |
| </li> |
| </ul> |
| <a name="setConsumed(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConsumed</h4> |
| <pre>public void setConsumed(boolean consume)</pre> |
| <div class="block">Once consumed, all instance data objects are nullified to prevent subsequent access</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>consume</code> - </dd></dl> |
| </li> |
| </ul> |
| <a name="isQNameAvailable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isQNameAvailable</h4> |
| <pre>public boolean isQNameAvailable()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#isQNameAvailable()">isQNameAvailable</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>If QName is available without doing an expensive parse of the business object, then |
| return true Otherwise return false Note: This method should be used in situations where |
| it would be nice to know the qname (like logging or a special check) but we don't want |
| to cause an ill-performant parse.</dd></dl> |
| </li> |
| </ul> |
| <a name="outputTo(javax.xml.stream.XMLStreamWriter, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputTo</h4> |
| <pre>public void outputTo(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer, |
| boolean consume) |
| 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"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#outputTo(javax.xml.stream.XMLStreamWriter, boolean)">Block</a></code></strong></div> |
| <div class="block">Write out the Block</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#outputTo(javax.xml.stream.XMLStreamWriter, boolean)">outputTo</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - XMLStreamWriter</dd><dd><code>consume</code> - true if this is the last request on the block.</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="_postPivot_outputTo(javax.xml.stream.XMLStreamWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_postPivot_outputTo</h4> |
| <pre>protected void _postPivot_outputTo(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer) |
| 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">Called if we have passed the pivot point but someone wants to output the block. The actual |
| block implementation may choose to override this setting</div> |
| <dl><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="_postPivot_getXMLStreamReader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_postPivot_getXMLStreamReader</h4> |
| <pre>protected <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> _postPivot_getXMLStreamReader() |
| 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">Called if we have passed the pivot point but someone wants to output the block. The actual |
| block implementation may choose to override this setting.</div> |
| <dl><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="isBusinessObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBusinessObject</h4> |
| <pre>protected boolean isBusinessObject()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if the representation of the block is currently a business object. Derived classes |
| may use this information to get information in a performant way.</dd></dl> |
| </li> |
| </ul> |
| <a name="traceString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traceString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> traceString(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> indent)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#traceString(java.lang.String)">Block</a></code></strong></div> |
| <div class="block">Get a traceString...the trace string dumps the contents of the Block without forcing an |
| underlying ill-performant transformation of the message.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html#traceString(java.lang.String)">traceString</a></code> in interface <code><a href="../../../../../../org/apache/axis2/jaxws/message/Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>String containing trace information</dd></dl> |
| </li> |
| </ul> |
| <a name="_getBOFromBO(java.lang.Object, java.lang.Object, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_getBOFromBO</h4> |
| <pre>protected <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> _getBOFromBO(<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> busObject, |
| <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> busContext, |
| boolean consume)</pre> |
| <div class="block">The default implementation is to return the business object. A derived block may want to |
| override this class if the business object is consumed when read (thus the dervived block may |
| want to make a buffered copy) (An example use case for overriding this method is the |
| businessObject is an InputSource)</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>busObject</code> - </dd><dd><code>busContext</code> - </dd><dd><code>consume</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd></dd></dl> |
| </li> |
| </ul> |
| <a name="_getBOFromReader(javax.xml.stream.XMLStreamReader, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_getBOFromReader</h4> |
| <pre>protected abstract <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> _getBOFromReader(<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> busContext) |
| 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">The derived class must provide an implementation that builds the business object from the |
| reader</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - XMLStreamReader, which is consumed</dd><dd><code>busContext</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd></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="_getBOFromOM(org.apache.axiom.om.OMElement, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_getBOFromOM</h4> |
| <pre>protected <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> _getBOFromOM(<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> busContext) |
| 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">Default method for getting business object from OM. |
| Derived classes may override this method to get the business object from a |
| data source.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>om</code> - </dd><dd><code>busContext</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Business Object</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="_getReaderFromBO(java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_getReaderFromBO</h4> |
| <pre>protected abstract <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> _getReaderFromBO(<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> busObj, |
| <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> busContext) |
| 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">Get an XMLStreamReader for the BusinessObject The derived Block must implement this method</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>busObj</code> - </dd><dd><code>busContext</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd></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="_getOMFromBO(java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_getOMFromBO</h4> |
| <pre>protected <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> _getOMFromBO(<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> busObject, |
| <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> busContext) |
| 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> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>busObject</code> - </dd><dd><code>busContext</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>OMElement</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="_outputFromReader(javax.xml.stream.XMLStreamReader, javax.xml.stream.XMLStreamWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_outputFromReader</h4> |
| <pre>protected void _outputFromReader(<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/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer) |
| 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></pre> |
| <div class="block">Output Reader contents to a Writer. The default implementation is probably sufficient for most |
| derived classes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - </dd><dd><code>writer</code> - </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></dl> |
| </li> |
| </ul> |
| <a name="_outputFromOM(org.apache.axiom.om.OMElement, javax.xml.stream.XMLStreamWriter, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_outputFromOM</h4> |
| <pre>protected void _outputFromOM(<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/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer, |
| boolean consume) |
| 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></pre> |
| <div class="block">Output OMElement contents to a Writer. The default implementation is probably sufficient for most |
| derived classes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>om</code> - </dd><dd><code>writer</code> - </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></dl> |
| </li> |
| </ul> |
| <a name="copy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a> copy() |
| throws <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMException.html?is-external=true" title="class or interface in org.apache.axiom.om">OMException</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#copy()" title="class or interface in org.apache.axiom.om">copy</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMException.html?is-external=true" title="class or interface in org.apache.axiom.om">OMException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="_outputFromBO(java.lang.Object, java.lang.Object, javax.xml.stream.XMLStreamWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_outputFromBO</h4> |
| <pre>protected abstract void _outputFromBO(<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> busObject, |
| <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> busContext, |
| <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</a> writer) |
| 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">Output BusinessObject contents to a Writer. |
| Derived classes must provide this implementation</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>busObject</code> - </dd><dd><code>busContext</code> - </dd><dd><code>writer</code> - </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="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <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> getProperty(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#getProperty(java.lang.String)" title="class or interface in org.apache.axiom.om">getProperty</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperty(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public <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> setProperty(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <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> value)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#setProperty(java.lang.String, java.lang.Object)" title="class or interface in org.apache.axiom.om">setProperty</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hasProperty</h4> |
| <pre>public boolean hasProperty(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#hasProperty(java.lang.String)" title="class or interface in org.apache.axiom.om">hasProperty</a></code> in interface <code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></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/BlockImpl.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="../../../../../../org/apache/axis2/jaxws/message/impl/BlockFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.impl"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/axis2/jaxws/message/impl/MessageFactoryImpl.html" title="class in org.apache.axis2.jaxws.message.impl"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/axis2/jaxws/message/impl/BlockImpl.html" target="_top">Frames</a></li> |
| <li><a href="BlockImpl.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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> |