Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / serializer / package-summary.html
blob: 6a1502eaafbaa47408bee8a3ea4e8007a9f7dfbd [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:38 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.server.api.serializer (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="org.apache.olingo.server.api.serializer (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/processor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/uri/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.olingo.server.api.serializer</h1>
<div class="docSummary">
<div class="block">Olingo Server API - Serializer</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/CustomContentTypeSupport.html" title="interface in org.apache.olingo.server.api.serializer">CustomContentTypeSupport</a></td>
<td class="colLast">
<div class="block">Processors that supports custom content types can implement this interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializer.html" title="interface in org.apache.olingo.server.api.serializer">EdmAssistedSerializer</a></td>
<td class="colLast">
<div class="block">EDM-assisted serializer</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmDeltaSerializer.html" title="interface in org.apache.olingo.server.api.serializer">EdmDeltaSerializer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/FixedFormatSerializer.html" title="interface in org.apache.olingo.server.api.serializer">FixedFormatSerializer</a></td>
<td class="colLast">
<div class="block">OData serializer for fixed output formats.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ODataSerializer.html" title="interface in org.apache.olingo.server.api.serializer">ODataSerializer</a></td>
<td class="colLast">
<div class="block">OData serializer</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerResult.html" title="interface in org.apache.olingo.server.api.serializer">SerializerResult</a></td>
<td class="colLast">
<div class="block">Result type for <a href="../../../../../../org/apache/olingo/server/api/serializer/ODataSerializer.html" title="interface in org.apache.olingo.server.api.serializer"><code>ODataSerializer</code></a> methods</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerStreamResult.html" title="interface in org.apache.olingo.server.api.serializer">SerializerStreamResult</a></td>
<td class="colLast">
<div class="block">Result type for <a href="../../../../../../org/apache/olingo/server/api/serializer/ODataSerializer.html" title="interface in org.apache.olingo.server.api.serializer"><code>ODataSerializer</code></a> methods
which supports streaming (write in the future).</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ComplexSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">ComplexSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the OData serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ComplexSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">ComplexSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">EdmAssistedSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the EDM-assisted serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">EdmAssistedSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EntityCollectionSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">EntityCollectionSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the OData serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EntityCollectionSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">EntityCollectionSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EntitySerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">EntitySerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the OData serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/EntitySerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">EntitySerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the OData serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveValueSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveValueSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options for the OData serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/PrimitiveValueSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">PrimitiveValueSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ReferenceCollectionSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">ReferenceCollectionSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options to pass as additional information to the reference-collection serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ReferenceCollectionSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">ReferenceCollectionSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ReferenceSerializerOptions.html" title="class in org.apache.olingo.server.api.serializer">ReferenceSerializerOptions</a></td>
<td class="colLast">
<div class="block">Options to pass as additional information to the reference serializer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/ReferenceSerializerOptions.Builder.html" title="class in org.apache.olingo.server.api.serializer">ReferenceSerializerOptions.Builder</a></td>
<td class="colLast">
<div class="block">Builder of OData serializer options.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/BatchSerializerException.MessageKeys.html" title="enum in org.apache.olingo.server.api.serializer">BatchSerializerException.MessageKeys</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/Kind.html" title="enum in org.apache.olingo.server.api.serializer">Kind</a></td>
<td class="colLast">
<div class="block">The different types of edm kinds that form the metadata</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/RepresentationType.html" title="enum in org.apache.olingo.server.api.serializer">RepresentationType</a></td>
<td class="colLast">
<div class="block">The different types of representations that form the body of either the
OData request or the OData response, primarily used for content negotiation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.MessageKeys.html" title="enum in org.apache.olingo.server.api.serializer">SerializerException.MessageKeys</a></td>
<td class="colLast">
<div class="block">Keys for exception texts in the resource bundle.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/BatchSerializerException.html" title="class in org.apache.olingo.server.api.serializer">BatchSerializerException</a></td>
<td class="colLast">
<div class="block">Thrown for invalid batch payloads.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/serializer/SerializerException.html" title="class in org.apache.olingo.server.api.serializer">SerializerException</a></td>
<td class="colLast">
<div class="block">Exception thrown by the <a href="../../../../../../org/apache/olingo/server/api/serializer/ODataSerializer.html" title="interface in org.apache.olingo.server.api.serializer"><code>ODataSerializer</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.server.api.serializer Description">Package org.apache.olingo.server.api.serializer Description</h2>
<div class="block">Olingo Server API - Serializer
<p>
The serializer package is used to condense all about the Olingo serialization.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/processor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/uri/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/serializer/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>