http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/UriContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/UriContext.html b/content/site/apidocs/org/apache/juneau/UriContext.html index 0408833..6fa5d90 100644 --- a/content/site/apidocs/org/apache/juneau/UriContext.html +++ b/content/site/apidocs/org/apache/juneau/UriContext.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -74,13 +74,13 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</a> | </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="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> @@ -108,7 +108,8 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../src-html/org/apache/juneau/UriContext.html#line.52">UriContext</a> +<pre><a href="../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a> +public class <a href="../../../src-html/org/apache/juneau/UriContext.html#line.33">UriContext</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Represents a URL broken into authority/context-root/servlet-path/path-info parts. <p> @@ -120,31 +121,34 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </p> <p> This class allows you to convert URL strings to absolute (e.g. <js>"http://host:port/foo/bar";</js>) or root-relative - (e.g. <js>"/foo/bar"</js>) URLs. - <p> - Two special protocols are used to represent context-root-relative and servlet-relative URIs: - <js>"context:/"</js> and <js>"servlet:/"</js>. - - The following list shows the types of URLs that can be resolved with this class: - <ul> - <li><js>"foo://foo"</js> - Absolute URI. - <li><js>"/foo"</js> - Root-relative URI. - <li><js>"/"</js> - Root URI. - <li><js>"context:/foo"</js> - Context-root-relative URI. - <li><js>"context:/"</js> - Context-root URI. - <li><js>"servlet:/foo"</js> - Servlet-path-relative URI. - <li><js>"servlet:/"</js> - Servlet-path URI. - <li><js>"foo"</js> - Path-info-relative URI. - <li><js>""</js> - Path-info URI. - </ul> - - The following class shows how</div> + (e.g. <js>"/foo/bar"</js>) URLs.</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/UriContext.html" title="class in org.apache.juneau">UriContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#DEFAULT">DEFAULT</a></span></code> +<div class="block">Default URI context.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> @@ -162,9 +166,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#UriContext-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">UriContext</a></span>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, - <a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity, - <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> authority, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#UriContext-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">UriContext</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> authority, <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> contextRoot, <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> servletPath, <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> pathInfo)</code> @@ -187,84 +189,71 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#append-java.lang.Appendable-java.lang.String-">append</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> 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> uri)</code> -<div class="block">Same as <a href="../../../org/apache/juneau/UriContext.html#resolve-java.lang.String-"><code>resolve(String)</code></a> except appends result to the specified appendable.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#getAbsoluteAuthority--">getAbsoluteAuthority</a></span>()</code> <div class="block">Returns the absolute URI of just the authority portion of this URI context.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#getAbsoluteContextRoot--">getAbsoluteContextRoot</a></span>()</code> <div class="block">Returns the absolute URI of the context-root portion of this URI context.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#getAbsolutePathInfo--">getAbsolutePathInfo</a></span>()</code> <div class="block">Returns the absolute URI of the path portion of this URI context.</div> </td> </tr> -<tr id="i4" class="altColor"> +<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/UriContext.html#getAbsolutePathInfoParent--">getAbsolutePathInfoParent</a></span>()</code> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getAbsolutePathInfo--"><code>getAbsolutePathInfo()</code></a>.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i4" 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/UriContext.html#getAbsoluteServletPath--">getAbsoluteServletPath</a></span>()</code> <div class="block">Returns the absolute URI of the resource portion of this URI context.</div> </td> </tr> -<tr id="i6" class="altColor"> +<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/UriContext.html#getAbsoluteServletPathParent--">getAbsoluteServletPathParent</a></span>()</code> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getAbsoluteServletPath--"><code>getAbsoluteServletPath()</code></a>.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<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/UriContext.html#getRootRelativeContextRoot--">getRootRelativeContextRoot</a></span>()</code> <div class="block">Returns the root-relative URI of the context portion of this URI context.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriContext.html#getRootRelativePathInfo--">getRootRelativePathInfo</a></span>()</code> <div class="block">Returns the root-relative URI of the path portion of this URI context.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<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/UriContext.html#getRootRelativePathInfoParent--">getRootRelativePathInfoParent</a></span>()</code> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getRootRelativePathInfo--"><code>getRootRelativePathInfo()</code></a>.</div> </td> </tr> -<tr id="i10" class="altColor"> +<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/UriContext.html#getRootRelativeServletPath--">getRootRelativeServletPath</a></span>()</code> <div class="block">Returns the root-relative URI of the resource portion of this URI context.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<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/UriContext.html#getRootRelativeServletPathParent--">getRootRelativeServletPathParent</a></span>()</code> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getRootRelativeServletPath--"><code>getRootRelativeServletPath()</code></a>.</div> </td> </tr> -<tr id="i12" 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/UriContext.html#resolve-java.lang.String-">resolve</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> uri)</code> -<div class="block">Converts the specified URI to absolute form based on values in this context.</div> -</td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -281,24 +270,42 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <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="DEFAULT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final <a href="../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.39">DEFAULT</a></pre> +<div class="block">Default URI context. + No information about authority, servlet-root, context-root, or path-info is known.</div> +</li> +</ul> +</li> +</ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="UriContext-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> +<a name="UriContext-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>UriContext</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/UriContext.html#line.77">UriContext</a>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, - <a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity, - <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> authority, - <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> contextRoot, - <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> servletPath, - <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> pathInfo)</pre> +<pre><a href="../../../org/apache/juneau/annotation/BeanConstructor.html" title="annotation in org.apache.juneau.annotation">@BeanConstructor</a>(<a href="../../../org/apache/juneau/annotation/BeanConstructor.html#properties--">properties</a>="authority,contextRoot,servletPath,pathInfo") +public <a href="../../../src-html/org/apache/juneau/UriContext.html#line.59">UriContext</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> authority, + <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> contextRoot, + <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> servletPath, + <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> pathInfo)</pre> <div class="block">Constructor. <p> Leading and trailing slashes are trimmed of all parameters. @@ -306,8 +313,6 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Any parameter can be <jk>null</jk>. Blanks and nulls are equivalent.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>resolution</code> - </dd> -<dd><code>relativity</code> - </dd> <dd><code>authority</code> - - The authority portion of URL (e.g. <js>"http://hostname:port";</js>)</dd> <dd><code>contextRoot</code> - - The context root of the application (e.g. <js>"/context-root"</js>, or <js>"context-root"</js>)</dd> <dd><code>servletPath</code> - - The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)</dd> @@ -321,8 +326,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>UriContext</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/UriContext.html#line.90">UriContext</a>()</pre> -<div class="block">Default constructor.</div> +<pre>public <a href="../../../src-html/org/apache/juneau/UriContext.html#line.71">UriContext</a>()</pre> +<div class="block">Default constructor. + All <jk>null</jk> values.</div> </li> </ul> </li> @@ -339,7 +345,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsoluteAuthority</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/UriContext.html#line.104">getAbsoluteAuthority</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.85">getAbsoluteAuthority</a>()</pre> <div class="block">Returns the absolute URI of just the authority portion of this URI context. <p> Example: <js>"http://hostname:port";</js> @@ -358,7 +364,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsoluteContextRoot</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/UriContext.html#line.116">getAbsoluteContextRoot</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.97">getAbsoluteContextRoot</a>()</pre> <div class="block">Returns the absolute URI of the context-root portion of this URI context. <p> Example: <js>"http://hostname:port/context-root";</js></div> @@ -375,7 +381,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getRootRelativeContextRoot</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/UriContext.html#line.134">getRootRelativeContextRoot</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.115">getRootRelativeContextRoot</a>()</pre> <div class="block">Returns the root-relative URI of the context portion of this URI context. <p> Example: <js>"/context-root"</js></div> @@ -392,7 +398,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsoluteServletPath</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/UriContext.html#line.148">getAbsoluteServletPath</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.129">getAbsoluteServletPath</a>()</pre> <div class="block">Returns the absolute URI of the resource portion of this URI context. <p> Example: <js>"http://hostname:port/context-root/servlet-path";</js></div> @@ -409,7 +415,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getRootRelativeServletPath</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/UriContext.html#line.170">getRootRelativeServletPath</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.151">getRootRelativeServletPath</a>()</pre> <div class="block">Returns the root-relative URI of the resource portion of this URI context. <p> Example: <js>"/context-root/servlet-path"</js></div> @@ -426,7 +432,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsoluteServletPathParent</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/UriContext.html#line.185">getAbsoluteServletPathParent</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.166">getAbsoluteServletPathParent</a>()</pre> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getAbsoluteServletPath--"><code>getAbsoluteServletPath()</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -440,7 +446,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getRootRelativeServletPathParent</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/UriContext.html#line.194">getRootRelativeServletPathParent</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.175">getRootRelativeServletPathParent</a>()</pre> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getRootRelativeServletPath--"><code>getRootRelativeServletPath()</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -454,7 +460,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsolutePathInfo</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/UriContext.html#line.206">getAbsolutePathInfo</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.187">getAbsolutePathInfo</a>()</pre> <div class="block">Returns the absolute URI of the path portion of this URI context. <p> Example: <js>"http://hostname:port/context-root/servlet-path/path-info";</js></div> @@ -471,7 +477,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getRootRelativePathInfo</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/UriContext.html#line.235">getRootRelativePathInfo</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.216">getRootRelativePathInfo</a>()</pre> <div class="block">Returns the root-relative URI of the path portion of this URI context. <p> Example: <js>"/context-root/servlet-path/path-info"</js></div> @@ -488,7 +494,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getAbsolutePathInfoParent</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/UriContext.html#line.257">getAbsolutePathInfoParent</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.238">getAbsolutePathInfoParent</a>()</pre> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getAbsolutePathInfo--"><code>getAbsolutePathInfo()</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -499,10 +505,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a name="getRootRelativePathInfoParent--"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>getRootRelativePathInfoParent</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/UriContext.html#line.266">getRootRelativePathInfoParent</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.247">getRootRelativePathInfoParent</a>()</pre> <div class="block">Returns the parent of the URL returned by <a href="../../../org/apache/juneau/UriContext.html#getRootRelativePathInfo--"><code>getRootRelativePathInfo()</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -510,40 +516,6 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> -<a name="resolve-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>resolve</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/UriContext.html#line.276">resolve</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> uri)</pre> -<div class="block">Converts the specified URI to absolute form based on values in this context.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>uri</code> - The URI to convert to absolute form.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The converted URI.</dd> -</dl> -</li> -</ul> -<a name="append-java.lang.Appendable-java.lang.String-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>append</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> <a href="../../../src-html/org/apache/juneau/UriContext.html#line.293">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> 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> uri)</pre> -<div class="block">Same as <a href="../../../org/apache/juneau/UriContext.html#resolve-java.lang.String-"><code>resolve(String)</code></a> except appends result to the specified appendable.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>a</code> - The appendable to append the URL to.</dd> -<dd><code>uri</code> - The URI to convert to absolute form.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The same appendable passed in.</dd> -</dl> -</li> -</ul> </li> </ul> </li> @@ -597,13 +569,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</a> | </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="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/UriRelativity.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/UriRelativity.html b/content/site/apidocs/org/apache/juneau/UriRelativity.html index 2c67b62..2e4a2c8 100644 --- a/content/site/apidocs/org/apache/juneau/UriRelativity.html +++ b/content/site/apidocs/org/apache/juneau/UriRelativity.html @@ -119,7 +119,7 @@ var activeTableTab = "activeTableTab"; <br> <pre>public enum <a href="../../../src-html/org/apache/juneau/UriRelativity.html#line.18">UriRelativity</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a>></pre> -<div class="block">Identifies how relative URIs should resolve against.</div> +<div class="block">Identifies what relative URIs are relative to.</div> </li> </ul> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/UriResolution.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/UriResolution.html b/content/site/apidocs/org/apache/juneau/UriResolution.html index e66df91..ab15551 100644 --- a/content/site/apidocs/org/apache/juneau/UriResolution.html +++ b/content/site/apidocs/org/apache/juneau/UriResolution.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../org/apache/juneau/UriResolver.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/UriResolution.html" target="_top">Frames</a></li> @@ -317,7 +317,7 @@ not permitted.)</div> <div class="subNav"> <ul class="navList"> <li><a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../org/apache/juneau/UriResolver.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/UriResolution.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/UriResolver.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/UriResolver.html b/content/site/apidocs/org/apache/juneau/UriResolver.html new file mode 100644 index 0000000..36e8727 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/UriResolver.html @@ -0,0 +1,395 @@ +<!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>UriResolver (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="UriResolver (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +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/UriResolution.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/UriResolver.html" target="_top">Frames</a></li> +<li><a href="UriResolver.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 UriResolver" class="title">Class UriResolver</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.UriResolver</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/UriResolver.html#line.50">UriResolver</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">Class used to create absolute and root-relative URIs based on your current URI 'location' and rules about how to + make such resolutions. + <p> + Combines a <a href="../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau"><code>UriContext</code></a> instance with rules for resolution (<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau"><code>UriResolution</code></a> and relativity + (<a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau"><code>UriRelativity</code></a>) to define simple <a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-"><code>resolve(Object)</code></a> and <a href="../../../org/apache/juneau/UriResolver.html#append-java.lang.Appendable-java.lang.Object-"><code>append(Appendable, Object)</code></a> + methods. + <p> + Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative URIs: + <js>"context:/"</js>, <js>"servlet:/"</js>, and <js>"request:/"</js>. + + The following list shows the protocols of URLs that can be resolved with this class: + <ul> + <li><js>"foo://foo"</js> - Absolute URI. + <li><js>"/foo"</js> - Root-relative URI. + <li><js>"/"</js> - Root URI. + <li><js>"context:/foo"</js> - Context-root-relative URI. + <li><js>"context:/"</js> - Context-root URI. + <li><js>"servlet:/foo"</js> - Servlet-path-relative URI. + <li><js>"servlet:/"</js> - Servlet-path URI. + <li><js>"request:/foo"</js> - Request-path-relative URI. + <li><js>"request:/"</js> - Request-path URI. + <li><js>"foo"</js> - Path-info-relative URI. + <li><js>""</js> - Path-info URI. + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriResolver.html#UriResolver-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-org.apache.juneau.UriContext-">UriResolver</a></span>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, + <a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity, + <a href="../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> uriContext)</code> +<div class="block">Constructor.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriResolver.html#append-java.lang.Appendable-java.lang.Object-">append</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> 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)</code> +<div class="block">Same as <a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-"><code>resolve(Object)</code></a> except appends result to the specified appendable.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriResolver.html#relativize-java.lang.Object-java.lang.Object-">relativize</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> relativeTo, + <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> uri)</code> +<div class="block">Relativizes a URI.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-">resolve</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> uri)</code> +<div class="block">Converts the specified URI to absolute form based on values in this context.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="UriResolver-org.apache.juneau.UriResolution-org.apache.juneau.UriRelativity-org.apache.juneau.UriContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UriResolver</h4> +<pre>public <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.63">UriResolver</a>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, + <a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity, + <a href="../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> uriContext)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resolution</code> - Rule on how URIs should be resolved.</dd> +<dd><code>relativity</code> - Rule on what relative URIs are relative to.</dd> +<dd><code>uriContext</code> - Current URI context (i.e. the current URI 'location').</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="resolve-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resolve</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/UriResolver.html#line.99">resolve</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> uri)</pre> +<div class="block">Converts the specified URI to absolute form based on values in this context.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>uri</code> - The URI to convert to absolute form. + Can be any of the following: + <ul> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang"><code>CharSequence</code></a> + </ul> + URI can be any of the following forms: + <ul> + <li><js>"foo://foo"</js> - Absolute URI. + <li><js>"/foo"</js> - Root-relative URI. + <li><js>"/"</js> - Root URI. + <li><js>"context:/foo"</js> - Context-root-relative URI. + <li><js>"context:/"</js> - Context-root URI. + <li><js>"servlet:/foo"</js> - Servlet-path-relative URI. + <li><js>"servlet:/"</js> - Servlet-path URI. + <li><js>"request:/foo"</js> - Request-path-relative URI. + <li><js>"request:/"</js> - Request-path URI. + <li><js>"foo"</js> - Path-info-relative URI. + <li><js>""</js> - Path-info URI. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The converted URI.</dd> +</dl> +</li> +</ul> +<a name="relativize-java.lang.Object-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>relativize</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/UriResolver.html#line.130">relativize</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> relativeTo, + <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> uri)</pre> +<div class="block">Relativizes a URI. + <p> + Similar to <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true#relativize-java.net.URI-"; title="class or interface in java.net"><code>URI.relativize(URI)</code></a>, except supports special protocols (e.g. <js>"servlet:/"</js>) for + both the <code>relativeTo</code> and <code>uri</code> parameters. + <p> + For example, to relativize a URI to its servlet-relative form: + <p class='bcode'> + <jc>// relativeUri == "path/foo"</jc> + String relativeUri = resolver.relativize(<js>"servlet:/"</js>, <js>"/context/servlet/path/foo"</js>); + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>relativeTo</code> - The URI to relativize against.</dd> +<dd><code>uri</code> - The URI to relativize.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The relativized URI.</dd> +</dl> +</li> +</ul> +<a name="append-java.lang.Appendable-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.143">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> 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">Same as <a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-"><code>resolve(Object)</code></a> except appends result to the specified appendable.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - The appendable to append the URL to.</dd> +<dd><code>o</code> - The URI to convert to absolute form.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The same appendable passed in.</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/UriResolution.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/UriResolver.html" target="_top">Frames</a></li> +<li><a href="UriResolver.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/Visibility.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/Visibility.html b/content/site/apidocs/org/apache/juneau/Visibility.html index c462bfd..dcef436 100644 --- a/content/site/apidocs/org/apache/juneau/Visibility.html +++ b/content/site/apidocs/org/apache/juneau/Visibility.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -589,7 +589,7 @@ not permitted.)</div> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/annotation/Pojo.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/Pojo.html b/content/site/apidocs/org/apache/juneau/annotation/Pojo.html index 6529f27..03d3680 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Pojo.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Pojo.html @@ -168,7 +168,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Poj <jk>public</jk> String swap(BeanSession s, B o) <jk>throws</jk> SerializeException { <jk>return</jk> o.f1; } - <jk>public</jk> B unswap(BeanSession s, String f) <jk>throws</jk> ParseException { + <jk>public</jk> B unswap(BeanSession s, String f) <jk>throws</jk> ParseException { { B b1 = <jk>new</jk> B(); b1.<jf>f1</jf> = f; <jk>return</jk> b1; http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/57ce76c3/content/site/apidocs/org/apache/juneau/annotation/URI.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/URI.html b/content/site/apidocs/org/apache/juneau/annotation/URI.html index beaaf7e..5e6194f 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/URI.html +++ b/content/site/apidocs/org/apache/juneau/annotation/URI.html @@ -96,7 +96,7 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE"; title="class or interface in java.lang.annotation">TYPE</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>}) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/URI.html#line.66">URI</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/URI.html#line.72">URI</a></pre> <div class="block">Used to identify a class or bean property as a URI. <p> By default, instances of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="../../../../org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>URI</code></a> are considered URIs during serialization, and are @@ -105,8 +105,13 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/URI <p> This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects. <p> - Relative URIs are automatically prepended with <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_absolutePathUriBase"><code>SerializerContext.SERIALIZER_absolutePathUriBase</code></a> and <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_relativeUriBase"><code>SerializerContext.SERIALIZER_relativeUriBase</code></a> - during serialization just like relative <code>URIs</code>. + URIs are automatically resolved to absolute or root-relative form based on the serializer + <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriResolution"><code>SerializerContext.SERIALIZER_uriResolution</code></a> and <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriRelativity"><code>SerializerContext.SERIALIZER_uriRelativity</code></a> + configuration settings, and the URI context defined by the <a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau"><code>UriContext</code></a> that's part of the serializer + session. + <p> + Refer to the <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> class for information about the types of URIs that can be resolved during + serialization. <p> This annotation can be applied to classes, interfaces, or bean property methods for fields.
