New classes in Javadoc. Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/commit/70077347 Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/tree/70077347 Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/diff/70077347
Branch: refs/heads/asf-site Commit: 70077347e8165bebb0ecc94691c1a90096595948 Parents: 756ffe7 Author: JamesBognar <[email protected]> Authored: Tue Feb 28 14:28:33 2017 -0500 Committer: JamesBognar <[email protected]> Committed: Tue Feb 28 14:28:33 2017 -0500 ---------------------------------------------------------------------- .../juneau/rest/ReaderResource.Builder.html | 430 +++++++++++++++++++ .../juneau/rest/StreamResource.Builder.html | 409 ++++++++++++++++++ .../juneau/rest/ReaderResource.Builder.html | 303 +++++++++++++ .../juneau/rest/StreamResource.Builder.html | 278 ++++++++++++ 4 files changed, 1420 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/70077347/content/site/apidocs/org/apache/juneau/rest/ReaderResource.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/ReaderResource.Builder.html b/content/site/apidocs/org/apache/juneau/rest/ReaderResource.Builder.html new file mode 100644 index 0000000..464c33e --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/ReaderResource.Builder.html @@ -0,0 +1,430 @@ +<!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 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ReaderResource.Builder (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="ReaderResource.Builder (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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"; +</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="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/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/ReaderResource.Builder.html" target="_top">Frames</a></li> +<li><a href="ReaderResource.Builder.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>Nested | </li> +<li>Field | </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>Field | </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.juneau.rest</div> +<h2 title="Class ReaderResource.Builder" class="title">Class ReaderResource.Builder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.juneau.rest.ReaderResource.Builder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a></dd> +</dl> +<hr> +<br> +<pre>public static class <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.html#line.102">ReaderResource.Builder</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Builder class for constructing <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><code>ReaderResource</code></a> objects.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#Builder--">Builder</a></span>()</code> </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#build--">build</a></span>()</code> +<div class="block">Create a new <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><code>ReaderResource</code></a> using values in this builder.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#contents-java.lang.Object...-">contents</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... contents)</code> +<div class="block">Specifies the contents for this resource.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#header-java.lang.String-java.lang.Object-">header</a></span>(<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Specifies an HTTP response header value.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#headers-java.util.Map-">headers</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> headers)</code> +<div class="block">Specifies HTTP response header values.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#mediaType-org.apache.juneau.MediaType-">mediaType</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</code> +<div class="block">Specifies the resource media type string.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#mediaType-java.lang.String-">mediaType</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> +<div class="block">Specifies the resource media type string.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html#varResolver-org.apache.juneau.svl.VarResolverSession-">varResolver</a></span>(<a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varResolver)</code> +<div class="block">Specifies the variable resolver to use for this resource.</div> +</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Builder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Builder</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.102">Builder</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="mediaType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mediaType</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.113">mediaType</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</pre> +<div class="block">Specifies the resource media type string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mediaType</code> - The resource media type string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="mediaType-org.apache.juneau.MediaType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mediaType</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.123">mediaType</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</pre> +<div class="block">Specifies the resource media type string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mediaType</code> - The resource media type string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="contents-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contents</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.144">contents</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... contents)</pre> +<div class="block">Specifies the contents for this resource. + <p> + This method can be called multiple times to add more content.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contents</code> - The resource contents. + <br>If multiple contents are specified, the results will be concatenated. + <br>Contents can be any of the following: + <ul> + <li><code>InputStream</code> + <li><code>Reader</code> - Converted to UTF-8 bytes. + <li><code>File</code> + <li><code>CharSequence</code> - Converted to UTF-8 bytes. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="header-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>header</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.156">header</a>(<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Specifies an HTTP response header value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The HTTP header name.</dd> +<dd><code>value</code> - The HTTP header value. Will be converted to a <code>String</code> using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="headers-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>headers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.167">headers</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> headers)</pre> +<div class="block">Specifies HTTP response header values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>headers</code> - The HTTP headers. Values will be converted to <code>Strings</code> using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="varResolver-org.apache.juneau.svl.VarResolverSession-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>varResolver</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.Builder.html" title="class in org.apache.juneau.rest">ReaderResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.179">varResolver</a>(<a href="../../../../org/apache/juneau/svl/VarResolverSession.html" title="class in org.apache.juneau.svl">VarResolverSession</a> varResolver)</pre> +<div class="block">Specifies the variable resolver to use for this resource.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>varResolver</code> - The variable resolver.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest">ReaderResource</a> <a href="../../../../src-html/org/apache/juneau/rest/ReaderResource.Builder.html#line.190">build</a>() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Create a new <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><code>ReaderResource</code></a> using values in this builder.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new immutable <a href="../../../../org/apache/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><code>ReaderResource</code></a> object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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="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/juneau/rest/ReaderResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/ReaderResource.Builder.html" target="_top">Frames</a></li> +<li><a href="ReaderResource.Builder.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>Nested | </li> +<li>Field | </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>Field | </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 © 2017 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/70077347/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html b/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html new file mode 100644 index 0000000..b2c5c09 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html @@ -0,0 +1,409 @@ +<!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 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>StreamResource.Builder (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="StreamResource.Builder (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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"; +</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="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/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/StreamResource.Builder.html" target="_top">Frames</a></li> +<li><a href="StreamResource.Builder.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>Nested | </li> +<li>Field | </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>Field | </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.juneau.rest</div> +<h2 title="Class StreamResource.Builder" class="title">Class StreamResource.Builder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.juneau.rest.StreamResource.Builder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a></dd> +</dl> +<hr> +<br> +<pre>public static class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.106">StreamResource.Builder</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Builder class for constructing <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> objects.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#Builder--">Builder</a></span>()</code> </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#build--">build</a></span>()</code> +<div class="block">Create a new <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> using values in this builder.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#contents-java.lang.Object...-">contents</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... contents)</code> +<div class="block">Specifies the contents for this resource.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#header-java.lang.String-java.lang.Object-">header</a></span>(<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Specifies an HTTP response header value.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#headers-java.util.Map-">headers</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> headers)</code> +<div class="block">Specifies HTTP response header values.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#mediaType-org.apache.juneau.MediaType-">mediaType</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</code> +<div class="block">Specifies the resource media type string.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html#mediaType-java.lang.String-">mediaType</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> +<div class="block">Specifies the resource media type string.</div> +</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Builder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Builder</h4> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.106">Builder</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="mediaType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mediaType</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.116">mediaType</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</pre> +<div class="block">Specifies the resource media type string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mediaType</code> - The resource media type string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="mediaType-org.apache.juneau.MediaType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mediaType</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.126">mediaType</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType)</pre> +<div class="block">Specifies the resource media type string.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mediaType</code> - The resource media type string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="contents-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contents</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.148">contents</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... contents)</pre> +<div class="block">Specifies the contents for this resource. + <p> + This method can be called multiple times to add more content.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contents</code> - The resource contents. + <br>If multiple contents are specified, the results will be concatenated. + <br>Contents can be any of the following: + <ul> + <li><code><jk>byte</jk>[]</code> + <li><code>InputStream</code> + <li><code>Reader</code> - Converted to UTF-8 bytes. + <li><code>File</code> + <li><code>CharSequence</code> - Converted to UTF-8 bytes. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="header-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>header</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.160">header</a>(<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Specifies an HTTP response header value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The HTTP header name.</dd> +<dd><code>value</code> - The HTTP header value. Will be converted to a <code>String</code> using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="headers-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>headers</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.171">headers</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> headers)</pre> +<div class="block">Specifies HTTP response header values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>headers</code> - The HTTP headers. Values will be converted to <code>Strings</code> using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.183">build</a>() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Create a new <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> using values in this builder.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new immutable <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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="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/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/StreamResource.Builder.html" target="_top">Frames</a></li> +<li><a href="StreamResource.Builder.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>Nested | </li> +<li>Field | </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>Field | </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 © 2017 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/70077347/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.Builder.html b/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.Builder.html new file mode 100644 index 0000000..10bb134 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/ReaderResource.Builder.html @@ -0,0 +1,303 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.rest;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.internal.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.rest.annotation.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.rest.response.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.svl.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Represents the contents of a text file with convenience methods for resolving<a name="line.25"></a> +<span class="sourceLineNo">026</span> * {@link Parameter} variables and adding HTTP response headers.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * This class is handled special by the {@link WritableHandler} class.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>public class ReaderResource implements Writable {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> private final MediaType mediaType;<a name="line.32"></a> +<span class="sourceLineNo">033</span> private final String[] contents;<a name="line.33"></a> +<span class="sourceLineNo">034</span> private final VarResolverSession varSession;<a name="line.34"></a> +<span class="sourceLineNo">035</span> private final Map<String,String> headers;<a name="line.35"></a> +<span class="sourceLineNo">036</span><a name="line.36"></a> +<span class="sourceLineNo">037</span> /**<a name="line.37"></a> +<span class="sourceLineNo">038</span> * Constructor.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @param mediaType The HTTP media type.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param contents The contents of this resource.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <br>Contents can be any of the following:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <ul><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li><code>CharSequence</code><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><code>Reader</code><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li><code>File</code><a name="line.46"></a> +<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> +<span class="sourceLineNo">048</span> * @throws IOException<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> protected ReaderResource(MediaType mediaType, Object...contents) throws IOException {<a name="line.50"></a> +<span class="sourceLineNo">051</span> this(mediaType, null, null, contents);<a name="line.51"></a> +<span class="sourceLineNo">052</span> }<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Constructor.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param mediaType The resource media type.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param headers The HTTP response headers for this streamed resource.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param varSession Optional variable resolver for resolving variables in the string.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param contents The resource contents.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <br>Contents can be any of the following:<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <li><code>InputStream</code><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li><code>File</code><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * </ul><a name="line.67"></a> +<span class="sourceLineNo">068</span> * @throws IOException<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public ReaderResource(MediaType mediaType, Map<String,Object> headers, VarResolverSession varSession, Object...contents) throws IOException {<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.mediaType = mediaType;<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.varSession = varSession;<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> Map<String,String> m = new LinkedHashMap<String,String>();<a name="line.74"></a> +<span class="sourceLineNo">075</span> if (headers != null)<a name="line.75"></a> +<span class="sourceLineNo">076</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.76"></a> +<span class="sourceLineNo">077</span> m.put(e.getKey(), StringUtils.toString(e.getValue()));<a name="line.77"></a> +<span class="sourceLineNo">078</span> this.headers = Collections.unmodifiableMap(m);<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> this.contents = new String[contents.length];<a name="line.80"></a> +<span class="sourceLineNo">081</span> for (int i = 0; i < contents.length; i++) {<a name="line.81"></a> +<span class="sourceLineNo">082</span> Object c = contents[i];<a name="line.82"></a> +<span class="sourceLineNo">083</span> if (c == null)<a name="line.83"></a> +<span class="sourceLineNo">084</span> this.contents[i] = "";<a name="line.84"></a> +<span class="sourceLineNo">085</span> else if (c instanceof InputStream)<a name="line.85"></a> +<span class="sourceLineNo">086</span> this.contents[i] = IOUtils.read((InputStream)c);<a name="line.86"></a> +<span class="sourceLineNo">087</span> else if (c instanceof File)<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.contents[i] = IOUtils.read((File)c);<a name="line.88"></a> +<span class="sourceLineNo">089</span> else if (c instanceof Reader)<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.contents[i] = IOUtils.read((Reader)c);<a name="line.90"></a> +<span class="sourceLineNo">091</span> else if (c instanceof CharSequence)<a name="line.91"></a> +<span class="sourceLineNo">092</span> this.contents[i] = ((CharSequence)c).toString();<a name="line.92"></a> +<span class="sourceLineNo">093</span> else<a name="line.93"></a> +<span class="sourceLineNo">094</span> throw new IOException("Invalid class type passed to ReaderResource: " + c.getClass().getName());<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span> }<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * Builder class for constructing {@link ReaderResource} objects.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> @SuppressWarnings("hiding")<a name="line.101"></a> +<span class="sourceLineNo">102</span> public static class Builder {<a name="line.102"></a> +<span class="sourceLineNo">103</span> ArrayList<Object> contents = new ArrayList<Object>();<a name="line.103"></a> +<span class="sourceLineNo">104</span> MediaType mediaType;<a name="line.104"></a> +<span class="sourceLineNo">105</span> VarResolverSession varResolver;<a name="line.105"></a> +<span class="sourceLineNo">106</span> Map<String,String> headers = new LinkedHashMap<String,String>();<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> /**<a name="line.108"></a> +<span class="sourceLineNo">109</span> * Specifies the resource media type string.<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param mediaType The resource media type string.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return This object (for method chaining).<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> public Builder mediaType(String mediaType) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> this.mediaType = MediaType.forString(mediaType);<a name="line.114"></a> +<span class="sourceLineNo">115</span> return this;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Specifies the resource media type string.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param mediaType The resource media type string.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return This object (for method chaining).<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public Builder mediaType(MediaType mediaType) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> this.mediaType = mediaType;<a name="line.124"></a> +<span class="sourceLineNo">125</span> return this;<a name="line.125"></a> +<span class="sourceLineNo">126</span> }<a name="line.126"></a> +<span class="sourceLineNo">127</span><a name="line.127"></a> +<span class="sourceLineNo">128</span> /**<a name="line.128"></a> +<span class="sourceLineNo">129</span> * Specifies the contents for this resource.<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <p><a name="line.130"></a> +<span class="sourceLineNo">131</span> * This method can be called multiple times to add more content.<a name="line.131"></a> +<span class="sourceLineNo">132</span> *<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param contents The resource contents.<a name="line.133"></a> +<span class="sourceLineNo">134</span> * <br>If multiple contents are specified, the results will be concatenated.<a name="line.134"></a> +<span class="sourceLineNo">135</span> * <br>Contents can be any of the following:<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <ul><a name="line.136"></a> +<span class="sourceLineNo">137</span> * <li><code>InputStream</code><a name="line.137"></a> +<span class="sourceLineNo">138</span> * <li><code>Reader</code> - Converted to UTF-8 bytes.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <li><code>File</code><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li><code>CharSequence</code> - Converted to UTF-8 bytes.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * </ul><a name="line.141"></a> +<span class="sourceLineNo">142</span> * @return This object (for method chaining).<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public Builder contents(Object...contents) {<a name="line.144"></a> +<span class="sourceLineNo">145</span> this.contents.addAll(Arrays.asList(contents));<a name="line.145"></a> +<span class="sourceLineNo">146</span> return this;<a name="line.146"></a> +<span class="sourceLineNo">147</span> }<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> /**<a name="line.149"></a> +<span class="sourceLineNo">150</span> * Specifies an HTTP response header value.<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param name The HTTP header name.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @param value The HTTP header value. Will be converted to a <code>String</code> using {@link Object#toString()}.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * @return This object (for method chaining).<a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span> public Builder header(String name, Object value) {<a name="line.156"></a> +<span class="sourceLineNo">157</span> this.headers.put(name, StringUtils.toString(value));<a name="line.157"></a> +<span class="sourceLineNo">158</span> return this;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Specifies HTTP response header values.<a name="line.162"></a> +<span class="sourceLineNo">163</span> *<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @param headers The HTTP headers. Values will be converted to <code>Strings</code> using {@link Object#toString()}.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @return This object (for method chaining).<a name="line.165"></a> +<span class="sourceLineNo">166</span> */<a name="line.166"></a> +<span class="sourceLineNo">167</span> public Builder headers(Map<String,Object> headers) {<a name="line.167"></a> +<span class="sourceLineNo">168</span> for (Map.Entry<String,Object> e : headers.entrySet())<a name="line.168"></a> +<span class="sourceLineNo">169</span> header(e.getKey(), e.getValue());<a name="line.169"></a> +<span class="sourceLineNo">170</span> return this;<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Specifies the variable resolver to use for this resource.<a name="line.174"></a> +<span class="sourceLineNo">175</span> *<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param varResolver The variable resolver.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @return This object (for method chaining).<a name="line.177"></a> +<span class="sourceLineNo">178</span> */<a name="line.178"></a> +<span class="sourceLineNo">179</span> public Builder varResolver(VarResolverSession varResolver) {<a name="line.179"></a> +<span class="sourceLineNo">180</span> this.varResolver = varResolver;<a name="line.180"></a> +<span class="sourceLineNo">181</span> return this;<a name="line.181"></a> +<span class="sourceLineNo">182</span> }<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> /**<a name="line.184"></a> +<span class="sourceLineNo">185</span> * Create a new {@link ReaderResource} using values in this builder.<a name="line.185"></a> +<span class="sourceLineNo">186</span> *<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return A new immutable {@link ReaderResource} object.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @throws IOException<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> public ReaderResource build() throws IOException {<a name="line.190"></a> +<span class="sourceLineNo">191</span> return new ReaderResource(mediaType, headers, varResolver, contents.toArray());<a name="line.191"></a> +<span class="sourceLineNo">192</span> }<a name="line.192"></a> +<span class="sourceLineNo">193</span> }<a name="line.193"></a> +<span class="sourceLineNo">194</span><a name="line.194"></a> +<span class="sourceLineNo">195</span> /**<a name="line.195"></a> +<span class="sourceLineNo">196</span> * Get the HTTP response headers.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @return The HTTP response headers.<a name="line.198"></a> +<span class="sourceLineNo">199</span> */<a name="line.199"></a> +<span class="sourceLineNo">200</span> public Map<String,String> getHeaders() {<a name="line.200"></a> +<span class="sourceLineNo">201</span> return headers;<a name="line.201"></a> +<span class="sourceLineNo">202</span> }<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> @Override /* Writeable */<a name="line.204"></a> +<span class="sourceLineNo">205</span> public void writeTo(Writer w) throws IOException {<a name="line.205"></a> +<span class="sourceLineNo">206</span> for (String s : contents) {<a name="line.206"></a> +<span class="sourceLineNo">207</span> if (varSession != null)<a name="line.207"></a> +<span class="sourceLineNo">208</span> varSession.resolveTo(s, w);<a name="line.208"></a> +<span class="sourceLineNo">209</span> else<a name="line.209"></a> +<span class="sourceLineNo">210</span> w.write(s);<a name="line.210"></a> +<span class="sourceLineNo">211</span> }<a name="line.211"></a> +<span class="sourceLineNo">212</span> }<a name="line.212"></a> +<span class="sourceLineNo">213</span><a name="line.213"></a> +<span class="sourceLineNo">214</span> @Override /* Writeable */<a name="line.214"></a> +<span class="sourceLineNo">215</span> public MediaType getMediaType() {<a name="line.215"></a> +<span class="sourceLineNo">216</span> return mediaType;<a name="line.216"></a> +<span class="sourceLineNo">217</span> }<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> @Override /* Object */<a name="line.219"></a> +<span class="sourceLineNo">220</span> public String toString() {<a name="line.220"></a> +<span class="sourceLineNo">221</span> if (contents.length == 1 && varSession == null)<a name="line.221"></a> +<span class="sourceLineNo">222</span> return contents[0];<a name="line.222"></a> +<span class="sourceLineNo">223</span> StringWriter sw = new StringWriter();<a name="line.223"></a> +<span class="sourceLineNo">224</span> for (String s : contents) {<a name="line.224"></a> +<span class="sourceLineNo">225</span> if (varSession != null)<a name="line.225"></a> +<span class="sourceLineNo">226</span> return varSession.resolve(s);<a name="line.226"></a> +<span class="sourceLineNo">227</span> sw.write(s);<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span> return sw.toString();<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span>}<a name="line.231"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
