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/06/11 00:57:02 UTC
incubator-juneau git commit: Clean up javadocs
Repository: incubator-juneau
Updated Branches:
refs/heads/master e92a7f6e3 -> d9e2e24d9
Clean up javadocs
Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau/commit/d9e2e24d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau/tree/d9e2e24d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau/diff/d9e2e24d
Branch: refs/heads/master
Commit: d9e2e24d90e789487de15ae847faab514f442273
Parents: e92a7f6
Author: JamesBognar <ja...@apache.org>
Authored: Sat Jun 10 20:56:58 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Sat Jun 10 20:56:58 2017 -0400
----------------------------------------------------------------------
juneau-core/src/main/javadoc/overview.html | 30 +++++++++++---------
.../org/apache/juneau/microservice/package.html | 7 ++---
.../java/org/apache/juneau/rest/package.html | 7 ++---
3 files changed, 22 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/d9e2e24d/juneau-core/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/javadoc/overview.html b/juneau-core/src/main/javadoc/overview.html
index 9d4a49e..68386e1 100644
--- a/juneau-core/src/main/javadoc/overview.html
+++ b/juneau-core/src/main/javadoc/overview.html
@@ -6496,6 +6496,8 @@
<li>{@link org.apache.juneau.rest.widget.ContentTypeLinksWidget}
</ul>
<li><code>devops.css</code> cleaned up.
+ <li>Removed a bunch of URL-related methods from {@link org.apache.juneau.rest.RestRequest}.
+ These all have equivalents in {@link org.apache.juneau.rest.RestRequest#getUriContext()}.
</ul>
<h6 class='topic'>org.apache.juneau.rest.client</h6>
@@ -7660,7 +7662,7 @@
pick up <code>JsonProvider</code> as well. It's easy enough to create your own implementation if needed.
<li>OPTIONS pages now specify <code>consumes</code> and <code>produces</code> fields instead of <code>accept</code> and <code>contentType</code> which was confusing.
<li>Eliminated <code>properties</code> from OPTIONS pages.
- <li>New {@link org.apache.juneau.rest.labels.ResourceLink#ResourceLink(String,RestRequest,String,Object[])} constructor.
+ <li>New <code><del>ResourceLink.ResourceLink(String,RestRequest,String,Object[])</del></code> constructor.
<li>New response handlers:
<ul>
<li>{@link org.apache.juneau.rest.response.StreamableHandler} - Allows REST Java methods to return instances of {@link org.apache.juneau.Streamable}.
@@ -7805,7 +7807,7 @@
{@link org.apache.juneau.rest.annotation.RestMethod#inheritEncoders() @RestMethod.inheritEncoders} annotations.
Allows encoders to be fine-tuned at the method level.
<li>New {@link org.apache.juneau.rest.annotation.RestResource#config() @RestResource.config()} annotation for associating external {@link org.apache.juneau.ini.ConfigFile} config files with servlets.
- <li>Fixed bugs in {@link org.apache.juneau.rest.labels.ResourceLink}.
+ <li><code><del>ResourceLink</del></code>.
<li>New <a class='doclink' href='org/apache/juneau/rest/matchers/package-summary.html#TOC'>org.apache.juneau.rest.matchers</a> package for commonly-used {@link org.apache.juneau.rest.RestMatcher RestMatchers}:
<ul>
<li>{@link org.apache.juneau.rest.matchers#MultipartFormDataMatcher}
@@ -7860,7 +7862,7 @@
on all JVMs. On IBM JVMs this is unnecessary because the order of the properties as defined in the class
are stored in the bytecode. Other JVMs such as OpenJRE do not implement this feature causing the bean
properties to be in random order.
- <li>New {@link org.apache.juneau.rest.labels.ResourceDescription#ResourceDescription(RestRequest,String,String)} constructor.
+ <li>New <code><del>ResourceDescription.ResourceDescription(RestRequest,String,String)</del></code> constructor.
</ul>
</div>
@@ -7945,10 +7947,10 @@
<ul>
<li><code><del>RestRequest.getQueryParameterMap()</del></code>
<li><code><del>RestRequest.getQueryParameterNames()</del></code>
- <li>{@link org.apache.juneau.rest.RestRequest#getPathInfoUndecoded()}
+ <li><code><del>RestRequest.getPathInfoUndecoded()</del></code>
<li><code><del>RestRequest.getPathRemainderUndecoded()</del></code>
- <li>{@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}
- <li>{@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURL()}
+ <li><code><del>RestRequest.getTrimmedRequestURI()</del></code>
+ <li><code><del>RestRequest.getTrimmedRequestURL()</del></code>
<li>{@link org.apache.juneau.rest.RestRequest#getServletTitle()}
<li>{@link org.apache.juneau.rest.RestRequest#getServletDescription()}
<li>{@link org.apache.juneau.rest.RestRequest#getMethodDescription()}
@@ -7957,8 +7959,8 @@
Returns <jk>null</jk> instead of blank for no path info.
<li><code><del>RestRequest.getPathRemainder()</del></code> now automatically decodes the path remainder.
Use <code><del>RestRequest.getPathRemainderUndecoded()</del></code> to get the unencoded path remainder.
- <li>Bug fixes in {@link org.apache.juneau.rest.RestRequest#getRequestParentURI()} when servlet is mapped to <js>"/*"</js>.
- <li>Bug fixes in {@link org.apache.juneau.rest.RestRequest#getServletURI()} when servlet is mapped to <js>"/*"</js>.
+ <li>Bug fixes in <code><del>RestRequest.getRequestParentURI()</del></code> when servlet is mapped to <js>"/*"</js>.
+ <li>Bug fixes in <code><del>RestRequest.getServletURI()</del></code> when servlet is mapped to <js>"/*"</js>.
</ul>
<li>New string replacement variables:
<ul>
@@ -7966,7 +7968,7 @@
<li><code>$R{methodDescription}</code> - Returns value from {@link org.apache.juneau.rest.RestRequest#getMethodDescription()}
<li><code>$R{servletTitle}</code> - Returns value from {@link org.apache.juneau.rest.RestRequest#getServletTitle()}
<li><code>$R{servletDescription}</code> - Returns value from {@link org.apache.juneau.rest.RestRequest#getServletDescription()}
- <li><code>$R{trimmedRequestURI}</code> - Returns value from {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}
+ <li><code>$R{trimmedRequestURI}</code> - Returns value from <code><del>RestRequest.getTrimmedRequestURI()</del></code>
<li><code>$E{var}</code> - Environment variables.
</ul>
<li>Added methods <code><del>RestServlet.getDescription(RestRequest)</del></code> and <del><code>RestServlet.getLabel(RestRequest)</code></del>.
@@ -8047,7 +8049,7 @@
<h6 class='topic'>Server</h6>
<ul class='spaced-list'>
- <li>New {@link org.apache.juneau.rest.RestRequest#getServletParentURI()} method.
+ <li>New <code><del>RestRequest.getServletParentURI()</del></code> method.
<li>New <code>$R{servletParentURI}</code> variable.
<li>Removed final modifier from {@link org.apache.juneau.rest.labels.ChildResourceDescriptions}.
</ul>
@@ -8499,7 +8501,7 @@
<li>New pluggable {@link org.apache.juneau.rest.ResponseHandler} class and {@link org.apache.juneau.rest.annotation.RestResource#responseHandlers()} annotation
for defining customer response handlers for special kinds of POJOs.
<li>New method <del><code>UrlEncodingSerializer.serializeUrlPart(Object)</code></del> method.
- <li>New method {@link org.apache.juneau.rest.RestRequest#getServletURIBuilder()} for construcing servlet-based URLs more efficiently.
+ <li>New method <code><del>RestRequest.getServletURIBuilder()</del></code> for construcing servlet-based URLs more efficiently.
<li>New method {@link org.apache.juneau.rest.RestResponse#getNegotiatedOutputStream()} that uses encoders if a match is found,
and {@link org.apache.juneau.rest.RestResponse#getOutputStream()} that just return the underlying output stream without any modifications.
<li>Fixed bug where some properties were not being propagated correctly when using <code><del>CoreObject.setProperties(ObjectMap)</del></code>
@@ -8687,7 +8689,7 @@
</p>
<ul class='spaced-list'>
<li>Implemented <code>org.apache.juneau.urlencoding.UrlEncodingParser.parseArgs(Reader,int,ClassMeta[])</code>.
- <li><code>name</code> parameter of {@link org.apache.juneau.rest.labels.ResourceDescription#ResourceDescription(String,String,String)}
+ <li><code>name</code> parameter of <code><del>ResourceDescription#ResourceDescription(String,String,String)</del></code>.
is now automatically URL-encoded so that the name can contain special characters (e.g. <js>"foo/bar(baz)"</js>).
<li>Support for URL-matching and path info containing encoded characters (e.g. <js>'/'</js>) now supported.
<li>Removed some lazy-initialization of bean information in {@link org.apache.juneau.ClassMeta} that allowed the removal of
@@ -8743,8 +8745,8 @@
New methods on {@link org.apache.juneau.rest.RestRequest}:
<ul>
<li><del><code>RestRequest.getVarResolver()</code></del></li>
- <li>{@link org.apache.juneau.rest.RestRequest#getServletURI()}</li>
- <li>{@link org.apache.juneau.rest.RestRequest#getRequestParentURI()}</li>
+ <li><code><del>RestRequest.getServletURI()</del></code></li>
+ <li><code><del>RestRequest.getRequestParentURI()</del></code></li>
</ul>
</li>
<li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/d9e2e24d/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html b/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
index f7f0912..77e23dc 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
@@ -661,14 +661,13 @@
<li><l>$R{path.X}</l> - Value returned by {@link org.apache.juneau.rest.RequestPathMatch#get(Object)}.
<li><l>$R{pathInfo}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getPathInfo()}.
<li><l>$R{query.X}</l> - Value returned by {@link org.apache.juneau.rest.RequestQuery#getFirst(String)}.
- <li><l>$R{requestParentURI}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getRequestParentURI()}.
+ <li><l>$R{requestParentURI}</l> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativePathInfoParent()}.
<li><l>$R{requestURI}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getRequestURI()}.
<li><l>$R{servletDescription}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletDescription()}.
<li><l>$R{servletTitle}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletTitle()}.
- <li><l>$R{servletParentURI}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletParentURI()}.
+ <li><l>$R{servletParentURI}</l> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativeServletPathParent()}.
<li><l>$R{servletPath}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletPath()}.
- <li><l>$R{servletURI}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletURI()}.
- <li><l>$R{trimmedRequestURI}</l> - Value returned by {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}.
+ <li><l>$R{servletURI}</l> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativeServletPath()}.
</ul>
<li><l>$SA{key,mediaType}</l> - Object returned by {@link org.apache.juneau.rest.RestRequest#getAttribute(String)} converted to a string using the serializer registered to handle the specified media type.
<li><l>$UE{...}</l> - URL-Encode the specified value.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/d9e2e24d/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/package.html b/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
index a5bed6e..d5dec8b 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
@@ -2099,14 +2099,13 @@
<li><ck>$R{path.X}</ck> - Value returned by {@link org.apache.juneau.rest.RequestPathMatch#get(Object)}.
<li><ck>$R{pathInfo}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getPathInfo()}.
<li><ck>$R{query.X}</ck> - Value returned by {@link org.apache.juneau.rest.RequestQuery#getFirst(String)}.
- <li><ck>$R{requestParentURI}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getRequestParentURI()}.
+ <li><ck>$R{requestParentURI}</ck> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativePathInfoParent()}.
<li><ck>$R{requestURI}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getRequestURI()}.
<li><ck>$R{servletDescription}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletDescription()}.
<li><ck>$R{servletTitle}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletTitle()}.
- <li><ck>$R{servletParentURI}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletParentURI()}.
+ <li><ck>$R{servletParentURI}</ck> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativeServletPathParent()}.
<li><ck>$R{servletPath}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletPath()}.
- <li><ck>$R{servletURI}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getServletURI()}.
- <li><ck>$R{trimmedRequestURI}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getTrimmedRequestURI()}.
+ <li><ck>$R{servletURI}</ck> - Value returned by {@link org.apache.juneau.UriContext#getRootRelativeServletPath()}.
</ul>
</td>
</tr>