http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/rest/StreamResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/StreamResource.html b/content/site/apidocs/org/apache/juneau/rest/StreamResource.html index bfdf08e..5cc99cd 100644 --- a/content/site/apidocs/org/apache/juneau/rest/StreamResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/StreamResource.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/RestUtils.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> +<li><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.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.html" target="_top">Frames</a></li> @@ -73,7 +73,7 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> @@ -112,18 +112,44 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.27">StreamResource</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.32">StreamResource</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> implements <a href="../../../../org/apache/juneau/Streamable.html" title="interface in org.apache.juneau">Streamable</a></pre> <div class="block">Represents the contents of a byte stream file with convenience methods for adding HTTP response headers. <p> - This class is handled special by the <a href="../../../../org/apache/juneau/rest/response/StreamableHandler.html" title="class in org.apache.juneau.rest.response"><code>StreamableHandler</code></a> class.</div> + The purpose of this class is to maintain an in-memory reusable byte array of a streamed resource for + the fastest possible streaming. + Therefore, this object is designed to be reused and thread-safe. + <p> + This class is handled special by the <a href="../../../../org/apache/juneau/rest/response/StreamableHandler.html" title="class in org.apache.juneau.rest.response"><code>StreamableHandler</code></a> class. + This allows these objects to be returned as responses by REST methods.</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/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a></span></code> +<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> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> @@ -136,14 +162,15 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <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.html#StreamResource-byte:A-java.lang.String-">StreamResource</a></span>(byte[] contents, - <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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.html#StreamResource-org.apache.juneau.MediaType-java.util.Map-java.lang.Object...-">StreamResource</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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, + <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">Constructor.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.html#StreamResource-java.io.InputStream-java.lang.String-">StreamResource</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> contents, - <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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.html#StreamResource-org.apache.juneau.MediaType-java.lang.Object...-">StreamResource</a></span>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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">Constructor.</div> </td> </tr> @@ -169,19 +196,12 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code><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></code></td> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.html#getMediaType--">getMediaType</a></span>()</code> <div class="block">Returns the serialized media type for this resource (e.g.</div> </td> </tr> <tr id="i2" 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.html#setHeader-java.lang.String-java.lang.Object-">setHeader</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">Add an HTTP response header.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/StreamResource.html#streamTo-java.io.OutputStream-">streamTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> os)</code> <div class="block">Serialize this object to the specified output stream.</div> @@ -209,39 +229,59 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <!-- --> </a> <h3>Constructor Detail</h3> -<a name="StreamResource-byte:A-java.lang.String-"> +<a name="StreamResource-org.apache.juneau.MediaType-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>StreamResource</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.40">StreamResource</a>(byte[] contents, - <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">Constructor. - Create a stream resource from a byte array.</div> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.53">StreamResource</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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) + 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">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>contents</code> - The resource contents.</dd> <dd><code>mediaType</code> - The resource media type.</dd> +<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="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> -<a name="StreamResource-java.io.InputStream-java.lang.String-"> +<a name="StreamResource-org.apache.juneau.MediaType-java.util.Map-java.lang.Object...-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>StreamResource</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.54">StreamResource</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> contents, - <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>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.73">StreamResource</a>(<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> mediaType, + <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, + <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) 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">Constructor. - Create a stream resource from an <code>InputStream</code>. - Contents of stream will be loaded into a reusable byte array.</div> +<div class="block">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>contents</code> - The resource contents.</dd> <dd><code>mediaType</code> - The resource media type.</dd> +<dd><code>headers</code> - The HTTP response headers for this streamed resource.</dd> +<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="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> @@ -255,35 +295,17 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <!-- --> </a> <h3>Method Detail</h3> -<a name="setHeader-java.lang.String-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setHeader</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.html#line.66">setHeader</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">Add an HTTP response header.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - The header name.</dd> -<dd><code>value</code> - The header value, converted to a string 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="getHeaders--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHeaders</h4> -<pre>public <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/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.76">getHeaders</a>()</pre> +<pre>public <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/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.192">getHeaders</a>()</pre> <div class="block">Get the HTTP response headers.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The HTTP response headers. Never <jk>null</jk>.</dd> +<dd>The HTTP response headers. An unmodifiable map. Never <jk>null</jk>.</dd> </dl> </li> </ul> @@ -293,7 +315,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockList"> <li class="blockList"> <h4>streamTo</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.81">streamTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> os) +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.197">streamTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> os) 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Streamable.html#streamTo-java.io.OutputStream-">Streamable</a></code></span></div> <div class="block">Serialize this object to the specified output stream.</div> @@ -313,7 +335,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockListLast"> <li class="blockList"> <h4>getMediaType</h4> -<pre>public <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="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.86">getMediaType</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.203">getMediaType</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Streamable.html#getMediaType--">Streamable</a></code></span></div> <div class="block">Returns the serialized media type for this resource (e.g. <js>"text/html"</js>).</div> <dl> @@ -352,7 +374,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/RestUtils.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> +<li><a href="../../../../org/apache/juneau/rest/StreamResource.Builder.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.html" target="_top">Frames</a></li> @@ -376,7 +398,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html b/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html index 509d55f..6827920 100644 --- a/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html +++ b/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </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/StreamResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> @@ -166,22 +166,34 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#equals-java.lang.Object-">equals</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> o)</code> </td> </tr> <tr id="i2" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#getPatternString--">getPatternString</a></span>()</code> +<div class="block">Bean property getter: <property>patternString</property>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><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>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#getVars--">getVars</a></span>()</code> +<div class="block">Bean property getter: <property>vars</property>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>protected <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>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#match-java.lang.String-">match</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> path)</code> <div class="block">Returns a non-<jk>null</jk> value if the specified path matches this pattern.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#toRegEx--">toRegEx</a></span>()</code> <div class="block">Returns this path pattern as the compiled regular expression.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/UrlPathPattern.html#toString--">toString</a></span>()</code> </td> </tr> @@ -213,7 +225,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockListLast"> <li class="blockList"> <h4>UrlPathPattern</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.39">UrlPathPattern</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> patternString)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.40">UrlPathPattern</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> patternString)</pre> <div class="block">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -235,7 +247,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>match</h4> -<pre>protected <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.71">match</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> path)</pre> +<pre>protected <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.85">match</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> path)</pre> <div class="block">Returns a non-<jk>null</jk> value if the specified path matches this pattern.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -253,7 +265,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.116">compareTo</a>(<a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest">UrlPathPattern</a> o)</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.130">compareTo</a>(<a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest">UrlPathPattern</a> o)</pre> <div class="block">Comparator for this object. The comparator is designed to order URL pattern from most-specific to least-specific. For example, the following patterns would be ordered as follows: @@ -279,7 +291,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>equals</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.134">equals</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> o)</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.148">equals</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> o)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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></code> in class <code><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></code></dd> @@ -292,7 +304,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.141">hashCode</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.155">hashCode</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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></code> in class <code><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></code></dd> @@ -305,7 +317,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>toString</h4> -<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.146">toString</a>()</pre> +<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.160">toString</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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></code> in class <code><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></code></dd> @@ -315,10 +327,10 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <a name="toRegEx--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>toRegEx</h4> -<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.156">toRegEx</a>()</pre> +<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.170">toRegEx</a>()</pre> <div class="block">Returns this path pattern as the compiled regular expression. Useful for debugging.</div> <dl> @@ -327,6 +339,34 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl </dl> </li> </ul> +<a name="getVars--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVars</h4> +<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.178">getVars</a>()</pre> +<div class="block">Bean property getter: <property>vars</property>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>vars</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="getPatternString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPatternString</h4> +<pre>public <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="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.186">getPatternString</a>()</pre> +<div class="block">Bean property getter: <property>patternString</property>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>patternString</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> </li> </ul> </li> @@ -354,7 +394,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl </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/StreamResource.Builder.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/756ffe72/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html index 23fd0d0..303ad4a 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -1010,7 +1010,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>stylesheet</h4> -<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.517">stylesheet</a></pre> +<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.521">stylesheet</a></pre> <div class="block">The stylesheet to use for HTML views. <p> The name is a path to a stylesheet located in either the classpath or working directory. @@ -1049,8 +1049,12 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ol> <li><code>com.foo.mypackage.mystyles</code> package. <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>). - <li><code>[working-dir]/mystyles</code> directory. - </ol></div> + <li><code>[working-dir]/mystyles</code> directory. + </ol> + <p> + Multiple stylesheets can be specified as a comma-delimited list. + When multiple stylesheets are specified, their contents will be concatenated and return in the order specified + in the list.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -1066,7 +1070,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>favicon</h4> -<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.547">favicon</a></pre> +<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.551">favicon</a></pre> <div class="block">The favicon to use for HTML views. <p> The name is a path to an icon file located in either the classpath or working directory in a similar way @@ -1108,7 +1112,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>staticFiles</h4> -<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.581">staticFiles</a></pre> +<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.585">staticFiles</a></pre> <div class="block">Defines paths and locations of statically served files. <p> This is a JSON map of paths to packages/directories located on either the classpath or working directory. @@ -1154,7 +1158,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>clientVersionHeader</h4> -<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.591">clientVersionHeader</a></pre> +<pre>public abstract <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="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.595">clientVersionHeader</a></pre> <div class="block">Specifies the HTTP header name used to identify the client version. <p> The client version is used to support backwards compatibility for breaking REST interface
