Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata4 / org / apache / olingo / client / api / serialization / ODataWriter.html
blob: fb83284795d400ec723e57a629c70aef1b34351b [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>
<!-- Generated by javadoc (1.8.0_92) on Mon Aug 13 15:36:34 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ODataWriter (Olingo-OData 4.5.0 API)</title>
<meta name="date" content="2018-08-13">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ODataWriter (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/ODataWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/client/api/serialization/ODataWriter.html" target="_top">Frames</a></li>
<li><a href="ODataWriter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>Constr&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>Constr&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.olingo.client.api.serialization</div>
<h2 title="Interface ODataWriter" class="title">Interface ODataWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ODataWriter</span></pre>
<div class="block">OData writer.
<br/>
Use this interface to serialize an OData request body.
<br/>
This interface provides method helpers to serialize a set of entities and a single entity as well.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataWriter.html#writeEntities-java.util.Collection-org.apache.olingo.commons.api.format.ContentType-">writeEntities</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/olingo/client/api/domain/ClientEntity.html" title="interface in org.apache.olingo.client.api.domain">ClientEntity</a>&gt;&nbsp;entities,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;contentType)</code>
<div class="block">Writes a collection of OData entities.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataWriter.html#writeEntity-org.apache.olingo.client.api.domain.ClientEntity-org.apache.olingo.commons.api.format.ContentType-">writeEntity</a></span>(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientEntity.html" title="interface in org.apache.olingo.client.api.domain">ClientEntity</a>&nbsp;entity,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Serializes a single OData entity.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataWriter.html#writeLink-org.apache.olingo.client.api.domain.ClientLink-org.apache.olingo.commons.api.format.ContentType-">writeLink</a></span>(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientLink.html" title="class in org.apache.olingo.client.api.domain">ClientLink</a>&nbsp;link,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Writes an OData link.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataWriter.html#writeProperty-org.apache.olingo.client.api.domain.ClientProperty-org.apache.olingo.commons.api.format.ContentType-">writeProperty</a></span>(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientProperty.html" title="interface in org.apache.olingo.client.api.domain">ClientProperty</a>&nbsp;property,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Writes a single OData entity property.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataWriter.html#writeReference-org.apache.olingo.client.api.data.ResWrap-org.apache.olingo.commons.api.format.ContentType-">writeReference</a></span>(<a href="../../../../../../org/apache/olingo/client/api/data/ResWrap.html" title="class in org.apache.olingo.client.api.data">ResWrap</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&gt;&nbsp;reference,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Writes a entity reference</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="writeEntities-java.util.Collection-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeEntities</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;writeEntities(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/olingo/client/api/domain/ClientEntity.html" title="interface in org.apache.olingo.client.api.domain">ClientEntity</a>&gt;&nbsp;entities,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;contentType)
throws <a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></pre>
<div class="block">Writes a collection of OData entities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entities</code> - entities to be serialized.</dd>
<dd><code>contentType</code> - serialization format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stream of serialized objects.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeEntity-org.apache.olingo.client.api.domain.ClientEntity-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeEntity</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;writeEntity(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientEntity.html" title="interface in org.apache.olingo.client.api.domain">ClientEntity</a>&nbsp;entity,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)
throws <a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></pre>
<div class="block">Serializes a single OData entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - entity to be serialized.</dd>
<dd><code>contentType</code> - serialization format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stream of serialized object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeProperty-org.apache.olingo.client.api.domain.ClientProperty-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeProperty</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;writeProperty(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientProperty.html" title="interface in org.apache.olingo.client.api.domain">ClientProperty</a>&nbsp;property,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)
throws <a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></pre>
<div class="block">Writes a single OData entity property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>property</code> - entity property to be serialized.</dd>
<dd><code>contentType</code> - serialization format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stream of serialized object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeLink-org.apache.olingo.client.api.domain.ClientLink-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeLink</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;writeLink(<a href="../../../../../../org/apache/olingo/client/api/domain/ClientLink.html" title="class in org.apache.olingo.client.api.domain">ClientLink</a>&nbsp;link,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)
throws <a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></pre>
<div class="block">Writes an OData link.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>link</code> - link to be serialized.</dd>
<dd><code>contentType</code> - serialization format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stream of serialized object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeReference-org.apache.olingo.client.api.data.ResWrap-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeReference</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;writeReference(<a href="../../../../../../org/apache/olingo/client/api/data/ResWrap.html" title="class in org.apache.olingo.client.api.data">ResWrap</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&gt;&nbsp;reference,
<a href="../../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)
throws <a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></pre>
<div class="block">Writes a entity reference</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reference</code> - reference to be serialized</dd>
<dd><code>contentType</code> - serialization format</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stream of serialized objects</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization">ODataSerializerException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/ODataWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/olingo/client/api/serialization/ODataSerializerException.html" title="class in org.apache.olingo.client.api.serialization"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/client/api/serialization/ODataWriter.html" target="_top">Frames</a></li>
<li><a href="ODataWriter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>Copyright &#169; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>