http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/e12f8e7d/content/site/apidocs/org/apache/juneau/http/ContentType.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/ContentType.html b/content/site/apidocs/org/apache/juneau/http/ContentType.html new file mode 100644 index 0000000..482ebc8 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/ContentType.html @@ -0,0 +1,318 @@ +<!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>ContentType (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="ContentType (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/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/MediaType.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/ContentType.html" target="_top">Frames</a></li> +<li><a href="ContentType.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><a href="#fields.inherited.from.class.org.apache.juneau.http.MediaType">Field</a> | </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 ContentType" class="title">Class ContentType</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/MediaType.html" title="class in org.apache.juneau.http">org.apache.juneau.http.MediaType</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.ContentType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <a href="../../../../src-html/org/apache/juneau/http/ContentType.html#line.35">ContentType</a> +extends <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></pre> +<div class="block">Represents a parsed <code>Content-Type:</code> HTTP header. + <p> + The formal RFC2616 header field definition is as follows: + <p class='bcode'> + 14.17 Content-Type + + The Content-Type entity-header field indicates the media type of the + entity-body sent to the recipient or, in the case of the HEAD method, + the media type that would have been sent had the request been a GET. + + Content-Type = "Content-Type" ":" media-type + + Media types are defined in section 3.7. An example of the field is + + Content-Type: text/html; charset=ISO-8859-4 + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.http.MediaType"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></h3> +<code><a href="../../../../org/apache/juneau/http/MediaType.html#CSV">CSV</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#HTML">HTML</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#JSON">JSON</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#MSGPACK">MSGPACK</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#N3">N3</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#NTRIPLE">NTRIPLE</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#PLAIN">PLAIN</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#RDF">RDF</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#RDFABBREV">RDFABBREV</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#TURTLE">TURTLE</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#UON">UON</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#URLENCODING">URLENCODING</a>, <a href="../../../../org/apache/juneau/http/MediaType.html# XML">XML</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#XMLSOAP">XMLSOAP</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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/ContentType.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>Content-Type</code> header.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http">ContentType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/ContentType.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> +<div class="block">Returns a parsed <code>Content-Type</code> header.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.http.MediaType"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.http.<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></h3> +<code><a href="../../../../org/apache/juneau/http/MediaType.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#getParameters--">getParameters</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#getSubType--">getSubType</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#getSubTypes--">getSubTypes</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#getType--">getType</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#hashCode--">hashCode</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#match-org.apache.juneau.http.MediaType-">match</a>, <a href="../../../../org/apache/juneau/http/MediaType.html#matches-org.apache.juneau.http.MediaType-">matches</a>, <a href="../../../../org/apache/juneau/http/MediaType.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#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#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-ex ternal=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="blockList"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http">ContentType</a> <a href="../../../../src-html/org/apache/juneau/http/ContentType.html#line.46">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> +<div class="block">Returns a parsed <code>Content-Type</code> header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - The <code>Content-Type</code> header string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The parsed <code>Content-Type</code> header.</dd> +</dl> +</li> +</ul> +<a name="findMatch-org.apache.juneau.http.MediaType:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>findMatch</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/http/ContentType.html#line.77">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>Content-Type</code> header. + <p> + Note that fuzzy matching is allowed on the media types where the <code>Content-Types</code> header may + contain additional subtype parts. + <br>For example, given a <code>Content-Type</code> value of <js>"text/json+activity"</js>, + the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js> + isn't found. + <br>The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are present + in the header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mediaTypes</code> - The media types 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> +</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/MediaType.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/ContentType.html" target="_top">Frames</a></li> +<li><a href="ContentType.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><a href="#fields.inherited.from.class.org.apache.juneau.http.MediaType">Field</a> | </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/e12f8e7d/content/site/apidocs/org/apache/juneau/http/MediaType.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/MediaType.html b/content/site/apidocs/org/apache/juneau/http/MediaType.html new file mode 100644 index 0000000..ff228da --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/MediaType.html @@ -0,0 +1,713 @@ +<!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>MediaType (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="MediaType (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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"; +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/ContentType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/MediaTypeRange.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/MediaType.html" target="_top">Frames</a></li> +<li><a href="MediaType.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>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 MediaType" class="title">Class MediaType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.MediaType</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/juneau/http/ContentType.html" title="class in org.apache.juneau.http">ContentType</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation">@BeanIgnore</a> +public class <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.29">MediaType</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">Describes a single media type used in content negotiation between an HTTP client and server, as described in + Section 14.1 and 14.7 of RFC2616 (the HTTP/1.1 specification).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#CSV">CSV</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#HTML">HTML</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#JSON">JSON</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#MSGPACK">MSGPACK</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#N3">N3</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#NTRIPLE">NTRIPLE</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#PLAIN">PLAIN</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#RDF">RDF</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#RDFABBREV">RDFABBREV</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#TURTLE">TURTLE</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#UON">UON</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#URLENCODING">URLENCODING</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#XML">XML</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#XMLSOAP">XMLSOAP</a></span></code> +<div class="block">Reusable predefined media type</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.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="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.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> +<div class="block">Returns the media type for the specified string.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#getParameters--">getParameters</a></span>()</code> +<div class="block">Returns the additional parameters on this media type.</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/MediaType.html#getSubType--">getSubType</a></span>()</code> +<div class="block">Returns the <js>'subType'</js> fragment of the <js>'type/subType'</js> string.</div> +</td> +</tr> +<tr id="i4" 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="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/MediaType.html#getSubTypes--">getSubTypes</a></span>()</code> +<div class="block">Returns the subtypes broken down by fragments delimited by <js>"'"</js>.</div> +</td> +</tr> +<tr id="i5" 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/MediaType.html#getType--">getType</a></span>()</code> +<div class="block">Returns the <js>'type'</js> fragment of the <js>'type/subType'</js> string.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#match-org.apache.juneau.http.MediaType-">match</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</code> +<div class="block">Returns a match metric against the specified media type where a larger number represents a better match.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaType.html#matches-org.apache.juneau.http.MediaType-">matches</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</code> +<div class="block">Returns <jk>true</jk> if this media type is a match for the specified media type.</div> +</td> +</tr> +<tr id="i9" 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/MediaType.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/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#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#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-ex ternal=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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="CSV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CSV</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.37">CSV</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="HTML"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTML</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.38">HTML</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="JSON"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>JSON</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.39">JSON</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="MSGPACK"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MSGPACK</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.40">MSGPACK</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="PLAIN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PLAIN</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.41">PLAIN</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="UON"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UON</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.42">UON</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="URLENCODING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>URLENCODING</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.43">URLENCODING</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="XML"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>XML</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.44">XML</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="XMLSOAP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>XMLSOAP</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.45">XMLSOAP</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="RDF"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RDF</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.47">RDF</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="RDFABBREV"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RDFABBREV</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.48">RDFABBREV</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="NTRIPLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NTRIPLE</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.49">NTRIPLE</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="TURTLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TURTLE</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.50">TURTLE</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +<a name="N3"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>N3</h4> +<pre>public static final <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.51">N3</a></pre> +<div class="block">Reusable predefined media type</div> +</li> +</ul> +</li> +</ul> +<!-- ============ 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="blockList"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.80">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> +<div class="block">Returns the media type for the specified string. + The same media type strings always return the same objects so that these objects + can be compared for equality using '=='. + <p> + <h5 class='section'>Notes:</h5> + <ul> + <li>Spaces are replaced with <js>'+'</js> characters. + This gets around the issue where passing media type strings with <js>'+'</js> as HTTP GET parameters + get replaced with spaces by your browser. Since spaces aren't supported by the spec, this + is doesn't break anything. + <li>Anything including and following the <js>';'</js> character is ignored (e.g. <js>";charset=X"</js>). + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - The media type string. Will be lowercased. + <br>Returns <jk>null</jk> if input is null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A cached media type object.</dd> +</dl> +</li> +</ul> +<a name="getType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</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/MediaType.html#line.147">getType</a>()</pre> +<div class="block">Returns the <js>'type'</js> fragment of the <js>'type/subType'</js> string.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The media type.</dd> +</dl> +</li> +</ul> +<a name="getSubType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubType</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/MediaType.html#line.156">getSubType</a>()</pre> +<div class="block">Returns the <js>'subType'</js> fragment of the <js>'type/subType'</js> string.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The media subtype.</dd> +</dl> +</li> +</ul> +<a name="getSubTypes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubTypes</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="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/MediaType.html#line.167">getSubTypes</a>()</pre> +<div class="block">Returns the subtypes broken down by fragments delimited by <js>"'"</js>. + For example, the media type <js>"text/foo+bar"</js> will return a list of + <code>[<js>'foo'</js>,<js>'bar'</js>]</code></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An unmodifiable list of subtype fragments. Never <jk>null</jk>.</dd> +</dl> +</li> +</ul> +<a name="matches-org.apache.juneau.http.MediaType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matches</h4> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.185">matches</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</pre> +<div class="block">Returns <jk>true</jk> if this media type is a match for the specified media type. + <p> + Matches if any of the following is true: + <ul> + <li>Both type and subtype are the same. + <li>One or both types are <js>'*'</js> and the subtypes are the same. + <li>One or both subtypes are <js>'*'</js> and the types are the same. + <li>Either is <js>'*\/*'</js>. + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The media type to compare with.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if the media types match.</dd> +</dl> +</li> +</ul> +<a name="match-org.apache.juneau.http.MediaType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>match</h4> +<pre>public final int <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.209">match</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</pre> +<div class="block">Returns a match metric against the specified media type where a larger number represents a better match. + <p> + <ul> + <li>Exact matches (e.g. <js>"text/json"<js>/</js>"text/json"</js>) should match + better than metacharacter matches (e.g. <js>"text/*"<js>/</js>"text/json"</js>) + <li>The comparison media type can have additional subtype tokens (e.g. <js>"text/json+foo"</js>) + that will not prevent a match. The reverse is not true, e.g. the comparison media type + must contain all subtype tokens found in the comparing media type. + <ul> + <li>We want the <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a> (<js>"text/json"</js>) class to be able to handle requests for <js>"text/json+foo"</js>. + <li>We want to make sure <a href="../../../../org/apache/juneau/json/JsonSerializer.Simple.html" title="class in org.apache.juneau.json"><code>JsonSerializer.Simple</code></a> (<js>"text/json+simple"</js>) does not handle + requests for <js>"text/json"</js>. + </ul> + More token matches should result in a higher match number. + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The media type to compare with.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if the media types match.</dd> +</dl> +</li> +</ul> +<a name="getParameters--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParameters</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/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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/http/MediaType.html#line.253">getParameters</a>()</pre> +<div class="block">Returns the additional parameters on this media type. + <p> + For example, given the media type string <js>"text/html;level=1"</js>, will return a map + with the single entry <code>{level:[<js>'1'</js>]}</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The map of additional parameters, or an empty map if there are no parameters.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<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/http/MediaType.html#line.258">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> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.269">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> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/http/MediaType.html#line.274">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> +</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/ContentType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/MediaTypeRange.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/MediaType.html" target="_top">Frames</a></li> +<li><a href="MediaType.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>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/e12f8e7d/content/site/apidocs/org/apache/juneau/http/MediaTypeRange.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/http/MediaTypeRange.html b/content/site/apidocs/org/apache/juneau/http/MediaTypeRange.html new file mode 100644 index 0000000..9bed091 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/http/MediaTypeRange.html @@ -0,0 +1,464 @@ +<!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>MediaTypeRange (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="MediaTypeRange (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":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"; +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/MediaType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/TypeRange.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/MediaTypeRange.html" target="_top">Frames</a></li> +<li><a href="MediaTypeRange.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 MediaTypeRange" class="title">Class MediaTypeRange</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.http.MediaTypeRange</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation">@BeanIgnore</a> +public final class <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.26">MediaTypeRange</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>></pre> +<div class="block">Describes a single type used in content negotiation between an HTTP client and server, as described in + Section 14.1 and 14.7 of RFC2616 (the HTTP/1.1 specification).</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#compareTo-org.apache.juneau.http.MediaTypeRange-">compareTo</a></span>(<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a> o)</code> +<div class="block">Compares two MediaRanges for equality.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.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> +<div class="block">Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#getExtensions--">getExtensions</a></span>()</code> +<div class="block">Returns the optional set of custom extensions defined for this type.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#getMediaType--">getMediaType</a></span>()</code> +<div class="block">Returns the media type enclosed by this media range.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Float.html?is-external=true"; title="class or interface in java.lang">Float</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#getQValue--">getQValue</a></span>()</code> +<div class="block">Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#hashCode--">hashCode</a></span>()</code> +<div class="block">Returns a hash based on this instance's <code>media-type</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/http/MediaTypeRange.html#matches-org.apache.juneau.http.MediaType-">matches</a></span>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</code> +<div class="block">Matches the specified media type against this range and returns a q-value + between 0 and 1 indicating the quality of the match.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <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/MediaTypeRange.html#parse-java.lang.String-">parse</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">Parses an <code>Accept</code> header value into an array of media ranges.</div> +</td> +</tr> +<tr id="i8" 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/http/MediaTypeRange.html#toString--">toString</a></span>()</code> +<div class="block">Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#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#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-ex ternal=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="parse-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <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/MediaTypeRange.html#line.56">parse</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">Parses an <code>Accept</code> header value into an array of media ranges. + <p> + The returned media ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1. + <p> + The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in RFC2616, Section 14.1, as described below: + <p class='bcode'> + Accept = "Accept" ":" + #( media-range [ accept-params ] ) + + media-range = ( "*\/*" + | ( type "/" "*" ) + | ( type "/" subtype ) + ) *( ";" parameter ) + accept-params = ";" "q" "=" qvalue *( accept-extension ) + accept-extension = ";" token [ "=" ( token | quoted-string ) ] + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The value to parse. If <jk>null</jk> or empty, returns a single <code>MediaTypeRange</code> is returned that represents all types.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The media ranges described by the string. + The ranges are sorted such that the most acceptable media is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.</dd> +</dl> +</li> +</ul> +<a name="getMediaType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMediaType</h4> +<pre>public <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.141">getMediaType</a>()</pre> +<div class="block">Returns the media type enclosed by this media range. + + <h5 class='section'>Examples:</h5> + <ul> + <li><js>"text/html"</js> + <li><js>"text/*"</js> + <li><js>"*\/*"</js> + </ul></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The media type of this media range, lowercased, never <jk>null</jk>.</dd> +</dl> +</li> +</ul> +<a name="getQValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQValue</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Float.html?is-external=true"; title="class or interface in java.lang">Float</a> <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.155">getQValue</a>()</pre> +<div class="block">Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616. + <p> + The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable). + <p> + If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js> header, as opposed to <js>"accept-*"</js> + header, its value will always be <js>"1"</js>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The 'q' value for this type, never <jk>null</jk>.</dd> +</dl> +</li> +</ul> +<a name="getExtensions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtensions</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/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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/http/MediaTypeRange.html#line.166">getExtensions</a>()</pre> +<div class="block">Returns the optional set of custom extensions defined for this type. + <p> + Values are lowercase and never <jk>null</jk>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The optional list of extensions, never <jk>null</jk>.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<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/http/MediaTypeRange.html#line.178">toString</a>()</pre> +<div class="block">Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value. + <p> + The literal text generated will be all lowercase.</div> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A media range suitable for use as an Accept header value, never <code>null</code>.</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.208">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> +<div class="block">Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.</div> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if object is equivalent.</dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.228">hashCode</a>()</pre> +<div class="block">Returns a hash based on this instance's <code>media-type</code>.</div> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A hash based on this instance's <code>media-type</code>.</dd> +</dl> +</li> +</ul> +<a name="compareTo-org.apache.juneau.http.MediaTypeRange-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.245">compareTo</a>(<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a> o)</pre> +<div class="block">Compares two MediaRanges for equality. + <p> + The values are first compared according to <code>qValue</code> values. + Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in ascending order, + with the <js>"*"</js> type demoted last in that order. + <code>MediaRanges</code> with the same type but different sub-types are compared - a more specific subtype is + promoted over the 'wildcard' subtype. + <code>MediaRanges</code> with the same types but with extensions are promoted over those same types with no extensions.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-"; title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/http/MediaTypeRange.html" title="class in org.apache.juneau.http">MediaTypeRange</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The range to compare to. Never <jk>null</jk>.</dd> +</dl> +</li> +</ul> +<a name="matches-org.apache.juneau.http.MediaType-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>matches</h4> +<pre>public float <a href="../../../../src-html/org/apache/juneau/http/MediaTypeRange.html#line.265">matches</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> o)</pre> +<div class="block">Matches the specified media type against this range and returns a q-value + between 0 and 1 indicating the quality of the match.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The media type to match against.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A float between 0 and 1. 1 is a perfect match. 0 is no match at all.</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/MediaType.html" title="class in org.apache.juneau.http"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/http/TypeRange.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/MediaTypeRange.html" target="_top">Frames</a></li> +<li><a href="MediaTypeRange.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>
