Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / serializer / FixedFormatSerializer.html
blob: c4f1aae190e699e8234005bcdac43e9100c5a1d1 [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:35 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FixedFormatSerializer (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="FixedFormatSerializer (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/FixedFormatSerializer.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/server/api/serializer/EntitySerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/serializer/Kind.html" title="enum in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/FixedFormatSerializer.html" target="_top">Frames</a></li>
<li><a href="FixedFormatSerializer.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.server.api.serializer</div>
<h2 title="Interface FixedFormatSerializer" class="title">Interface FixedFormatSerializer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FixedFormatSerializer</span></pre>
<div class="block">OData serializer for fixed output formats.</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/server/api/serializer/FixedFormatSerializer.html#asyncResponse-org.apache.olingo.server.api.ODataResponse-">asyncResponse</a></span>(<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;odataResponse)</code>
<div class="block">Serializes a ODataResponse into an async response.</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/server/api/serializer/FixedFormatSerializer.html#batchResponse-java.util.List-java.lang.String-">batchResponse</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/server/api/deserializer/batch/ODataResponsePart.html" title="class in org.apache.olingo.server.api.deserializer.batch">ODataResponsePart</a>&gt;&nbsp;batchResponses,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;boundary)</code>
<div class="block">Serializes a batch response.</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/server/api/serializer/FixedFormatSerializer.html#binary-byte:A-">binary</a></span>(byte[]&nbsp;binary)</code>
<div class="block">Writes binary output into an InputStream.</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/server/api/serializer/FixedFormatSerializer.html#count-java.lang.Integer-">count</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;count)</code>
<div class="block">Writes a count into an InputStream as plain text.</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/server/api/serializer/FixedFormatSerializer.html#primitiveValue-org.apache.olingo.commons.api.edm.EdmPrimitiveType-java.lang.Object-org.apache.olingo.server.api.serializer.PrimitiveValueSerializerOptions-">primitiveValue</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmPrimitiveType.html" title="interface in org.apache.olingo.commons.api.edm">EdmPrimitiveType</a>&nbsp;type,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveValueSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveValueSerializerOptions</a>&nbsp;options)</code>
<div class="block">Writes the raw value of a primitive-type instance into an InputStream.</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="binary-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>binary</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;binary(byte[]&nbsp;binary)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></pre>
<div class="block">Writes binary output into an InputStream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binary</code> - the binary data</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="count-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</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;count(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;count)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></pre>
<div class="block">Writes a count into an InputStream as plain text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>count</code> - the count</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="primitiveValue-org.apache.olingo.commons.api.edm.EdmPrimitiveType-java.lang.Object-org.apache.olingo.server.api.serializer.PrimitiveValueSerializerOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>primitiveValue</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;primitiveValue(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmPrimitiveType.html" title="interface in org.apache.olingo.commons.api.edm">EdmPrimitiveType</a>&nbsp;type,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveValueSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveValueSerializerOptions</a>&nbsp;options)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></pre>
<div class="block">Writes the raw value of a primitive-type instance into an InputStream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the primitive type</dd>
<dd><code>value</code> - the value</dd>
<dd><code>options</code> - options for the serializer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="batchResponse-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchResponse</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;batchResponse(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/server/api/deserializer/batch/ODataResponsePart.html" title="class in org.apache.olingo.server.api.deserializer.batch">ODataResponsePart</a>&gt;&nbsp;batchResponses,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;boundary)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/BatchSerializerException.html" title="class in org.apache.olingo.server.api.serializer">BatchSerializerException</a></pre>
<div class="block">Serializes a batch response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>batchResponses</code> - the response parts</dd>
<dd><code>boundary</code> - the boundary between the parts</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response as an input stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/BatchSerializerException.html" title="class in org.apache.olingo.server.api.serializer">BatchSerializerException</a></code></dd>
</dl>
</li>
</ul>
<a name="asyncResponse-org.apache.olingo.server.api.ODataResponse-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asyncResponse</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;asyncResponse(<a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a>&nbsp;odataResponse)
throws <a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></pre>
<div class="block">Serializes a ODataResponse into an async response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>odataResponse</code> - the response parts</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response as an input stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</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/FixedFormatSerializer.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/server/api/serializer/EntitySerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/serializer/Kind.html" title="enum in org.apache.olingo.server.api.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/FixedFormatSerializer.html" target="_top">Frames</a></li>
<li><a href="FixedFormatSerializer.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>