Google Git
Sign in
apache / axis-site / 97c78f4d4b54200ec4c09f9173095d7207ad4952 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / jaxws / message / impl / BlockImpl.html
blob: b50bcad23e5202f321e1e7c1767af9896da400c3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>BlockImpl (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="BlockImpl (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":6,"i2":10,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.axis2.jaxws.message.impl</a></div>
<h2 title="Class BlockImpl" class="title">Class BlockImpl&lt;T,&#8203;C&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds" class="externalLink">org.apache.axiom.om.ds.AbstractOMDataSource</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.jaxws.message.impl.BlockImpl&lt;T,&#8203;C&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</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>, <code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;T,&#8203;C&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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 abstract class <span class="typeNameLabel">BlockImpl&lt;T,&#8203;C&gt;</span>
extends <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds" class="externalLink">AbstractOMDataSource</a>
implements <a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;T,&#8203;C&gt;</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 =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="BlockImpl.html" title="type parameter in BlockImpl">C</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#busContext">busContext</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="BlockImpl.html" title="type parameter in BlockImpl">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#busObject">busObject</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#consumed">consumed</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="#factory">factory</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="#omElement">omElement</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="#parent">parent</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="#qName">qName</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(C,org.apache.axiom.om.OMElement,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">BlockImpl</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;omElement,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axiom.om.OMElement,C,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">BlockImpl</a></span>&#8203;(<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>&nbsp;omElement,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</code></th>
<td class="colLast">
<div class="block">A Block has the following components</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(T,C,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">BlockImpl</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</code></th>
<td class="colLast">
<div class="block">A Block has the following components</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected <a href="BlockImpl.html" title="type parameter in BlockImpl">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_getBOFromBO(T,C,boolean)">_getBOFromBO</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
boolean&nbsp;consume)</code></th>
<td class="colLast">
<div class="block">The default implementation is to return the business object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="BlockImpl.html" title="type parameter in BlockImpl">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_getBOFromOM(org.apache.axiom.om.OMElement,C)">_getBOFromOM</a></span>&#8203;(<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>&nbsp;omElement,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)</code></th>
<td class="colLast">
<div class="block">Default method for getting business object from OM.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <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="#_getOMFromBO(T,C)">_getOMFromBO</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected abstract <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="#_getReaderFromBO(T,C)">_getReaderFromBO</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObj,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)</code></th>
<td class="colLast">
<div class="block">Get an XMLStreamReader for the BusinessObject The derived Block must implement this method</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_outputFromBO(T,C,javax.xml.stream.XMLStreamWriter)">_outputFromBO</a></span>&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;writer)</code></th>
<td class="colLast">
<div class="block">Output BusinessObject contents to a Writer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_outputFromOM(org.apache.axiom.om.OMElement,javax.xml.stream.XMLStreamWriter,boolean)">_outputFromOM</a></span>&#8203;(<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>&nbsp;omElement,
<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>&nbsp;writer,
boolean&nbsp;consume)</code></th>
<td class="colLast">
<div class="block">Output OMElement contents to a Writer.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_outputFromReader(javax.xml.stream.XMLStreamReader,javax.xml.stream.XMLStreamWriter)">_outputFromReader</a></span>&#8203;(<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>&nbsp;reader,
<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>&nbsp;writer)</code></th>
<td class="colLast">
<div class="block">Output Reader contents to a Writer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <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="#_postPivot_getXMLStreamReader()">_postPivot_getXMLStreamReader</a></span>()</code></th>
<td class="colLast">
<div class="block">Called if we have passed the pivot point but someone wants to output the block.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_postPivot_outputTo(javax.xml.stream.XMLStreamWriter)">_postPivot_outputTo</a></span>&#8203;(<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>&nbsp;writer)</code></th>
<td class="colLast">
<div class="block">Called if we have passed the pivot point but someone wants to output the block.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy()">copy</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" 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="i11" 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="i12" class="altColor">
<td class="colFirst"><code><a href="BlockImpl.html" title="type parameter in BlockImpl">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBusinessObject(boolean)">getBusinessObject</a></span>&#8203;(boolean&nbsp;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="i13" 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="i14" 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="i15" 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="i16" 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="#getReader()">getReader</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<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>&#8203;(boolean&nbsp;consume)</code></th>
<td class="colLast">
<div class="block">Get the XMLStreamReader represented by this Block</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBusinessObject()">isBusinessObject</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" 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="i20" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<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>&#8203;(<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>&nbsp;writer,
boolean&nbsp;consume)</code></th>
<td class="colLast">
<div class="block">Write out the Block</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serialize(javax.xml.stream.XMLStreamWriter)">serialize</a></span>&#8203;(<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>&nbsp;writer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConsumed(boolean)">setConsumed</a></span>&#8203;(boolean&nbsp;consume)</code></th>
<td class="colLast">
<div class="block">Once consumed, all instance data objects are nullified to prevent subsequent access</div>
</td>
</tr>
<tr id="i24" class="altColor">
<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>&#8203;(<a href="../Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a>&nbsp;p)</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="i25" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQName(javax.xml.namespace.QName)">setQName</a></span>&#8203;(<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>&nbsp;qName)</code></th>
<td class="colLast">
<div class="block">This method is intended for derived objects to set the qName</div>
</td>
</tr>
<tr id="i26" 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>&#8203;(<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>&nbsp;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.ds.AbstractOMDataSource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axiom.om.ds.<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds" class="externalLink">AbstractOMDataSource</a></h3>
<code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#close()" title="class or interface in org.apache.axiom.om.ds" class="externalLink">close</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getObject()" title="class or interface in org.apache.axiom.om.ds" class="externalLink">getObject</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getProperty(java.lang.String)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">getProperty</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getXMLBytes(java.lang.String)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">getXMLBytes</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getXMLInputStream(java.lang.String)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">getXMLInputStream</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#hasProperty(java.lang.String)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">hasProperty</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#serialize(java.io.OutputStream,org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">serialize</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#serialize(java.io.Writer,org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">serialize</a>, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#setProperty(java.lang.String,java.lang.Object)" title="class or interface in org.apache.axiom.om.ds" class="externalLink">setProperty</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.axis2.jaxws.message.Block">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.axis2.jaxws.message.<a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></h3>
<code><a href="../Block.html#isElementData()">isElementData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.axiom.om.OMDataSource">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#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></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&nbsp;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#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">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="busObject">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>busObject</h4>
<pre>protected&nbsp;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a> busObject</pre>
</li>
</ul>
<a id="busContext">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>busContext</h4>
<pre>protected&nbsp;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a> busContext</pre>
</li>
</ul>
<a id="omElement">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>omElement</h4>
<pre>protected&nbsp;<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> omElement</pre>
</li>
</ul>
<a id="qName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>qName</h4>
<pre>protected&nbsp;<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> qName</pre>
</li>
</ul>
<a id="factory">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factory</h4>
<pre>protected&nbsp;<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> factory</pre>
</li>
</ul>
<a id="consumed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumed</h4>
<pre>protected&nbsp;boolean consumed</pre>
</li>
</ul>
<a id="parent">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parent</h4>
<pre>protected&nbsp;<a href="../Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> parent</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.Object,java.lang.Object,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a><a id="&lt;init&gt;(T,C,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BlockImpl</h4>
<pre>protected&nbsp;BlockImpl&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</pre>
<div class="block">A Block has the following components</div>
<dl>
<dt><span class="paramLabel">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 id="&lt;init&gt;(org.apache.axiom.om.OMElement,java.lang.Object,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a><a id="&lt;init&gt;(org.apache.axiom.om.OMElement,C,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BlockImpl</h4>
<pre>protected&nbsp;BlockImpl&#8203;(<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>&nbsp;omElement,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</pre>
<div class="block">A Block has the following components</div>
<dl>
<dt><span class="paramLabel">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>
<a id="&lt;init&gt;(java.lang.Object,org.apache.axiom.om.OMElement,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a><a id="&lt;init&gt;(C,org.apache.axiom.om.OMElement,javax.xml.namespace.QName,org.apache.axis2.jaxws.message.factory.BlockFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BlockImpl</h4>
<pre>protected&nbsp;BlockImpl&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;omElement,
<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>&nbsp;qName,
<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;factory)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getBlockFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockFactory</h4>
<pre class="methodSignature">public final&nbsp;<a href="../factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a>&nbsp;getBlockFactory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getBlockFactory()">Block</a></code></span></div>
<div class="block">Get BlockFactory</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getBlockFactory()">getBlockFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>BlockFactory that created the Block</dd>
</dl>
</li>
</ul>
<a id="getBusinessContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBusinessContext</h4>
<pre class="methodSignature">public final&nbsp;<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>&nbsp;getBusinessContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getBusinessContext()">Block</a></code></span></div>
<div class="block">GetBusinesContext Some business objects have an associated context object (i.e. JAXBContext)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getBusinessContext()">getBusinessContext</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Context Object or null</dd>
</dl>
</li>
</ul>
<a id="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre class="methodSignature">public final&nbsp;<a href="../Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a>&nbsp;getParent()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getParent()">Block</a></code></span></div>
<div class="block">Get the Message associated with this block</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getParent()">getParent</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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">public&nbsp;void&nbsp;setParent&#8203;(<a href="../Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a>&nbsp;p)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#setParent(org.apache.axis2.jaxws.message.Message)">Block</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="getBusinessObject(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBusinessObject</h4>
<pre class="methodSignature">public final&nbsp;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;getBusinessObject&#8203;(boolean&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getBusinessObject(boolean)">Block</a></code></span></div>
<div class="block">Get a reference to the Business Object represented by this Block</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getBusinessObject(boolean)">getBusinessObject</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="getQName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQName</h4>
<pre class="methodSignature">public final&nbsp;<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>&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getQName()">Block</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getQName()">getQName</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="../Block.html#isQNameAvailable()"><code>Block.isQNameAvailable()</code></a></dd>
</dl>
</li>
</ul>
<a id="setQName(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQName</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;setQName&#8203;(<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>&nbsp;qName)</pre>
<div class="block">This method is intended for derived objects to set the qName</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qName</code> - </dd>
</dl>
</li>
</ul>
<a id="getXMLStreamReader(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXMLStreamReader</h4>
<pre class="methodSignature">public final&nbsp;<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>&nbsp;getXMLStreamReader&#8203;(boolean&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getXMLStreamReader(boolean)">Block</a></code></span></div>
<div class="block">Get the XMLStreamReader represented by this Block</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getXMLStreamReader(boolean)">getXMLStreamReader</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="getReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReader</h4>
<pre class="methodSignature">public final&nbsp;<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>&nbsp;getReader()
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></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><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></code>&nbsp;in interface&nbsp;<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></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>
</dl>
</li>
</ul>
<a id="serialize(javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;serialize&#8203;(<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>&nbsp;writer)
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></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><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>&nbsp;in interface&nbsp;<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></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>
</dl>
</li>
</ul>
<a id="getOMElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOMElement</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#getOMElement()">Block</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#getOMElement()">getOMElement</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="isConsumed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConsumed</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isConsumed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#isConsumed()">Block</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#isConsumed()">isConsumed</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="setConsumed(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConsumed</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setConsumed&#8203;(boolean&nbsp;consume)</pre>
<div class="block">Once consumed, all instance data objects are nullified to prevent subsequent access</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consume</code> - </dd>
</dl>
</li>
</ul>
<a id="isQNameAvailable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isQNameAvailable</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isQNameAvailable()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#isQNameAvailable()">isQNameAvailable</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="outputTo(javax.xml.stream.XMLStreamWriter,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputTo</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;outputTo&#8203;(<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>&nbsp;writer,
boolean&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#outputTo(javax.xml.stream.XMLStreamWriter,boolean)">Block</a></code></span></div>
<div class="block">Write out the Block</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#outputTo(javax.xml.stream.XMLStreamWriter,boolean)">outputTo</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<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="_postPivot_outputTo(javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_postPivot_outputTo</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;_postPivot_outputTo&#8203;(<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>&nbsp;writer)
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">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="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="_postPivot_getXMLStreamReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_postPivot_getXMLStreamReader</h4>
<pre class="methodSignature">protected final&nbsp;<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>&nbsp;_postPivot_getXMLStreamReader()
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">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="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="isBusinessObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBusinessObject</h4>
<pre class="methodSignature">protected final&nbsp;boolean&nbsp;isBusinessObject()</pre>
<dl>
<dt><span class="returnLabel">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 id="traceString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traceString</h4>
<pre class="methodSignature">public final&nbsp;<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>&nbsp;traceString&#8203;(<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>&nbsp;indent)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Block.html#traceString(java.lang.String)">Block</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Block.html#traceString(java.lang.String)">traceString</a></code>&nbsp;in interface&nbsp;<code><a href="../Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>&lt;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>,&#8203;<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String containing trace information</dd>
</dl>
</li>
</ul>
<a id="_getBOFromBO(java.lang.Object,java.lang.Object,boolean)">
<!-- -->
</a><a id="_getBOFromBO(T,C,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_getBOFromBO</h4>
<pre class="methodSignature">protected&nbsp;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;_getBOFromBO&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
boolean&nbsp;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="paramLabel">Parameters:</span></dt>
<dd><code>busObject</code> - </dd>
<dd><code>busContext</code> - </dd>
<dd><code>consume</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a id="_getBOFromOM(org.apache.axiom.om.OMElement,java.lang.Object)">
<!-- -->
</a><a id="_getBOFromOM(org.apache.axiom.om.OMElement,C)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_getBOFromOM</h4>
<pre class="methodSignature">protected abstract&nbsp;<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;_getBOFromOM&#8203;(<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>&nbsp;omElement,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)
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">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="paramLabel">Parameters:</span></dt>
<dd><code>om</code> - </dd>
<dd><code>busContext</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Business Object</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="_getReaderFromBO(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a id="_getReaderFromBO(T,C)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_getReaderFromBO</h4>
<pre class="methodSignature">protected abstract&nbsp;<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>&nbsp;_getReaderFromBO&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObj,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)
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 an XMLStreamReader for the BusinessObject The derived Block must implement this method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>busObj</code> - </dd>
<dd><code>busContext</code> - </dd>
<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="_getOMFromBO(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a id="_getOMFromBO(T,C)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_getOMFromBO</h4>
<pre class="methodSignature">protected&nbsp;<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>&nbsp;_getOMFromBO&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext)
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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>busObject</code> - </dd>
<dd><code>busContext</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>OMElement</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="_outputFromReader(javax.xml.stream.XMLStreamReader,javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_outputFromReader</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;_outputFromReader&#8203;(<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>&nbsp;reader,
<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>&nbsp;writer)
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></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="paramLabel">Parameters:</span></dt>
<dd><code>reader</code> - </dd>
<dd><code>writer</code> - </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>
</dl>
</li>
</ul>
<a id="_outputFromOM(org.apache.axiom.om.OMElement,javax.xml.stream.XMLStreamWriter,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_outputFromOM</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;_outputFromOM&#8203;(<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>&nbsp;omElement,
<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>&nbsp;writer,
boolean&nbsp;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></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="paramLabel">Parameters:</span></dt>
<dd><code>om</code> - </dd>
<dd><code>writer</code> - </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>
</dl>
</li>
</ul>
<a id="copy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre class="methodSignature">public&nbsp;<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>&nbsp;copy()
throws <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMException.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><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></code>&nbsp;in interface&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#copy()" title="class or interface in org.apache.axiom.om.ds" class="externalLink">copy</a></code>&nbsp;in class&nbsp;<code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds" class="externalLink">AbstractOMDataSource</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMException.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMException</a></code></dd>
</dl>
</li>
</ul>
<a id="_outputFromBO(java.lang.Object,java.lang.Object,javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a><a id="_outputFromBO(T,C,javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_outputFromBO</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;_outputFromBO&#8203;(<a href="BlockImpl.html" title="type parameter in BlockImpl">T</a>&nbsp;busObject,
<a href="BlockImpl.html" title="type parameter in BlockImpl">C</a>&nbsp;busContext,
<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>&nbsp;writer)
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">Output BusinessObject contents to a Writer.
Derived classes must provide this implementation</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>busObject</code> - </dd>
<dd><code>busContext</code> - </dd>
<dd><code>writer</code> - </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>
</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/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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>