| <!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 Wed Dec 06 14:36:21 CET 2017 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>ODataResponse (olingo-odata2-parent 2.0.10 API)</title> | |
| <meta name="date" content="2017-12-06"> | |
| <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="ODataResponse (olingo-odata2-parent 2.0.10 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":6,"i2":9,"i3":9,"i4":9,"i5":6,"i6":6,"i7":10,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":9,"i14":9,"i15":9}; | |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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"; | |
| </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/ODataResponse.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/odata2/api/processor/ODataRequest.ODataRequestBuilder.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/ODataResponse.html" target="_top">Frames</a></li> | |
| <li><a href="ODataResponse.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: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </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.odata2.api.processor</div> | |
| <h2 title="Class ODataResponse" class="title">Class ODataResponse</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/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.olingo.odata2.api.processor.ODataResponse</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre>public abstract class <span class="typeNameLabel">ODataResponse</span> | |
| extends <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></pre> | |
| <div class="block"><p>An <code>ODataResponse</code> is usually created by an <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataProcessor.html" title="interface in org.apache.olingo.odata2.api.processor"><code>ODataProcessor</code></a> during request handling.</p> | |
| <p>The handler can use a serializer to create an | |
| OData body (== response entity) and can set various response headers. | |
| A response can be created using the builder pattern: | |
| <pre> <code> | |
| ODataResponse response = ODataResponse.entity("hello world").setStatus(HttpStatusCodes.OK).build(); | |
| </code> </pre></div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="nested.class.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested Class Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> | |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Class and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static class </code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></span></code> | |
| <div class="block">Implementation of the builder pattern to create instances of this type of object.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> | |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Field and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#CHARSET_MATCHER_PATTERN">CHARSET_MATCHER_PATTERN</a></span></code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> | |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier</th> | |
| <th class="colLast" scope="col">Constructor and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>protected </code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#ODataResponse--">ODataResponse</a></span>()</code> | |
| <div class="block">Do not subclass ODataResponse!</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>abstract void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#close--">close</a></span>()</code> | |
| <div class="block">Close the underlying entity input stream (if such a stream is available) and release all with this repsonse | |
| associated resources.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>abstract boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#containsHeader-java.lang.String-">containsHeader</a></span>(<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> header)</code> | |
| <div class="block">Case insensitive check if the header is available in this ODataResponse</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#contentHeader-java.lang.String-">contentHeader</a></span>(<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> value)</code> </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#entity-java.lang.Object-">entity</a></span>(<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> entity)</code> </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#fromResponse-org.apache.olingo.odata2.api.processor.ODataResponse-">fromResponse</a></span>(<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a> response)</code> </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>abstract <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></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getContentHeader--">getContentHeader</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>abstract <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></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getEntity--">getEntity</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i7" 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/odata2/api/processor/ODataResponse.html#getEntityAsStream--">getEntityAsStream</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>abstract <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></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getETag--">getETag</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i9" class="rowColor"> | |
| <td class="colFirst"><code>abstract <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></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getHeader-java.lang.String-">getHeader</a></span>(<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> name)</code> </td> | |
| </tr> | |
| <tr id="i10" class="altColor"> | |
| <td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getHeaderNames--">getHeaderNames</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i11" class="rowColor"> | |
| <td class="colFirst"><code>abstract <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></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getIdLiteral--">getIdLiteral</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i12" class="altColor"> | |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/olingo/odata2/api/commons/HttpStatusCodes.html" title="enum in org.apache.olingo.odata2.api.commons">HttpStatusCodes</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#getStatus--">getStatus</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i13" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#header-java.lang.String-java.lang.String-">header</a></span>(<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> name, | |
| <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> value)</code> </td> | |
| </tr> | |
| <tr id="i14" class="altColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#newBuilder--">newBuilder</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i15" class="rowColor"> | |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html#status-org.apache.olingo.odata2.api.commons.HttpStatusCodes-">status</a></span>(<a href="../../../../../../org/apache/olingo/odata2/api/commons/HttpStatusCodes.html" title="enum in org.apache.olingo.odata2.api.commons">HttpStatusCodes</a> status)</code> </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<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></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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"> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Detail</h3> | |
| <a name="CHARSET_MATCHER_PATTERN"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>CHARSET_MATCHER_PATTERN</h4> | |
| <pre>public static final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> CHARSET_MATCHER_PATTERN</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="ODataResponse--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>ODataResponse</h4> | |
| <pre>protected ODataResponse()</pre> | |
| <div class="block">Do not subclass ODataResponse!</div> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="getStatus--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getStatus</h4> | |
| <pre>public abstract <a href="../../../../../../org/apache/olingo/odata2/api/commons/HttpStatusCodes.html" title="enum in org.apache.olingo.odata2.api.commons">HttpStatusCodes</a> getStatus()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>HTTP status code of this response</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEntity--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEntity</h4> | |
| <pre>public abstract <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> getEntity()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a response entity which becomes the body part of a response message</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getEntityAsStream--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getEntityAsStream</h4> | |
| <pre>public <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> getEntityAsStream() | |
| throws <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a response entity as inputStream which becomes the body part of a response message</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></code> - throws ODataException in case of entity is not a stream (internal ClassCastException)</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="close--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>close</h4> | |
| <pre>public abstract void close() | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> | |
| <div class="block">Close the underlying entity input stream (if such a stream is available) and release all with this repsonse | |
| associated resources.</div> | |
| <dl> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something goes wrong during close of <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getHeader-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getHeader</h4> | |
| <pre>public abstract <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> getHeader(<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> name)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - HTTP response header name</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a header value or null if not set</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getContentHeader--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getContentHeader</h4> | |
| <pre>public abstract <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> getContentHeader()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>Content-Type header value or null if not set</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getIdLiteral--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getIdLiteral</h4> | |
| <pre>public abstract <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> getIdLiteral()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>Location header value or null if not set</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getETag--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getETag</h4> | |
| <pre>public abstract <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> getETag()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>ETag header value or null if not available</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getHeaderNames--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getHeaderNames</h4> | |
| <pre>public abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<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>> getHeaderNames()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a set of all available header names</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="containsHeader-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>containsHeader</h4> | |
| <pre>public abstract boolean containsHeader(<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> header)</pre> | |
| <div class="block">Case insensitive check if the header is available in this ODataResponse</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>header</code> - header name</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true/false</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="status-org.apache.olingo.odata2.api.commons.HttpStatusCodes-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>status</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> status(<a href="../../../../../../org/apache/olingo/odata2/api/commons/HttpStatusCodes.html" title="enum in org.apache.olingo.odata2.api.commons">HttpStatusCodes</a> status)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>status</code> - HTTP status code</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a builder object</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="fromResponse-org.apache.olingo.odata2.api.processor.ODataResponse-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>fromResponse</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> fromResponse(<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a> response)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>response</code> - </dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a new builder object</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="entity-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>entity</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> entity(<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> entity)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>entity</code> - </dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a builder object</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="header-java.lang.String-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>header</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> header(<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> name, | |
| <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> value)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - HTTP header name</dd> | |
| <dd><code>value</code> - associated value</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a builder object</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="contentHeader-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>contentHeader</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> contentHeader(<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> value)</pre> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>value</code> - content header value</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a builder object</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="newBuilder--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>newBuilder</h4> | |
| <pre>public static <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a> newBuilder()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>returns a new builder object</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/ODataResponse.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/odata2/api/processor/ODataRequest.ODataRequestBuilder.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/ODataResponse.html" target="_top">Frames</a></li> | |
| <li><a href="ODataResponse.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: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> | |
| </body> | |
| </html> |