http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b8a64ee7/content/api-documentation/org/apache/juneau/InvalidDataConversionException.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/InvalidDataConversionException.html b/content/api-documentation/org/apache/juneau/InvalidDataConversionException.html deleted file mode 100644 index ec35f86..0000000 --- a/content/api-documentation/org/apache/juneau/InvalidDataConversionException.html +++ /dev/null @@ -1,303 +0,0 @@ -<!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 --> -<title>InvalidDataConversionException (Juneau)</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="InvalidDataConversionException (Juneau)"; - } - } - catch(err) { - } -//--> -</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="class-use/InvalidDataConversionException.html">Use</a></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/FormattedRuntimeException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/InvalidDataConversionException.html" target="_top">Frames</a></li> -<li><a href="InvalidDataConversionException.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li>Method</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</div> -<h2 title="Class InvalidDataConversionException" class="title">Class InvalidDataConversionException</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> -<li> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> -<li> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">java.lang.RuntimeException</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.juneau.InvalidDataConversionException</li> -</ul> -</li> -</ul> -</li> -</ul> -</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/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> -</dl> -<hr> -<br> -<pre>public final class <a href="../../../src-html/org/apache/juneau/InvalidDataConversionException.html#line.27">InvalidDataConversionException</a> -extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">RuntimeException</a></pre> -<div class="block">General invalid conversion exception. - <p> - Exception that gets thrown if you try to perform an invalid conversion, such as when calling <code>ObjectMap.getInt(...)</code> on a non-numeric <code>String</code>.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar ([email protected])</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../serialized-form.html#org.apache.juneau.InvalidDataConversionException">Serialized Form</a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/InvalidDataConversionException.html#InvalidDataConversionException-java.lang.Object-java.lang.Class-java.lang.Exception-">InvalidDataConversionException</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> value, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> toType, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/InvalidDataConversionException.html#InvalidDataConversionException-java.lang.Object-org.apache.juneau.ClassMeta-java.lang.Exception-">InvalidDataConversionException</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> value, - <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> toType, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> -<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">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"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="InvalidDataConversionException-java.lang.Object-java.lang.Class-java.lang.Exception-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>InvalidDataConversionException</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/InvalidDataConversionException.html#line.36">InvalidDataConversionException</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> value, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> toType, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause)</pre> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>toType</code> - Attempting to convert to this class type.</dd> -<dd><code>cause</code> - The cause.</dd> -<dd><code>value</code> - The value being converted.</dd> -</dl> -</li> -</ul> -<a name="InvalidDataConversionException-java.lang.Object-org.apache.juneau.ClassMeta-java.lang.Exception-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>InvalidDataConversionException</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/InvalidDataConversionException.html#line.45">InvalidDataConversionException</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> value, - <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> toType, - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause)</pre> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>toType</code> - Attempting to convert to this class type.</dd> -<dd><code>cause</code> - The cause.</dd> -<dd><code>value</code> - The value being converted.</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="class-use/InvalidDataConversionException.html">Use</a></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/FormattedRuntimeException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/InvalidDataConversionException.html" target="_top">Frames</a></li> -<li><a href="InvalidDataConversionException.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li>Method</li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b8a64ee7/content/api-documentation/org/apache/juneau/Lockable.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/Lockable.html b/content/api-documentation/org/apache/juneau/Lockable.html deleted file mode 100644 index c3d5647..0000000 --- a/content/api-documentation/org/apache/juneau/Lockable.html +++ /dev/null @@ -1,385 +0,0 @@ -<!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 --> -<title>Lockable (Juneau)</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="Lockable (Juneau)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/Lockable.html">Use</a></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/InvalidDataConversionException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/Lockable.html" target="_top">Frames</a></li> -<li><a href="Lockable.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau</div> -<h2 title="Class Lockable" class="title">Class Lockable</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.Lockable</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/Cloneable.html?is-external=true"; title="class or interface in java.lang">Cloneable</a></dd> -</dl> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../org/apache/juneau/ContextFactory.html" title="class in org.apache.juneau">ContextFactory</a>, <a href="../../../org/apache/juneau/CoreApi.html" title="class in org.apache.juneau">CoreApi</a>, <a href="../../../org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser">ParserGroup</a>, <a href="../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <a href="../../../src-html/org/apache/juneau/Lockable.html#line.33">Lockable</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/Cloneable.html?is-external=true"; title="class or interface in java.lang">Cloneable</a></pre> -<div class="block">Superclass of all classes that have a locked state. - <p> - Used to mark bean contexts, serializers, and parsers as read-only so that - settings can no longer be modified. - <p> - Also keeps track of when the object has been cloned and allows for lazy cloning through - the <a href="../../../org/apache/juneau/Lockable.html#onUnclone--"><code>onUnclone()</code></a> method. The idea behind this is that certain expensive fields don't - need to be cloned unless the object is actually being modified. - <p> - Calling <a href="../../../org/apache/juneau/Lockable.html#lock--"><code>lock()</code></a> on the object causes it to be put into a read-only state. - Once called, subsequent calls to <a href="../../../org/apache/juneau/Lockable.html#checkLock--"><code>checkLock()</code></a> will cause <a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau"><code>LockedExceptions</code></a> - to be thrown. - <p> - As a rule, cloned objects are unlocked by default.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar ([email protected])</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#Lockable--">Lockable</a></span>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#checkLock--">checkLock</a></span>()</code> -<div class="block">Causes a <a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau"><code>LockedException</code></a> to be thrown if this object has been locked.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau">Lockable</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#clone--">clone</a></span>()</code> -<div class="block">Creates an unlocked clone of this object.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#isLocked--">isLocked</a></span>()</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau">Lockable</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#lock--">lock</a></span>()</code> -<div class="block">Locks this object so that settings on it cannot be modified.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Lockable.html#onUnclone--">onUnclone</a></span>()</code> -<div class="block">Subclass can override this method to handle lazy-cloning on the first time <a href="../../../org/apache/juneau/Lockable.html#checkLock--"><code>checkLock()</code></a> is called after - the object has been cloned.</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#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/j ava/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="Lockable--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Lockable</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/Lockable.html#line.33">Lockable</a>()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="lock--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>lock</h4> -<pre>public <a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau">Lockable</a> <a href="../../../src-html/org/apache/juneau/Lockable.html#line.43">lock</a>()</pre> -<div class="block">Locks this object so that settings on it cannot be modified.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>This object (for method chaining).</dd> -</dl> -</li> -</ul> -<a name="isLocked--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isLocked</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/Lockable.html#line.51">isLocked</a>()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd><code><jk>true</jk></code> if this object has been locked.</dd> -</dl> -</li> -</ul> -<a name="checkLock--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>checkLock</h4> -<pre>public void <a href="../../../src-html/org/apache/juneau/Lockable.html#line.62">checkLock</a>() - throws <a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau">LockedException</a></pre> -<div class="block">Causes a <a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau"><code>LockedException</code></a> to be thrown if this object has been locked. - <p> - Also calls <a href="../../../org/apache/juneau/Lockable.html#onUnclone--"><code>onUnclone()</code></a> if this is the first time this method has been called since cloning.</div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau">LockedException</a></code> - If <a href="../../../org/apache/juneau/Lockable.html#lock--"><code>lock()</code></a> has been called on this object.</dd> -</dl> -</li> -</ul> -<a name="onUnclone--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onUnclone</h4> -<pre>public void <a href="../../../src-html/org/apache/juneau/Lockable.html#line.74">onUnclone</a>()</pre> -<div class="block">Subclass can override this method to handle lazy-cloning on the first time <a href="../../../org/apache/juneau/Lockable.html#checkLock--"><code>checkLock()</code></a> is called after - the object has been cloned.</div> -</li> -</ul> -<a name="clone--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>clone</h4> -<pre>public <a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau">Lockable</a> <a href="../../../src-html/org/apache/juneau/Lockable.html#line.82">clone</a>() - throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CloneNotSupportedException.html?is-external=true"; title="class or interface in java.lang">CloneNotSupportedException</a></pre> -<div class="block">Creates an unlocked clone of this object.</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#clone--"; title="class or interface in java.lang">clone</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="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CloneNotSupportedException.html?is-external=true"; title="class or interface in java.lang">CloneNotSupportedException</a></code> - If class cannot be cloned.</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="class-use/Lockable.html">Use</a></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/InvalidDataConversionException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/LockedException.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/Lockable.html" target="_top">Frames</a></li> -<li><a href="Lockable.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b8a64ee7/content/api-documentation/org/apache/juneau/LockedException.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/LockedException.html b/content/api-documentation/org/apache/juneau/LockedException.html deleted file mode 100644 index af18077..0000000 --- a/content/api-documentation/org/apache/juneau/LockedException.html +++ /dev/null @@ -1,234 +0,0 @@ -<!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 --> -<title>LockedException (Juneau)</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="LockedException (Juneau)"; - } - } - catch(err) { - } -//--> -</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="class-use/LockedException.html">Use</a></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/Lockable.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/LockedException.html" target="_top">Frames</a></li> -<li><a href="LockedException.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="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li>Method</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</div> -<h2 title="Class LockedException" class="title">Class LockedException</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> -<li> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> -<li> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">java.lang.RuntimeException</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.juneau.LockedException</li> -</ul> -</li> -</ul> -</li> -</ul> -</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/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> -</dl> -<hr> -<br> -<pre>public final class <a href="../../../src-html/org/apache/juneau/LockedException.html#line.25">LockedException</a> -extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">RuntimeException</a></pre> -<div class="block">Exception that gets thrown when trying to modify settings on a locked <a href="../../../org/apache/juneau/Lockable.html" title="class in org.apache.juneau"><code>Lockable</code></a> object. - <p> - A locked exception indicates a programming error. - Certain objects that are meant for reuse, such as serializers and parsers, provide - the ability to lock the current settings so that they cannot be later changed. - This exception indicates that a setting change was attempted on a previously locked object.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar ([email protected])</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../serialized-form.html#org.apache.juneau.LockedException">Serialized Form</a></dd> -</dl> -</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> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> -<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">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> -<!-- ========= 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="class-use/LockedException.html">Use</a></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/Lockable.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/LockedException.html" target="_top">Frames</a></li> -<li><a href="LockedException.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="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li>Method</li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b8a64ee7/content/api-documentation/org/apache/juneau/MediaRange.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/MediaRange.html b/content/api-documentation/org/apache/juneau/MediaRange.html deleted file mode 100644 index f8a942c..0000000 --- a/content/api-documentation/org/apache/juneau/MediaRange.html +++ /dev/null @@ -1,513 +0,0 @@ -<!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 --> -<title>MediaRange (Juneau)</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="MediaRange (Juneau)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":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="class-use/MediaRange.html">Use</a></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/LockedException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/ObjectList.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/MediaRange.html" target="_top">Frames</a></li> -<li><a href="MediaRange.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</div> -<h2 title="Class MediaRange" class="title">Class MediaRange</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.MediaRange</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/MediaRange.html" title="class in org.apache.juneau">MediaRange</a>></dd> -</dl> -<hr> -<br> -<pre>public final class <a href="../../../src-html/org/apache/juneau/MediaRange.html#line.22">MediaRange</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/MediaRange.html" title="class in org.apache.juneau">MediaRange</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/MediaRange.html#compareTo-org.apache.juneau.MediaRange-">compareTo</a></span>(<a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</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/MediaRange.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/MediaRange.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="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/MediaRange.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/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/MediaRange.html#getParameters--">getParameters</a></span>()</code> -<div class="block">Returns the optional set of parameters associated to the type as returned by <a href="../../../org/apache/juneau/MediaRange.html#getMediaType--"><code>getMediaType()</code></a>.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<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/MediaRange.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="i6" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/MediaRange.html#getType--">getType</a></span>()</code> -<div class="block">Return just the type portion of this media range.</div> -</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/MediaRange.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="i8" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/MediaRange.html#matches-org.apache.juneau.MediaRange-">matches</a></span>(<a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</a> o)</code> -<div class="block">Returns <jk>true</jk> if the specified <code>MediaRange</code> matches this range.</div> -</td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code>static <a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/MediaRange.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="i10" 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/MediaRange.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="getMediaType--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMediaType</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/MediaRange.html#line.41">getMediaType</a>()</pre> -<div class="block">Returns the media type enclosed by this media range. - <p> - Examples: - <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="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/MediaRange.html#line.50">getType</a>()</pre> -<div class="block">Return just the type portion of this media range.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The type portion of this media range.</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/MediaRange.html#line.64">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="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/MediaRange.html#line.78">getParameters</a>()</pre> -<div class="block">Returns the optional set of parameters associated to the type as returned by <a href="../../../org/apache/juneau/MediaRange.html#getMediaType--"><code>getMediaType()</code></a>. - <p> - The parameters are those values as described in standardized MIME syntax. - An example of such a parameter in string form might be <js>"level=1"</js>. - <p> - Values are lowercase and never <jk>null</jk>.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The optional list of parameters, 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/MediaRange.html#line.89">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/MediaRange.html#line.101">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/MediaRange.html#line.138">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/MediaRange.html#line.160">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="parse-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>parse</h4> -<pre>public static <a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</a>[] <a href="../../../src-html/org/apache/juneau/MediaRange.html#line.208">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> - This method can also be used on other headers such as <code>Accept-Charset</code> and <code>Accept-Encoding</code>... - <p class='bcode'> - Accept-Charset = "Accept-Charset" ":" - 1#( ( charset | "*" )[ ";" "q" "=" qvalue ] ) - </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>MediaRange</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="compareTo-org.apache.juneau.MediaRange-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>compareTo</h4> -<pre>public int <a href="../../../src-html/org/apache/juneau/MediaRange.html#line.280">compareTo</a>(<a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</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/MediaRange.html" title="class in org.apache.juneau">MediaRange</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.MediaRange-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>matches</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/MediaRange.html#line.303">matches</a>(<a href="../../../org/apache/juneau/MediaRange.html" title="class in org.apache.juneau">MediaRange</a> o)</pre> -<div class="block">Returns <jk>true</jk> if the specified <code>MediaRange</code> matches this range. - <p> - This implies the types and subtypes are the same as or encompasses the other (e.g. <js>'application/xml'</js> and <js>'application/*'</js>).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>o</code> - The other media rage.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd><jk>true</jk> if the media ranges are the same or one encompasses the other.</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="class-use/MediaRange.html">Use</a></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/LockedException.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/ObjectList.html" title="class in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/juneau/MediaRange.html" target="_top">Frames</a></li> -<li><a href="MediaRange.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 ======= --> -</body> -</html>
