You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/12/29 16:29:14 UTC

juneau-website git commit: Update javadocs.

Repository: juneau-website
Updated Branches:
  refs/heads/asf-site 25d34ae97 -> a7eb34890


Update javadocs.

Project: http://git-wip-us.apache.org/repos/asf/juneau-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau-website/commit/a7eb3489
Tree: http://git-wip-us.apache.org/repos/asf/juneau-website/tree/a7eb3489
Diff: http://git-wip-us.apache.org/repos/asf/juneau-website/diff/a7eb3489

Branch: refs/heads/asf-site
Commit: a7eb3489070692a2916767a247b97ecd3447f761
Parents: 25d34ae
Author: JamesBognar <ja...@apache.org>
Authored: Fri Dec 29 11:27:45 2017 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Fri Dec 29 11:29:10 2017 -0500

----------------------------------------------------------------------
 content/site/apidocs/overview-summary.html | 58 +++++++++++++++++++------
 1 file changed, 45 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/juneau-website/blob/a7eb3489/content/site/apidocs/overview-summary.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html
index 1a4464e..a1790c3 100644
--- a/content/site/apidocs/overview-summary.html
+++ b/content/site/apidocs/overview-summary.html
@@ -920,12 +920,14 @@
             <code>Iterators</code> is available through the use of POJO swaps (described later).
          </p>
          
-         <h6 class='topic'>Additional Information</h6>
-         <ul class='doctree'>
-            <li class='jp'>
-               <a class='doclink' href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a> 
-               - Serializer API Javadoc
-         </ul>
+         <h6 class='toc'>Additional Information</h6>
+         <ol class='toc'>
+            <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#Serializer'>Serializer API</a></p>
+            <ol>
+               <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#SerializerGroup'>The SerializerGroup class</a></p>
+            </ol>
+            <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#DefiningSerializer'>Defining a new Serializer</a></p>
+         </ol>
       </div>
       
       <!-- ======================================================================================================= -->
@@ -8097,13 +8099,43 @@
          <li>
             The <js>"$R{...}"</js> variable has been split into the following:
             <ul>
-               <li><js>"$RA{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestAttributeVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestAttributeVar</code></a>
-               <li><js>"$RF{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestFormDataVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestFormDataVar</code></a>
-               <li><js>"$RH{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestHeaderVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestHeaderVar</code></a>
-               <li><js>"$RI{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RestInfoVar.html" title="class in org.apache.juneau.rest.vars"><code>RestInfoVar</code></a>
-               <li><js>"$RP{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestPathVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestPathVar</code></a>
-               <li><js>"$RQ{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestQueryVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestQueryVar</code></a>
-               <li><js>"$R{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a>
+               <li><js>"$RA{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestAttributeVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestAttributeVar</code></a>, values returned by <code>HttpServletRequest.getAttribute(String)</code>.
+               <li><js>"$RF{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestFormDataVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestFormDataVar</code></a>, values returned by <a href="org/apache/juneau/rest/RestRequest.html#getFormData-java.lang.String-"><code>RestRequest.getFormData(String)</code></a>.
+               <li><js>"$RH{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestHeaderVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestHeaderVar</code></a>, values returned by <a href="org/apache/juneau/rest/RestRequest.html#getHeader-java.lang.String-"><code>RestRequest.getHeader(String)</code></a>.
+               <li><js>"$RI{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RestInfoVar.html" title="class in org.apache.juneau.rest.vars"><code>RestInfoVar</code></a>, values returned by <a href="org/apache/juneau/rest/RestRequest.html#getInfoProvider--"><code>RestRequest.getInfoProvider()</code></a>.
+                  <br>The possible values are:
+                  <ul>
+                     <li><js>"contact"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getContact-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getContact(RestRequest)</code></a>
+                     <li><js>"description"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getDescription-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getDescription(RestRequest)</code></a>
+                     <li><js>"externalDocs"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getExternalDocs-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getExternalDocs(RestRequest)</code></a>
+                     <li><js>"license"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getLicense-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getLicense(RestRequest)</code></a>
+                     <li><js>"methodDescription"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getMethodDescription-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodDescription(RestRequest)</code></a>
+                     <li><js>"methodSummary"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getMethodSummary-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getMethodSummary(RestRequest)</code></a>
+                     <li><js>"siteName"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getSiteName-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getSiteName(RestRequest)</code></a>
+                     <li><js>"tags"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getTags-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTags(RestRequest)</code></a>
+                     <li><js>"termsOfService"</js> - Value returned by <a href="org/apache/juneau/rest/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTermsOfService(RestRequest)</code></a>
+                     <li><js>"title"</js> - See <a href="org/apache/juneau/rest/RestInfoProvider.html#getTitle-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTitle(RestRequest)</code></a>
+                     <li><js>"version"</js> - See <a href="org/apache/juneau/rest/RestInfoProvider.html#getVersion-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getVersion(RestRequest)</code></a>
+                  </ul>             
+               <li><js>"$RP{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestPathVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestPathVar</code></a>, values returned by <a href="org/apache/juneau/rest/RestRequest.html#getPath-java.lang.String-"><code>RestRequest.getPath(String)</code></a>.
+               <li><js>"$RQ{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestQueryVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestQueryVar</code></a>, values returned by <a href="org/apache/juneau/rest/RestRequest.html#getQuery-java.lang.String-"><code>RestRequest.getQuery(String)</code></a>
+               <li><js>"$R{key1[,key2...]}"</js> - <a href="org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a>, other request variables.
+                  <br>The possible values are:
+                  <ul>
+                     <li><js>"contextPath"</js> - Value returned by <a href="org/apache/juneau/rest/RestRequest.html#getContextPath--"><code>RestRequest.getContextPath()</code></a>
+                     <li><js>"method"</js> - Value returned by <a href="org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a>
+                     <li><js>"methodDescription"</js> - Value returned by <a href="org/apache/juneau/rest/RestRequest.html#getMethodDescription--"><code>RestRequest.getMethodDescription()</code></a>
+                     <li><js>"methodSummary"</js> - Value returned by <a href="org/apache/juneau/rest/RestRequest.html#getMethodSummary--"><code>RestRequest.getMethodSummary()</code></a>
+                     <li><js>"pathInfo"</js> - Value returned by <code>HttpServletRequestWrapper.getPathInfo()</code>
+                     <li><js>"requestParentURI"</js> - Value returned by <a href="org/apache/juneau/UriContext.html#getRootRelativePathInfoParent--"><code>UriContext.getRootRelativePathInfoParent()</code></a>
+                     <li><js>"requestURI"</js> - Value returned by <code>HttpServletRequestWrapper.getRequestURI()</code>
+                     <li><js>"servletDescription"</js> - Value returned by <a href="org/apache/juneau/rest/RestRequest.html#getServletDescription--"><code>RestRequest.getServletDescription()</code></a>
+                     <li><js>"servletParentURI"</js> - Value returned by <a href="org/apache/juneau/UriContext.html#getRootRelativeServletPathParent--"><code>UriContext.getRootRelativeServletPathParent()</code></a>
+                     <li><js>"servletPath"</js> - See <a href="org/apache/juneau/rest/RestRequest.html#getServletPath--"><code>RestRequest.getServletPath()</code></a>
+                     <li><js>"servletTitle"</js> - See <a href="org/apache/juneau/rest/RestRequest.html#getServletTitle--"><code>RestRequest.getServletTitle()</code></a>
+                     <li><js>"servletURI"</js> - See <a href="org/apache/juneau/UriContext.html#getRootRelativeServletPath--"><code>UriContext.getRootRelativeServletPath()</code></a>
+                     <li><js>"siteName"</js> - See <a href="org/apache/juneau/rest/RestRequest.html#getSiteName--"><code>RestRequest.getSiteName()</code></a>
+                  </ul>
             </ul>
          <li>
             Eliminated the <code>RestMatcherReflecting</code> class.