Plan/api/com/djrapitops/plan/delivery/web/resolver/ResponseBuilder.html

496 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ResponseBuilder (api 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResponseBuilder (api 5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.delivery.web.resolver</a></div>
<h2 title="Class ResponseBuilder" class="title">Class ResponseBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.web.resolver.ResponseBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ResponseBuilder</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ResponseBuilder.InvalidResponseException.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder.InvalidResponseException</a></span></code></th>
<td class="colLast">
<div class="block">Thrown when <a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>ResponseBuilder</code></a> is missing some parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Finish building.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#redirectTo(java.lang.String)">redirectTo</a></span>&#8203;(java.lang.String&nbsp;url)</code></th>
<td class="colLast">
<div class="block">Utility method for building redirects.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContent(byte%5B%5D)">setContent</a></span>&#8203;(byte[]&nbsp;bytes)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContent(com.djrapitops.plan.delivery.web.resource.WebResource)">setContent</a></span>&#8203;(<a href="../resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;resource)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContent(java.lang.String)">setContent</a></span>&#8203;(java.lang.String&nbsp;utf8String)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContent(java.lang.String,java.nio.charset.Charset)">setContent</a></span>&#8203;(java.lang.String&nbsp;content,
java.nio.charset.Charset&nbsp;charset)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeader(java.lang.String,java.lang.Object)">setHeader</a></span>&#8203;(java.lang.String&nbsp;header,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set HTTP Response header.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJSONContent(java.lang.Object)">setJSONContent</a></span>&#8203;(java.lang.Object&nbsp;objectToSerialize)</code></th>
<td class="colLast">
<div class="block">Set content as serialized JSON object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJSONContent(java.lang.String)">setJSONContent</a></span>&#8203;(java.lang.String&nbsp;json)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMimeType(java.lang.String)">setMimeType</a></span>&#8203;(java.lang.String&nbsp;mimeType)</code></th>
<td class="colLast">
<div class="block">Set MIME Type of the Response.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatus(int)">setStatus</a></span>&#8203;(int&nbsp;code)</code></th>
<td class="colLast">
<div class="block">Set HTTP Status code.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setMimeType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMimeType</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setMimeType&#8203;(java.lang.String&nbsp;mimeType)</pre>
<div class="block">Set MIME Type of the Response.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mimeType</code> - MIME type of the Response https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this builder.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="MimeType.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>for common MIME types.</code></a></dd>
</dl>
</li>
</ul>
<a id="setStatus(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatus</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setStatus&#8203;(int&nbsp;code)</pre>
<div class="block">Set HTTP Status code.
<p>
Default status code is 200 (OK) if not set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>code</code> - 1xx, 2xx, 3xx, 4xx, 5xx, https://developer.mozilla.org/en-US/docs/Web/HTTP/Status</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this builder.</dd>
</dl>
</li>
</ul>
<a id="setHeader(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeader</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setHeader&#8203;(java.lang.String&nbsp;header,
java.lang.Object&nbsp;value)</pre>
<div class="block">Set HTTP Response header.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>header</code> - Key of the header. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers</dd>
<dd><code>value</code> - Value for the header.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this builder.</dd>
</dl>
</li>
</ul>
<a id="redirectTo(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectTo</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;redirectTo&#8203;(java.lang.String&nbsp;url)</pre>
<div class="block">Utility method for building redirects.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - URL to redirect the client to with 302 Found.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location</dd>
</dl>
</li>
</ul>
<a id="setContent(com.djrapitops.plan.delivery.web.resource.WebResource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setContent&#8203;(<a href="../resource/WebResource.html" title="interface in com.djrapitops.plan.delivery.web.resource">WebResource</a>&nbsp;resource)</pre>
</li>
</ul>
<a id="setContent(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setContent&#8203;(byte[]&nbsp;bytes)</pre>
</li>
</ul>
<a id="setContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setContent&#8203;(java.lang.String&nbsp;utf8String)</pre>
</li>
</ul>
<a id="setContent(java.lang.String,java.nio.charset.Charset)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setContent&#8203;(java.lang.String&nbsp;content,
java.nio.charset.Charset&nbsp;charset)</pre>
</li>
</ul>
<a id="setJSONContent(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJSONContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setJSONContent&#8203;(java.lang.Object&nbsp;objectToSerialize)</pre>
<div class="block">Set content as serialized JSON object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectToSerialize</code> - Object to serialize into JSON with Gson. If the object is a String it is assumed to be valid JSON.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this builder.</dd>
</dl>
</li>
</ul>
<a id="setJSONContent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJSONContent</h4>
<pre class="methodSignature">public&nbsp;<a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a>&nbsp;setJSONContent&#8203;(java.lang.String&nbsp;json)</pre>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>&nbsp;build()</pre>
<div class="block">Finish building.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="ResponseBuilder.InvalidResponseException.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder.InvalidResponseException</a></code> - if content was not defined (not even empty byte array).</dd>
<dd><code><a href="ResponseBuilder.InvalidResponseException.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder.InvalidResponseException</a></code> - if content has bytes, but MIME-type is not defined.</dd>
<dd><code><a href="ResponseBuilder.InvalidResponseException.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder.InvalidResponseException</a></code> - if status code is outside range 100-599.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setMimeType(java.lang.String)"><code>to set MIME-type.</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>