| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Block (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Block (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Block.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.axis2.jaxws.message</a></div> |
| <h2 title="Interface Block" class="title">Interface Block<T,​C></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMDataSource</a></code>, <code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMDataSourceExt</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="databinding/DataSourceBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">DataSourceBlock</a></code>, <code><a href="databinding/JAXBBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">JAXBBlock</a></code>, <code><a href="databinding/OMBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">OMBlock</a></code>, <code><a href="databinding/SOAPEnvelopeBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">SOAPEnvelopeBlock</a></code>, <code><a href="databinding/SourceBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">SourceBlock</a></code>, <code><a href="databinding/XMLStringBlock.html" title="interface in org.apache.axis2.jaxws.message.databinding">XMLStringBlock</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/BlockImpl.html" title="class in org.apache.axis2.jaxws.message.impl">BlockImpl</a></code>, <code><a href="databinding/impl/DataSourceBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">DataSourceBlockImpl</a></code>, <code><a href="databinding/impl/JAXBBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">JAXBBlockImpl</a></code>, <code><a href="databinding/impl/OMBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">OMBlockImpl</a></code>, <code><a href="databinding/impl/SOAPEnvelopeBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SOAPEnvelopeBlockImpl</a></code>, <code><a href="databinding/impl/SourceBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">SourceBlockImpl</a></code>, <code><a href="databinding/impl/XMLStringBlockImpl.html" title="class in org.apache.axis2.jaxws.message.databinding.impl">XMLStringBlockImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Block<T,​C></span> |
| extends <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMDataSourceExt</a></pre> |
| <div class="block">Block A Block represents an xml element and associated sub-tree. The name of the element must be |
| defined by a root element in a schema. All prefixes within the subtree must correspond to |
| namespace declarations defined within the tree. Many specifications refer to this as a "embedded |
| document" or "xml block". I chose the term, block, for simplicity. |
| <p/> |
| The block can be exposed as: * BusinessObject * StAX object |
| <p/> |
| Note that the whole Message can also be thought of as a Block. Thus a Message can be createFrom |
| a Block and written as a Block. |
| <p/> |
| In addition, each of the accessors has a consume parameter. If consume is true, the Block is no |
| longer valid after the message is called. (i.e. the implementation does not need to cache the |
| information)</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlockFactory()">getBlockFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get BlockFactory</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBusinessContext()">getBusinessContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">GetBusinesContext Some business objects have an associated context object (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBusinessObject(boolean)">getBusinessObject</a></span>​(boolean consume)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a reference to the Business Object represented by this Block</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOMElement()">getOMElement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the OMElement represented by this Block.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Message associated with this block</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQName()">getQName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the QName (namespace, localpart) of the Block.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamReader</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getXMLStreamReader(boolean)">getXMLStreamReader</a></span>​(boolean consume)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the XMLStreamReader represented by this Block</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConsumed()">isConsumed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">isConsumed Return true if the block is consumed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isElementData()">isElementData</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isQNameAvailable()">isQNameAvailable</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outputTo(javax.xml.stream.XMLStreamWriter,boolean)">outputTo</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer, |
| boolean consume)</code></th> |
| <td class="colLast"> |
| <div class="block">Write out the Block</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a></span>​(<a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> parent)</code></th> |
| <td class="colLast"> |
| <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 id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceString(java.lang.String)">traceString</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> indent)</code></th> |
| <td class="colLast"> |
| <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 id="methods.inherited.from.class.org.apache.axiom.om.OMDataSource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axiom.om.<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMDataSource</a></h3> |
| <code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true#getReader()" title="class or interface in org.apache.axiom.om" class="externalLink">getReader</a>, <a href="https://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" class="externalLink">serialize</a>, <a href="https://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" class="externalLink">serialize</a>, <a href="https://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" class="externalLink">serialize</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.axiom.om.OMDataSourceExt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.axiom.om.<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMDataSourceExt</a></h3> |
| <code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#close()" title="class or interface in org.apache.axiom.om" class="externalLink">close</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#copy()" title="class or interface in org.apache.axiom.om" class="externalLink">copy</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#getObject()" title="class or interface in org.apache.axiom.om" class="externalLink">getObject</a>, <a href="https://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" class="externalLink">getProperty</a>, <a href="https://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" class="externalLink">getXMLBytes</a>, <a href="https://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" class="externalLink">getXMLInputStream</a>, <a href="https://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" class="externalLink">hasProperty</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#isDestructiveRead()" title="class or interface in org.apache.axiom.om" class="externalLink">isDestructiveRead</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#isDestructiveWrite()" title="class or interface in org.apache.axiom.om" class="externalLink">isDestructiveWrite</a>, <a href="https://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" class="externalLink">setProperty</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getBusinessObject(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBusinessObject</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getBusinessObject​(boolean consume) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Get a reference to the Business Object represented by this Block</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consume</code> - true if this is the last request on the block.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object (JAXB, String etc.)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBusinessContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBusinessContext</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getBusinessContext()</pre> |
| <div class="block">GetBusinesContext Some business objects have an associated context object (i.e. JAXBContext)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Context Object or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getXMLStreamReader(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLStreamReader</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamReader</a> getXMLStreamReader​(boolean consume) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Get the XMLStreamReader represented by this Block</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consume</code> - true if this is the last request on the block.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XMLStreamReader</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOMElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOMElement</h4> |
| <pre class="methodSignature"><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> getOMElement() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <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><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="outputTo(javax.xml.stream.XMLStreamWriter,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputTo</h4> |
| <pre class="methodSignature">void outputTo​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer, |
| boolean consume) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Write out the Block</div> |
| <dl> |
| <dt><span class="paramLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isConsumed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConsumed</h4> |
| <pre class="methodSignature">boolean isConsumed()</pre> |
| <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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the block is consumed (a method was called with consume=true)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="traceString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traceString</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> traceString​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> indent)</pre> |
| <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><span class="returnLabel">Returns:</span></dt> |
| <dd>String containing trace information</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isQNameAvailable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isQNameAvailable</h4> |
| <pre class="methodSignature">boolean isQNameAvailable()</pre> |
| <dl> |
| <dt><span class="returnLabel">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 id="getQName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> getQName() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <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><span class="returnLabel">Returns:</span></dt> |
| <dd>QName of the block</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isQNameAvailable()"><code>isQNameAvailable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBlockFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBlockFactory</h4> |
| <pre class="methodSignature"><a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> getBlockFactory()</pre> |
| <div class="block">Get BlockFactory</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>BlockFactory that created the Block</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> getParent()</pre> |
| <div class="block">Get the Message associated with this block</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setParent(org.apache.axis2.jaxws.message.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParent</h4> |
| <pre class="methodSignature">void setParent​(<a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> parent)</pre> |
| <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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isElementData()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isElementData</h4> |
| <pre class="methodSignature">boolean isElementData()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if data is always an element; false if possibly mixed content or multiple |
| elements</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Block.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |