http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/Accept.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/Accept.html b/content/site/apidocs/org/apache/juneau/http/Accept.html index 03e5bcb..3e6b664 100644 --- a/content/site/apidocs/org/apache/juneau/http/Accept.html +++ b/content/site/apidocs/org/apache/juneau/http/Accept.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10}; +var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> -<li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/http/Accept.html" target="_top">Frames</a></li> @@ -108,20 +108,24 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.123">Accept</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.127">Accept</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">Represents a parsed <code>Accept:</code> HTTP header. +<div class="block">Represents a parsed <l>Accept</l> HTTP request header. <p> - The formal RFC2616 header field definition is as follows: + Content-Types that are acceptable for the response. + + <h6 class='figure'>Example</h6> <p class='bcode'> - 14.1 Accept + Accept: text/plain + </p> + + <h6 class='topic'>RFC2616 Specification</h6> - The Accept request-header field can be used to specify certain media - types which are acceptable for the response. Accept headers can be - used to indicate that the request is specifically limited to a small - set of desired types, as in the case of a request for an in-line - image. + The Accept request-header field can be used to specify certain media types which are acceptable for the response. + Accept headers can be used to indicate that the request is specifically limited to a small set of desired types, as + in the case of a request for an in-line image. + <p class='bcode'> Accept = "Accept" ": #( media-range [ accept-params ] ) @@ -131,86 +135,85 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? ) *( ";" parameter ) accept-params = ";" "q" "=" qvalue *( accept-extension ) accept-extension = ";" token [ "=" ( token | quoted-string ) ] - - The asterisk "*" character is used to group media types into ranges, - with "* /*" indicating all media types and "type/*" indicating all - subtypes of that type. The media-range MAY include media type - parameters that are applicable to that range. - - Each media-range MAY be followed by one or more accept-params, - beginning with the "q" parameter for indicating a relative quality - factor. The first "q" parameter (if any) separates the media-range - parameter(s) from the accept-params. Quality factors allow the user - or user agent to indicate the relative degree of preference for that - media-range, using the qvalue scale from 0 to 1 (section 3.9). The - default value is q=1. - - Note: Use of the "q" parameter name to separate media type - parameters from Accept extension parameters is due to historical - practice. Although this prevents any media type parameter named - "q" from being used with a media range, such an event is believed - to be unlikely given the lack of any "q" parameters in the IANA - media type registry and the rare usage of any media type - parameters in Accept. Future media types are discouraged from - registering any parameter named "q". - - The example - - Accept: audio/*; q=0.2, audio/basic - - SHOULD be interpreted as "I prefer audio/basic, but send me any audio - type if it is the best available after an 80% mark-down in quality." - - If no Accept header field is present, then it is assumed that the - client accepts all media types. If an Accept header field is present, - and if the server cannot send a response which is acceptable - according to the combined Accept field value, then the server SHOULD - send a 406 (not acceptable) response. - - A more elaborate example is - - Accept: text/plain; q=0.5, text/html, - text/x-dvi; q=0.8, text/x-c - - Verbally, this would be interpreted as "text/html and text/x-c are - the preferred media types, but if they do not exist, then send the - text/x-dvi entity, and if that does not exist, send the text/plain - entity." - - Media ranges can be overridden by more specific media ranges or - specific media types. If more than one media range applies to a given - type, the most specific reference has precedence. For example, - - Accept: text/ *, text/html, text/html;level=1, * /* - - have the following precedence: - - 1) text/html;level=1 - 2) text/html - 3) text/* - 4) * /* - - The media type quality factor associated with a given type is - determined by finding the media range with the highest precedence - which matches that type. For example, - - Accept: text/*;q=0.3, text/html;q=0.7, text/html;level=1, - text/html;level=2;q=0.4, * /*;q=0.5 - - would cause the following values to be associated: - - text/html;level=1 = 1 - text/html = 0.7 - text/plain = 0.3 - image/jpeg = 0.5 - text/html;level=2 = 0.4 - text/html;level=3 = 0.7 - - Note: A user agent might be provided with a default set of quality - values for certain media ranges. However, unless the user agent is - a closed system which cannot interact with other rendering agents, - this default set ought to be configurable by the user. - </p></div> + </p> + <p> + The asterisk "*" character is used to group media types into ranges, with "* /*" indicating all media types and + "type/*" indicating all subtypes of that type. + The media-range MAY include media type parameters that are applicable to that range. + <p> + Each media-range MAY be followed by one or more accept-params, beginning with the "q" parameter for indicating a + relative quality factor. + The first "q" parameter (if any) separates the media-range parameter(s) from the accept-params. + Quality factors allow the user or user agent to indicate the relative degree of preference for that media-range, + using the qvalue scale from 0 to 1 (section 3.9). + The default value is q=1. + <p> + Note: Use of the "q" parameter name to separate media type parameters from Accept extension parameters is due to + historical practice. + Although this prevents any media type parameter named "q" from being used with a media range, such an event is + believed to be unlikely given the lack of any "q" parameters in the IANA + media type registry and the rare usage of any media type parameters in Accept. + Future media types are discouraged from registering any parameter named "q". + <p> + The example + <p class='bcode'> + Accept: audio/*; q=0.2, audio/basic + </p> + <p> + SHOULD be interpreted as "I prefer audio/basic, but send me any audio type if it is the best available after an 80% + mark-down in quality." + <p> + If no Accept header field is present, then it is assumed that the client accepts all media types. + <p> + If an Accept header field is present, and if the server cannot send a response which is acceptable according to the + combined Accept field value, then the server SHOULD send a 406 (not acceptable) response. + <p> + A more elaborate example is + <p class='bcode'> + Accept: text/plain; q=0.5, text/html, + text/x-dvi; q=0.8, text/x-c + </p> + <p> + Verbally, this would be interpreted as "text/html and text/x-c are the preferred media types, but if they do not + exist, then send the + text/x-dvi entity, and if that does not exist, send the text/plain entity." + <p> + Media ranges can be overridden by more specific media ranges or specific media types. + If more than one media range applies to a given type, the most specific reference has precedence. + For example, + <p class='bcode'> + Accept: text/ *, text/html, text/html;level=1, * /* + </p> + <p> + have the following precedence: + <ol> + <li>text/html;level=1 + <li>text/html + <li>text/* + <li>* /* + </ol> + <p> + The media type quality factor associated with a given type is determined by finding the media range with the highest + precedence which matches that type. + For example, + <p class='bcode'> + Accept: text/*;q=0.3, text/html;q=0.7, text/html;level=1, + text/html;level=2;q=0.4, * /*;q=0.5 + </p> + <p> + would cause the following values to be associated: + <p class='bcode'> + text/html;level=1 = 1 + text/html = 0.7 + text/plain = 0.3 + image/jpeg = 0.5 + text/html;level=2 = 0.4 + text/html;level=3 = 0.7 + </p> + <p> + Note: A user agent might be provided with a default set of quality values for certain media ranges. + However, unless the user agent is a closed system which cannot interact with other rendering agents, this default + set ought to be configurable by the user.</div> </li> </ul> </div> @@ -230,23 +233,23 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#asRanges--">asRanges</a></span>()</code> +<div class="block">Returns the list of the media ranges that make up this header.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#findMatch-org.apache.juneau.http.MediaType:A-">findMatch</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>[] mediaTypes)</code> <div class="block">Given a list of media types, returns the best match for this <code>Accept</code> header.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http">Accept</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#forString-java.lang.String-">forString</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> s)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#forString-java.lang.String-">forString</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> value)</code> <div class="block">Returns a parsed <code>Accept</code> header.</div> </td> </tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#getMediaRanges--">getMediaRanges</a></span>()</code> -<div class="block">Returns the list of the media ranges that make up this header.</div> -</td> -</tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/Accept.html#hasSubtypePart-java.lang.String-">hasSubtypePart</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> part)</code> @@ -286,23 +289,23 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>forString</h4> -<pre>public static <a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http">Accept</a> <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.137">forString</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> s)</pre> +<pre>public static <a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http">Accept</a> <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.137">forString</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> value)</pre> <div class="block">Returns a parsed <code>Accept</code> header.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The <code>Accept</code> header string.</dd> +<dd><code>value</code> - The <code>Accept</code> header string.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.</dd> </dl> </li> </ul> -<a name="getMediaRanges--"> +<a name="asRanges--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getMediaRanges</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>> <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.168">getMediaRanges</a>()</pre> +<h4>asRanges</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>> <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.162">asRanges</a>()</pre> <div class="block">Returns the list of the media ranges that make up this header. <p> The media ranges in the list are sorted by their q-value in descending order.</div> @@ -318,7 +321,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>findMatch</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.189">findMatch</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>[] mediaTypes)</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.183">findMatch</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a>[] mediaTypes)</pre> <div class="block">Given a list of media types, returns the best match for this <code>Accept</code> header. <p> Note that fuzzy matching is allowed on the media types where the <code>Accept</code> header may @@ -345,7 +348,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>hasSubtypePart</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.224">hasSubtypePart</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> part)</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/http/Accept.html#line.218">hasSubtypePart</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> part)</pre> <div class="block">Convenience method for searching through all of the subtypes of all the media ranges in this header for the presence of a subtype fragment. <p> @@ -364,7 +367,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <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/http/Accept.html#line.234">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/http/Accept.html#line.228">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> @@ -399,7 +402,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/http/Accept.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/AcceptCharset.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/AcceptCharset.html b/content/site/apidocs/org/apache/juneau/http/AcceptCharset.html new file mode 100644 index 0000000..823ca46 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/AcceptCharset.html @@ -0,0 +1,296 @@ +<!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>AcceptCharset (Apache Juneau (incubating) 6.2.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="AcceptCharset (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/http/Accept.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptCharset.html" target="_top">Frames</a></li> +<li><a href="AcceptCharset.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.http</div> +<h2 title="Class AcceptCharset" class="title">Class AcceptCharset</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><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderRangeArray</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.AcceptCharset</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/AcceptCharset.html#line.60">AcceptCharset</a> +extends <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></pre> +<div class="block">Represents a parsed <l>Accept-Charset</l> HTTP request header. + <p> + Character sets that are acceptable. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + Accept-Charset: utf-8 + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response. + <p> + This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal + that capability to a server which is capable of representing documents in those character sets. + <p class='bcode'> + Accept-Charset = "Accept-Charset" ":" + 1#( ( charset | "*" )[ ";" "q" "=" qvalue ] ) + </p> + <p> + Character set values are described in section 3.4. Each charset MAY be given an associated quality value which + represents the user's preference for that charset. + The default value is q=1. + An example is... + <p class='bcode'> + Accept-Charset: iso-8859-5, unicode-1-1;q=0.8 + </p> + <p> + The special value "*", if present in the Accept-Charset field, matches every character set (including ISO-8859-1) + which is not mentioned elsewhere in the Accept-Charset field. + <p> + If no "*" is present in an Accept-Charset field, then all character sets not explicitly mentioned get a quality + value of 0, except for ISO-8859-1, which gets a quality value of 1 if not explicitly mentioned. + <p> + If no Accept-Charset header is present, the default is that any character set is acceptable. + <p> + If an Accept-Charset header is present, and if the server cannot send a response which is acceptable according to + the Accept-Charset header, then the server SHOULD send an error response with the 406 (not acceptable) status code, + though the sending of an unacceptable response is also allowed.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="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>static <a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http">AcceptCharset</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptCharset.html#forString-java.lang.String-">forString</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> value)</code> +<div class="block">Returns a parsed <code>Accept-Charset</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderRangeArray"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#asSimpleRanges--">asSimpleRanges</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#findMatch-java.lang.String:A-">findMatch</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#toString--">toString</a></code></li> +</ul> +<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#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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http">AcceptCharset</a> <a href="../../../../src-html/org/apache/juneau/http/AcceptCharset.html#line.70">forString</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> value)</pre> +<div class="block">Returns a parsed <code>Accept-Charset</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>Accept-Charset</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>Accept-Charset</code> header, or <jk>null</jk> if the string was null.</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/http/Accept.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptCharset.html" target="_top">Frames</a></li> +<li><a href="AcceptCharset.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/f1f17bc3/content/site/apidocs/org/apache/juneau/http/AcceptEncoding.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/AcceptEncoding.html b/content/site/apidocs/org/apache/juneau/http/AcceptEncoding.html index 473b714..fa5c898 100644 --- a/content/site/apidocs/org/apache/juneau/http/AcceptEncoding.html +++ b/content/site/apidocs/org/apache/juneau/http/AcceptEncoding.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -48,8 +48,8 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptLanguage.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/http/AcceptEncoding.html" target="_top">Frames</a></li> @@ -99,76 +99,81 @@ var activeTableTab = "activeTableTab"; <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><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderRangeArray</a></li> +<li> +<ul class="inheritance"> <li>org.apache.juneau.http.AcceptEncoding</li> </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.81">AcceptEncoding</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">Represents a parsed <code>Accept-Encoding:</code> HTTP header. +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.80">AcceptEncoding</a> +extends <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></pre> +<div class="block">Represents a parsed <l>Accept-Encoding</l> HTTP request header. <p> - The formal RFC2616 header field definition is as follows: - <p class='bcode'> - The Accept-Encoding request-header field is similar to Accept, but restricts - the content-codings (section 3.5) that are acceptable in the response. - - Accept-Encoding = "Accept-Encoding" ":" - 1#( codings [ ";" "q" "=" qvalue ] ) - codings = ( content-coding | "*" ) - - Examples of its use are: - - Accept-Encoding: compress, gzip - Accept-Encoding: - Accept-Encoding: * - Accept-Encoding: compress;q=0.5, gzip;q=1.0 - Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0 + List of acceptable encodings. - A server tests whether a content-coding is acceptable, according to an - Accept-Encoding field, using these rules: - - 1. If the content-coding is one of the content-codings listed in - the Accept-Encoding field, then it is acceptable, unless it is - accompanied by a qvalue of 0. (As defined in section 3.9, a - qvalue of 0 means "not acceptable.") - 2. The special "*" symbol in an Accept-Encoding field matches any - available content-coding not explicitly listed in the header - field. - 3. If multiple content-codings are acceptable, then the acceptable - content-coding with the highest non-zero qvalue is preferred. - 4. The "identity" content-coding is always acceptable, unless - specifically refused because the Accept-Encoding field includes - "identity;q=0", or because the field includes "*;q=0" and does - not explicitly include the "identity" content-coding. If the - Accept-Encoding field-value is empty, then only the "identity" - encoding is acceptable. + <h6 class='figure'>Example</h6> + <p class='bcode'> + Accept-Encoding: gzip, deflate + </p> - If an Accept-Encoding field is present in a request, and if the server cannot - send a response which is acceptable according to the Accept-Encoding header, - then the server SHOULD send an error response with the 406 (Not Acceptable) status code. + <h6 class='topic'>RFC2616 Specification</h6> - If no Accept-Encoding field is present in a request, the server MAY assume - that the client will accept any content coding. In this case, if "identity" - is one of the available content-codings, then the server SHOULD use the "identity" - content-coding, unless it has additional information that a different content-coding - is meaningful to the client. + The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that are acceptable in the response. - Note: If the request does not include an Accept-Encoding field, - and if the "identity" content-coding is unavailable, then - content-codings commonly understood by HTTP/1.0 clients (i.e., - "gzip" and "compress") are preferred; some older clients - improperly display messages sent with other content-codings. The - server might also make this decision based on information about - the particular user-agent or client. - Note: Most HTTP/1.0 applications do not recognize or obey qvalues - associated with content-codings. This means that qvalues will not - work and are not permitted with x-gzip or x-compress. - </p></div> + <p class='bcode'> + Accept-Encoding = "Accept-Encoding" ":" + 1#( codings [ ";" "q" "=" qvalue ] ) + codings = ( content-coding | "*" ) + </p> + <p> + Examples of its use are: + <p class='bcode'> + Accept-Encoding: compress, gzip + Accept-Encoding: + Accept-Encoding: * + Accept-Encoding: compress;q=0.5, gzip;q=1.0 + Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0 + </p> + <p> + A server tests whether a content-coding is acceptable, according to an Accept-Encoding field, using these rules: + <ol> + <li>If the content-coding is one of the content-codings listed in the Accept-Encoding field, then it is + acceptable, unless it is accompanied by a qvalue of 0. + (As defined in section 3.9, a qvalue of 0 means "not acceptable.") + <li>The special "*" symbol in an Accept-Encoding field matches any available content-coding not explicitly listed + in the header field. + <li>If multiple content-codings are acceptable, then the acceptable content-coding with the highest non-zero + qvalue is preferred. + <li>The "identity" content-coding is always acceptable, unless specifically refused because the Accept-Encoding + field includes "identity;q=0", or because the field includes "*;q=0" and does not explicitly include the + "identity" content-coding. + If the Accept-Encoding field-value is empty, then only the "identity" encoding is acceptable. + </ol> + <p> + If an Accept-Encoding field is present in a request, and if the server cannot send a response which is acceptable + according to the Accept-Encoding header, then the server SHOULD send an error response with the 406 (Not Acceptable) + status code. + <p> + If no Accept-Encoding field is present in a request, the server MAY assume that the client will accept any content + coding. + In this case, if "identity" is one of the available content-codings, then the server SHOULD use the "identity" + content-coding, unless it has additional information that a different content-coding is meaningful to the client. + <p> + Note: If the request does not include an Accept-Encoding field, and if the "identity" content-coding is unavailable, + then content-codings commonly understood by HTTP/1.0 clients (i.e.,"gzip" and "compress") are preferred; some older + clients improperly display messages sent with other content-codings. + The server might also make this decision based on information about the particular user-agent or client. + <p> + Note: Most HTTP/1.0 applications do not recognize or obey qvalues associated with content-codings. + This means that qvalues will not work and are not permitted with x-gzip or x-compress.</div> </li> </ul> </div> @@ -182,35 +187,26 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="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>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptEncoding.html#findMatch-java.lang.String:A-">findMatch</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>[] contentCodings)</code> -<div class="block">Given a list of content codings, returns the best match for this <code>Accept-Encoding</code> header.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http">AcceptEncoding</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptEncoding.html#forString-java.lang.String-">forString</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> s)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptEncoding.html#forString-java.lang.String-">forString</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> value)</code> <div class="block">Returns a parsed <code>Accept-Encoding</code> header.</div> </td> </tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/TypeRange.html" title="class in org.apache.juneau.http">TypeRange</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptEncoding.html#getTypeRanges--">getTypeRanges</a></span>()</code> -<div class="block">Returns the list of the types ranges that make up this header.</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/http/AcceptEncoding.html#toString--">toString</a></span>()</code> </td> -</tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderRangeArray"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#asSimpleRanges--">asSimpleRanges</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#findMatch-java.lang.String:A-">findMatch</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> @@ -234,65 +230,19 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a name="forString-java.lang.String-"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>forString</h4> -<pre>public static <a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http">AcceptEncoding</a> <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.95">forString</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> s)</pre> +<pre>public static <a href="../../../../org/apache/juneau/http/AcceptEncoding.html" title="class in org.apache.juneau.http">AcceptEncoding</a> <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.90">forString</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> value)</pre> <div class="block">Returns a parsed <code>Accept-Encoding</code> header.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The <code>Accept-Encoding</code> header string.</dd> +<dd><code>value</code> - The <code>Accept-Encoding</code> header string.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The parsed <code>Accept-Encoding</code> header, or <jk>null</jk> if the string was null.</dd> </dl> </li> </ul> -<a name="getTypeRanges--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTypeRanges</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/http/TypeRange.html" title="class in org.apache.juneau.http">TypeRange</a>> <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.126">getTypeRanges</a>()</pre> -<div class="block">Returns the list of the types ranges that make up this header. - <p> - The types ranges in the list are sorted by their q-value in descending order.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>An unmodifiable list of type ranges.</dd> -</dl> -</li> -</ul> -<a name="findMatch-java.lang.String:A-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>findMatch</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/http/AcceptEncoding.html#line.137">findMatch</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>[] contentCodings)</pre> -<div class="block">Given a list of content codings, returns the best match for this <code>Accept-Encoding</code> header. - <p></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>contentCodings</code> - The codings to match against.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The index into the array of the best match, or <code>-1</code> if no suitable matches could be found.</dd> -</dl> -</li> -</ul> -<a name="toString--"> -<!-- --> -</a> -<ul class="blockListLast"> -<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/http/AcceptEncoding.html#line.150">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> -</dl> -</li> -</ul> </li> </ul> </li> @@ -320,8 +270,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/juneau/http/Accept.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptCharset.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptLanguage.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/http/AcceptEncoding.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/org/apache/juneau/http/AcceptLanguage.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/AcceptLanguage.html b/content/site/apidocs/org/apache/juneau/http/AcceptLanguage.html new file mode 100644 index 0000000..408f130 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/AcceptLanguage.html @@ -0,0 +1,324 @@ +<!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>AcceptLanguage (Apache Juneau (incubating) 6.2.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="AcceptLanguage (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptRanges.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptLanguage.html" target="_top">Frames</a></li> +<li><a href="AcceptLanguage.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.http</div> +<h2 title="Class AcceptLanguage" class="title">Class AcceptLanguage</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><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderRangeArray</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.AcceptLanguage</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/AcceptLanguage.html#line.88">AcceptLanguage</a> +extends <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></pre> +<div class="block">Represents a parsed <l>Accept-Language</l> HTTP request header. + <p> + List of acceptable human languages for response. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + Accept-Language: en-US + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are + preferred as a response to the request. + Language tags are defined in section 3.10. + + <p class='bcode'> + Accept-Language = "Accept-Language" ":" + 1#( language-range [ ";" "q" "=" qvalue ] ) + language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" ) + </p> + <p> + Each language-range MAY be given an associated quality value which represents an estimate of the user's preference + for the languages specified by that range. + The quality value defaults to "q=1". + For example... + <p class='bcode'> + Accept-Language: da, en-gb;q=0.8, en;q=0.7 + </p> + <p> + ...would mean: "I prefer Danish, but will accept British English and other types of English." + <p> + A language-range matches a language-tag if it exactly equals the tag, or if it exactly equals a prefix of the tag + such that the first tag character following the prefix is "-". + <p> + The special range "*", if present in the Accept-Language field, matches every tag not matched by any other range + present in the Accept-Language field. + <p> + Note: This use of a prefix matching rule does not imply that language tags are assigned to languages in such a way + that it is always true that if a user understands a language with a certain + tag, then this user will also understand all languages with tags for which this tag is a prefix. + The prefix rule simply allows the use of prefix tags if this is the case. + <p> + The language quality factor assigned to a language-tag by the Accept-Language field is the quality value of the + longest language- range in the field that matches the language-tag. + <p> + If no language- range in the field matches the tag, the language quality factor assigned is 0. + <p> + If no Accept-Language header is present in the request, the server SHOULD assume that all languages are equally + acceptable. + <p> + If an Accept-Language header is present, then all languages which are assigned a quality factor greater than 0 are + acceptable. + <p> + It might be contrary to the privacy expectations of the user to send an Accept-Language header with the complete + linguistic preferences of the user in every request. + For a discussion of this issue, see section 15.1.4. + <p> + As intelligibility is highly dependent on the individual user, it is recommended that client applications make the + choice of linguistic preference available to the user. + If the choice is not made available, then the Accept-Language header field MUST NOT be given in the request. + <p> + Note: When making the choice of linguistic preference available to the user, we remind implementors of the fact that + users are not familiar with the details of language matching as described above, and should provide appropriate + guidance. + As an example, users might assume that on selecting "en-gb", they will be served any kind of English document if + British English is not available. + A user agent might suggest in such a case to add "en" to get the best matching behavior.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="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>static <a href="../../../../org/apache/juneau/http/AcceptLanguage.html" title="class in org.apache.juneau.http">AcceptLanguage</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptLanguage.html#forString-java.lang.String-">forString</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> value)</code> +<div class="block">Returns a parsed <code>Accept-Language</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderRangeArray"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderRangeArray.html" title="class in org.apache.juneau.http">HeaderRangeArray</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#asSimpleRanges--">asSimpleRanges</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#findMatch-java.lang.String:A-">findMatch</a>, <a href="../../../../org/apache/juneau/http/HeaderRangeArray.html#toString--">toString</a></code></li> +</ul> +<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#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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/AcceptLanguage.html" title="class in org.apache.juneau.http">AcceptLanguage</a> <a href="../../../../src-html/org/apache/juneau/http/AcceptLanguage.html#line.98">forString</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> value)</pre> +<div class="block">Returns a parsed <code>Accept-Language</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>Accept-Language</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>Accept-Language</code> header, or <jk>null</jk> if the string was null.</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/http/AcceptEncoding.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/AcceptRanges.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptLanguage.html" target="_top">Frames</a></li> +<li><a href="AcceptLanguage.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/f1f17bc3/content/site/apidocs/org/apache/juneau/http/AcceptRanges.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/AcceptRanges.html b/content/site/apidocs/org/apache/juneau/http/AcceptRanges.html new file mode 100644 index 0000000..00f5cb7 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/AcceptRanges.html @@ -0,0 +1,292 @@ +<!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>AcceptRanges (Apache Juneau (incubating) 6.2.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="AcceptRanges (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/http/AcceptLanguage.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/Age.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptRanges.html" target="_top">Frames</a></li> +<li><a href="AcceptRanges.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.http</div> +<h2 title="Class AcceptRanges" class="title">Class AcceptRanges</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><a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">org.apache.juneau.http.HeaderString</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.AcceptRanges</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/http/AcceptRanges.html#line.52">AcceptRanges</a> +extends <a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">HeaderString</a></pre> +<div class="block">Represents a parsed <l>Accept-Range</l> HTTP response header. + <p> + What partial content range types this server supports via byte serving. + + <h6 class='figure'>Example</h6> + <p class='bcode'> + Accept-Ranges: bytes + </p> + + <h6 class='topic'>RFC2616 Specification</h6> + + The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a + resource: + <p class='bcode'> + Accept-Ranges = "Accept-Ranges" ":" acceptable-ranges + acceptable-ranges = 1#range-unit | "none" + </p> + <p> + Origin servers that accept byte-range requests MAY send... + <p class='bcode'> + Accept-Ranges: bytes + </p> + <p> + ...but are not required to do so. + <p> + Clients MAY generate byte-range requests without having received this header for the resource involved. + <p> + Range units are defined in section 3.12. + <p> + Servers that do not accept any kind of range request for a resource MAY send... + <p class='bcode'> + Accept-Ranges: none + </p> + <p> + ...to advise the client not to attempt a range request.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="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>static <a href="../../../../org/apache/juneau/http/AcceptRanges.html" title="class in org.apache.juneau.http">AcceptRanges</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/AcceptRanges.html#forString-java.lang.String-">forString</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> value)</code> +<div class="block">Returns a parsed <code>Accept-Ranges</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.HeaderString"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/HeaderString.html" title="class in org.apache.juneau.http">HeaderString</a></h3> +<code><a href="../../../../org/apache/juneau/http/HeaderString.html#asString--">asString</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#eq-java.lang.String-">eq</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#eqIC-java.lang.String-">eqIC</a>, <a href="../../../../org/apache/juneau/http/HeaderString.html#toString--">toString</a></code></li> +</ul> +<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#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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="forString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/AcceptRanges.html" title="class in org.apache.juneau.http">AcceptRanges</a> <a href="../../../../src-html/org/apache/juneau/http/AcceptRanges.html#line.60">forString</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> value)</pre> +<div class="block">Returns a parsed <code>Accept-Ranges</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The <code>Accept-Ranges</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>Accept-Ranges</code> header, or <jk>null</jk> if the string was null.</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/http/AcceptLanguage.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/Age.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/http/AcceptRanges.html" target="_top">Frames</a></li> +<li><a href="AcceptRanges.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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>
