Google Git
Sign in
apache / cxf-site / refs/heads/asf-staging / . / content / javadoc / latest-3.1.x / org / apache / cxf / aegis / type / encoded / TrailingBlocks.html
blob: d8cddc87e6efd758eb50ff40c9e76673441a3e97 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TrailingBlocks (Apache CXF JavaDoc 3.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TrailingBlocks (Apache CXF JavaDoc 3.1.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TrailingBlocks.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/aegis/type/encoded/StructType.html" title="class in org.apache.cxf.aegis.type.encoded"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/aegis/type/encoded/TrailingBlocks.html" target="_top">Frames</a></li>
<li><a href="TrailingBlocks.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cxf.aegis.type.encoded</div>
<h2 title="Class TrailingBlocks" class="title">Class TrailingBlocks</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cxf.aegis.type.encoded.TrailingBlocks</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">TrailingBlocks</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">TrailingBlocks reads and writes the extra objects referenced but not written in the main message parts.
These objects are commonly refered to as serialization (SOAP spec) roots and trailing blocks (JaxRpc spec).
This class uses ObjectType to perform the actual reading and writting, so each block will (and must)
contain an xsi type element.
<p/>
Typically, all message parts are read or written using the SoapRefType and before closing the SOAP body
element the trailing blocks are read or written using this class.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#TrailingBlocks()">TrailingBlocks</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#TrailingBlocks(org.apache.cxf.aegis.type.basic.ObjectType)">TrailingBlocks</a></strong>(<a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a>&nbsp;objectType)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#TrailingBlocks(org.apache.cxf.aegis.type.TypeMapping)">TrailingBlocks</a></strong>(<a href="../../../../../../org/apache/cxf/aegis/type/TypeMapping.html" title="interface in org.apache.cxf.aegis.type">TypeMapping</a>&nbsp;typeMapping)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#getObjectType()">getObjectType</a></strong>()</code>
<div class="block">Gets the ObjectType used to read and write the trailing block instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#readBlocks(org.apache.cxf.aegis.xml.MessageReader,%20org.apache.cxf.aegis.Context)">readBlocks</a></strong>(<a href="../../../../../../org/apache/cxf/aegis/xml/MessageReader.html" title="interface in org.apache.cxf.aegis.xml">MessageReader</a>&nbsp;reader,
<a href="../../../../../../org/apache/cxf/aegis/Context.html" title="class in org.apache.cxf.aegis">Context</a>&nbsp;context)</code>
<div class="block">Reads all remailing elements in the reader and registers them with the SoapRefRegistry in the context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#setObjectType(org.apache.cxf.aegis.type.basic.ObjectType)">setObjectType</a></strong>(<a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a>&nbsp;objectType)</code>
<div class="block">Sets the ObjectType used to read and write the trailing block instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/aegis/type/encoded/TrailingBlocks.html#writeBlocks(org.apache.cxf.aegis.xml.MessageWriter,%20org.apache.cxf.aegis.Context)">writeBlocks</a></strong>(<a href="../../../../../../org/apache/cxf/aegis/xml/MessageWriter.html" title="interface in org.apache.cxf.aegis.xml">MessageWriter</a>&nbsp;writer,
<a href="../../../../../../org/apache/cxf/aegis/Context.html" title="class in org.apache.cxf.aegis">Context</a>&nbsp;context)</code>
<div class="block">Writes all of the unmarshalled objects in the MarshalRegistry.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TrailingBlocks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TrailingBlocks</h4>
<pre>public&nbsp;TrailingBlocks()</pre>
</li>
</ul>
<a name="TrailingBlocks(org.apache.cxf.aegis.type.TypeMapping)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TrailingBlocks</h4>
<pre>public&nbsp;TrailingBlocks(<a href="../../../../../../org/apache/cxf/aegis/type/TypeMapping.html" title="interface in org.apache.cxf.aegis.type">TypeMapping</a>&nbsp;typeMapping)</pre>
</li>
</ul>
<a name="TrailingBlocks(org.apache.cxf.aegis.type.basic.ObjectType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TrailingBlocks</h4>
<pre>public&nbsp;TrailingBlocks(<a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a>&nbsp;objectType)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getObjectType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectType</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a>&nbsp;getObjectType()</pre>
<div class="block">Gets the ObjectType used to read and write the trailing block instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the ObjectType used to read and write the trailing block instances.</dd></dl>
</li>
</ul>
<a name="setObjectType(org.apache.cxf.aegis.type.basic.ObjectType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObjectType</h4>
<pre>public&nbsp;void&nbsp;setObjectType(<a href="../../../../../../org/apache/cxf/aegis/type/basic/ObjectType.html" title="class in org.apache.cxf.aegis.type.basic">ObjectType</a>&nbsp;objectType)</pre>
<div class="block">Sets the ObjectType used to read and write the trailing block instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objectType</code> - the ObjectType used to read and write the trailing block instances.</dd></dl>
</li>
</ul>
<a name="readBlocks(org.apache.cxf.aegis.xml.MessageReader, org.apache.cxf.aegis.Context)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readBlocks</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;readBlocks(<a href="../../../../../../org/apache/cxf/aegis/xml/MessageReader.html" title="interface in org.apache.cxf.aegis.xml">MessageReader</a>&nbsp;reader,
<a href="../../../../../../org/apache/cxf/aegis/Context.html" title="class in org.apache.cxf.aegis">Context</a>&nbsp;context)
throws <a href="../../../../../../org/apache/cxf/aegis/DatabindingException.html" title="class in org.apache.cxf.aegis">DatabindingException</a></pre>
<div class="block">Reads all remailing elements in the reader and registers them with the SoapRefRegistry in the context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - the stream to read</dd><dd><code>context</code> - the unmarshal context</dd>
<dt><span class="strong">Returns:</span></dt><dd>a list containing the object instances read</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/cxf/aegis/DatabindingException.html" title="class in org.apache.cxf.aegis">DatabindingException</a></code> - if a trailing block element does not contain a soap id attribute</dd></dl>
</li>
</ul>
<a name="writeBlocks(org.apache.cxf.aegis.xml.MessageWriter, org.apache.cxf.aegis.Context)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeBlocks</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;writeBlocks(<a href="../../../../../../org/apache/cxf/aegis/xml/MessageWriter.html" title="interface in org.apache.cxf.aegis.xml">MessageWriter</a>&nbsp;writer,
<a href="../../../../../../org/apache/cxf/aegis/Context.html" title="class in org.apache.cxf.aegis">Context</a>&nbsp;context)</pre>
<div class="block">Writes all of the unmarshalled objects in the MarshalRegistry.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - the stream to write the objects</dd><dd><code>context</code> - the marshal context</dd>
<dt><span class="strong">Returns:</span></dt><dd>a list containing the object instances written</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TrailingBlocks.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/aegis/type/encoded/StructType.html" title="class in org.apache.cxf.aegis.type.encoded"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/aegis/type/encoded/TrailingBlocks.html" target="_top">Frames</a></li>
<li><a href="TrailingBlocks.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Apache CXF</small></p>
</body>
</html>