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/23 23:48:02 UTC
juneau git commit: Doc fixes.
Repository: juneau
Updated Branches:
refs/heads/master f2174e066 -> 4f9c8f6cc
Doc fixes.
Project: http://git-wip-us.apache.org/repos/asf/juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau/commit/4f9c8f6c
Tree: http://git-wip-us.apache.org/repos/asf/juneau/tree/4f9c8f6c
Diff: http://git-wip-us.apache.org/repos/asf/juneau/diff/4f9c8f6c
Branch: refs/heads/master
Commit: 4f9c8f6cca3d360c554d1937aa6aa618e2107f43
Parents: f2174e0
Author: JamesBognar <ja...@apache.org>
Authored: Sat Dec 23 18:47:58 2017 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Sat Dec 23 18:47:58 2017 -0500
----------------------------------------------------------------------
.../org/apache/juneau/internal/ClassUtils.java | 2 +-
juneau-doc/src/main/javadoc/overview.html | 38 ++++++++++----------
.../org/apache/juneau/rest/client/RestCall.java | 30 ++++++++--------
.../juneau/rest/client/RestCallLogger.java | 2 +-
.../apache/juneau/rest/client/RestClient.java | 4 +--
.../juneau/rest/client/RestClientBuilder.java | 6 ++--
.../org/apache/juneau/rest/client/package.html | 12 +++----
7 files changed, 47 insertions(+), 47 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
index cab02c3..2b415fd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
@@ -1071,7 +1071,7 @@ public final class ClassUtils {
* <ul>
* <li>Have a public constructor that takes in a single <code>String</code> argument.
* <li>Have a static <code>fromString(String)</code> (or related) method.
- * <br>See {@findPublicFromStringMethod(Class)} for the list of possible static method names.
+ * <br>See {@link #findPublicFromStringMethod(Class)} for the list of possible static method names.
* <li>Be an <code>enum</code>.
* </ul>
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-doc/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 248479b..c8df5ea 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -907,11 +907,11 @@
</ul>
</li>
<li class='jic'>
- {@link org.apache.juneau.rdf.RdfCommon}
+ {@link org.apache.juneau.jena.RdfCommon}
- Configurable properties common to the RDF serializers and parsers.
<ul>
<li class='jc'>
- {@link org.apache.juneau.rdf.RdfSerializer}
+ {@link org.apache.juneau.jena.RdfSerializer}
- Configurable properties on the RDF serializers.
</ul>
</li>
@@ -919,7 +919,7 @@
{@link org.apache.juneau.json.JsonSerializer}
- Configurable properties on the JSON serializer.
<li class='jc'>
- {@link org.apache.juneau.msgpack.MessagePackSerializer}
+ {@link org.apache.juneau.msgpack.MsgPackSerializer}
- Configurable properties on the MessagePack serializer.
<li class='jc'>
{@link org.apache.juneau.soap.SoapXmlSerializer}
@@ -940,7 +940,7 @@
{@link org.apache.juneau.html.HtmlParser}
- Configurable properties on the HTML parser.
<li class='jic'>
- {@link org.apache.juneau.rdf.RdfCommon}
+ {@link org.apache.juneau.jena.RdfCommon}
- Configurable properties common to the RDF serializers and parsers.
<ul>
<li class='jc'>
@@ -965,7 +965,7 @@
</ul>
</li>
<li class='jc'>
- {@link org.apache.juneau.rest.server.RestContext}
+ {@link org.apache.juneau.rest.RestContext}
- Configurable properties on the REST servlet.
</li>
</ul>
@@ -1830,7 +1830,7 @@
<td>
No equivalent annotation, but can be controlled via various settings:
<br>{@link org.apache.juneau.BeanContext}
- <br>{@link org.apache.juneau.serializer.SerializerContext}
+ <br>{@link org.apache.juneau.serializer.Serializer}
<br>Future annotation support planned.
</td>
</tr>
@@ -7686,16 +7686,16 @@
<ul>
<li class='jac'>{@link org.apache.juneau.BeanContextBuilder}
<ul>
- <li class='jaa'>{@link org.apache.juneau.serializer.SerializerBuider}
+ <li class='jaa'>{@link org.apache.juneau.serializer.SerializerBuilder}
<ul>
- <li class='jac'>{@link org.apache.juneau.serializer.JsonSerializerBuilder}
+ <li class='jac'>{@link org.apache.juneau.json.JsonSerializerBuilder}
</ul>
</ul>
</ul>
</ul>
Builder objects are used for building up and creating <code>Context</code> objects.
<li>
- The {@link org.apache.juneau.PropertyStore2} class has been completely rewritten.
+ The {@link org.apache.juneau.PropertyStore} class has been completely rewritten.
It is now a read-only configuration store build using the {@link org.apache.juneau.PropertyStoreBuilder}
class.
<br>The previous <code>PropertyStore</code> class was overly-complicated with many read/write
@@ -8414,7 +8414,7 @@
<li>
Fixed bugs with {@link org.apache.juneau.BeanContext#BEAN_includeProperties} and {@link org.apache.juneau.BeanContext#BEAN_excludeProperties} settings.
<li>
- New/modified settings in {@link org.apache.juneau.html.HtmlDocSerializerContext}:
+ New/modified settings in <code><del>HtmlDocSerializerContext</del></code>:
<ul>
<li><code><del>HTMLDOC_script</del></code>
<li><code><del>HTMLDOC_style</del></code> - Was <jsf>HTMLDOC_css</jsf>.
@@ -8425,7 +8425,7 @@
Allows you to search for resources up the parent hierarchy chain.
Also allows you to search for localized resources.
<li>
- Eliminated the following properties from {@link org.apache.juneau.html.HtmlDocSerializerContext}:
+ Eliminated the following properties from <code><del>HtmlDocSerializerContext</del></code>:
<jsf>HTMLDOC_title</jsf>, <jsf>HTMLDOC_description</jsf>, <jsf>HTMLDOC_description</jsf>
<br>See below on changes to simplify HTML headers.
<li>
@@ -9374,7 +9374,7 @@
<ul>
<li>Session object meant to be single-use that can be discarded after use and contains session-level object cache and overridable Locale and TimeZone.
</ul>
- <li>{@link org.apache.juneau.serializer.SerializerContext} and {@link org.apache.juneau.parser.ParserContext}
+ <li><code><del>SerializerContext</del></code> and <code><del>ParserContext</del></code>
now extend directly from {@link org.apache.juneau.BeanContext}.
<li>{@link org.apache.juneau.serializer.SerializerSession} and {@link org.apache.juneau.parser.ParserSession}
now extend directly from {@link org.apache.juneau.BeanSession}.
@@ -9569,7 +9569,7 @@
<ul>
<li>Several fixes to handle obscure edge cases.
</ul>
- <li>New properties in {@link org.apache.juneau.parser.ParserContext}.
+ <li>New properties in <code><del>ParserContext</del></code>.
<ul>
<li><code><del>ParserContext.PARSER_strict</del></code>
<li><code><del>ParserContext.PARSER_inputStreamCharset</del></code>
@@ -10567,7 +10567,7 @@
<h6 class='topic'>Core</h6>
<ul class='spaced-list'>
- <li>New properties in {@link org.apache.juneau.serializer.SerializerContext}:
+ <li>New properties in <code><del>SerializerContext</del></code>:
<ol>
<li><code><del>SerializerContext.SERIALIZER_relativeUriBase</del></code>
<li><code><del>SerializerContext.SERIALIZER_absolutePathUriBase</del></code>
@@ -10953,7 +10953,7 @@
<li>Bug fixes in {@link org.apache.juneau.dto.ResultSetList} for Oracle and SQL Server.
<li>Serializers and parsers can now access HTTP request attributes, parameters, and headers through <code>SerializerContext.getProperties()</code> and
<code>ParserContext.getProperties()</code>.
- <li>Removed media-type and encoding attributes from {@link org.apache.juneau.serializer.SerializerContext} and {@link org.apache.juneau.parser.ParserContext}
+ <li>Removed media-type and encoding attributes from <code><del>SerializerContext</del></code> and <code><del>ParserContext</del></code>
since these are now available through context properties, and are typically not used.
<li>{@link org.apache.juneau.xml.XmlParser} now accepts <code>application/xml</code>.
<li>Improved handling of bean property serialization when multiple matching pojo filters for the bean property class exist.
@@ -11028,7 +11028,7 @@
<li>Better behavior on overriding of filters in <code>BeanContext.addTransforms(Class[])</code>.
Previously, adding multiple conflicting filters resulted in random behavior.
Now filters are overridden when multiple matching filters are applied.
- <li>Allow {@link org.apache.juneau.html.HtmlDocSerializerContext} properties to be set via <code><del>Serializer.setProperty(String,Object)</del></code>.
+ <li>Allow <code><del>HtmlDocSerializerContext</del></code> properties to be set via <code><del>Serializer.setProperty(String,Object)</del></code>.
Previously, these could only be defined through override properties (e.g. through REST class and method annotations).
<li>Fixed memory leak in XML parser.
</ul>
@@ -11701,7 +11701,7 @@
New <code><del>HtmlDocSerializerContext.HTMLDOC_navlinks</del></code> annotation for addint links to HTML page views.
</li>
<li>
- Renamed the properties in {@link org.apache.juneau.html.HtmlDocSerializerContext} for clarity.
+ Renamed the properties in <code><del>HtmlDocSerializerContext</del></code> for clarity.
</li>
</ul>
<h6 class='topic'>Servlet API changes</h6>
@@ -12244,8 +12244,8 @@
New configurable property classes for everything are now structured better and easier to locate and identify through the following new classes:
<ul>
<li>{@link org.apache.juneau.BeanContext}</li>
- <li>{@link org.apache.juneau.serializer.SerializerContext}</li>
- <li>{@link org.apache.juneau.parser.ParserContext}</li>
+ <li><code><del>SerializerContext</del></code></li>
+ <li><code><del>ParserContext</del></code></li>
</ul>
</li>
<li>
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
index 402babf..d8b4547 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
@@ -74,7 +74,7 @@ public final class RestCall extends Session {
private final RestClient client; // The client that created this call.
private final HttpRequestBase request; // The request.
private HttpResponse response; // The response.
- private List<RestCallInterceptor> intercepters = new ArrayList<>(); // Used for intercepting and altering requests.
+ private List<RestCallInterceptor> interceptors = new ArrayList<>(); // Used for intercepting and altering requests.
private boolean isConnected = false; // connect() has been called.
private boolean allowRedirectsOnPosts;
@@ -109,8 +109,8 @@ public final class RestCall extends Session {
super(SessionArgs.DEFAULT);
this.client = client;
this.request = request;
- for (RestCallInterceptor i : this.client.intercepters)
- intercepter(i);
+ for (RestCallInterceptor i : this.client.interceptors)
+ interceptor(i);
this.retryOn = client.retryOn;
this.retries = client.retries;
this.retryInterval = client.retryInterval;
@@ -1118,14 +1118,14 @@ public final class RestCall extends Session {
}
/**
- * Add an intercepter for this call only.
+ * Add an interceptor for this call only.
*
- * @param intercepter The intercepter to add to this call.
+ * @param interceptor The interceptor to add to this call.
* @return This object (for method chaining).
*/
- public RestCall intercepter(RestCallInterceptor intercepter) {
- intercepters.add(intercepter);
- intercepter.onInit(this);
+ public RestCall interceptor(RestCallInterceptor interceptor) {
+ interceptors.add(interceptor);
+ interceptor.onInit(this);
return this;
}
@@ -1361,7 +1361,7 @@ public final class RestCall extends Session {
*/
public RestCall responsePattern(final ResponsePattern responsePattern) {
captureResponse();
- intercepter(
+ interceptor(
new RestCallInterceptor() {
@Override
public void onClose(RestCall restCall) throws RestCallException {
@@ -1521,7 +1521,7 @@ public final class RestCall extends Session {
if (! retryOn.onResponse(response))
retries = 0;
if (retries > 0) {
- for (RestCallInterceptor rci : intercepters)
+ for (RestCallInterceptor rci : interceptors)
rci.onRetry(this, sc, request, response, ex);
request.reset();
long w = retryInterval;
@@ -1532,13 +1532,13 @@ public final class RestCall extends Session {
throw ex;
}
}
- for (RestCallInterceptor rci : intercepters)
+ for (RestCallInterceptor rci : interceptors)
rci.onConnect(this, sc, request, response);
if (response == null)
throw new RestCallException("HttpClient returned a null response");
StatusLine sl = response.getStatusLine();
String method = request.getMethod();
- sc = sl.getStatusCode(); // Read it again in case it was changed by one of the intercepters.
+ sc = sl.getStatusCode(); // Read it again in case it was changed by one of the interceptors.
if (sc >= 400 && ! ignoreErrors)
throw new RestCallException(sc, sl.getReasonPhrase(), method, request.getURI(), getResponseAsString())
.setServerException(response.getFirstHeader("Exception-Name"), response.getFirstHeader("Exception-Message"), response.getFirstHeader("Exception-Trace"))
@@ -2056,20 +2056,20 @@ public final class RestCall extends Session {
EntityUtils.consumeQuietly(response.getEntity());
isClosed = true;
if (! isFailed)
- for (RestCallInterceptor r : intercepters)
+ for (RestCallInterceptor r : interceptors)
r.onClose(this);
return this;
}
/**
- * Adds a {@link RestCallLogger} to the list of intercepters on this class.
+ * Adds a {@link RestCallLogger} to the list of interceptors on this class.
*
* @param level The log level to log events at.
* @param log The logger.
* @return This object (for method chaining).
*/
public RestCall logTo(Level level, Logger log) {
- intercepter(new RestCallLogger(level, log));
+ interceptor(new RestCallLogger(level, log));
return this;
}
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
index 9b8f45b..b625231 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
@@ -22,7 +22,7 @@ import org.apache.http.client.methods.*;
import org.apache.http.util.*;
/**
- * Specialized intercepter for logging calls to a log file.
+ * Specialized interceptor for logging calls to a log file.
*
* <p>
* Causes a log entry to be created that shows all the request and response headers and content at the end of the
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
index 075180c..599200d 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
@@ -291,7 +291,7 @@ public class RestClient extends BeanContext {
final RetryOn retryOn;
final int retries;
final long retryInterval;
- final RestCallInterceptor[] intercepters;
+ final RestCallInterceptor[] interceptors;
// This is lazy-created.
private volatile ExecutorService executorService;
@@ -382,7 +382,7 @@ public class RestClient extends BeanContext {
RestCallInterceptor[] rci = getInstanceArrayProperty(RESTCLIENT_interceptors, RestCallInterceptor.class, new RestCallInterceptor[0]);
if (debug)
rci = ArrayUtils.append(rci, RestCallLogger.DEFAULT);
- this.intercepters = rci;
+ this.interceptors = rci;
if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))
creationStack = Thread.currentThread().getStackTrace();
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
index cdba040..660d6e8 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
@@ -241,9 +241,9 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Adds an intercepter that gets called immediately after a connection is made.
+ * Adds an interceptor that gets called immediately after a connection is made.
*
- * @param interceptor The intercepter.
+ * @param interceptor The interceptor.
* @return This object (for method chaining).
*/
public RestClientBuilder interceptor(RestCallInterceptor interceptor) {
@@ -251,7 +251,7 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Adds a {@link RestCallLogger} to the list of intercepters on this class.
+ * Adds a {@link RestCallLogger} to the list of interceptors on this class.
*
* @param level The log level to log messages at.
* @param log The logger to log messages to.
http://git-wip-us.apache.org/repos/asf/juneau/blob/4f9c8f6c/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
index 5ffe6c5..ec36bab 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
@@ -677,7 +677,7 @@
</p>
<p>
Under-the-covers, this is simply a shortcut for adding the {@link org.apache.juneau.rest.client.RestCallLogger#DEFAULT}
- intercepter to the client.
+ interceptor to the client.
This causes the following output to be generated by the Java <code>org.apache.juneau.rest.client</code>
logger at <jsf>WARNING</jsf> level:
</p>
@@ -746,7 +746,7 @@
</p>
<p>
Customized logging can be handled by sub-classing the {@link org.apache.juneau.rest.client.RestCallLogger}
- class and using the {@link org.apache.juneau.rest.client.RestCall#intercepter(RestCallInterceptor)} method.
+ class and using the {@link org.apache.juneau.rest.client.RestCall#interceptor(RestCallInterceptor)} method.
</p>
</div>
@@ -755,17 +755,17 @@
<h3 class='topic' onclick='toggle(this)'>1.7 - Interceptors</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder#intercepter(RestCallInterceptor)} and
- {@link org.apache.juneau.rest.client.RestCall#intercepter(RestCallInterceptor)} methods can be used to
+ The {@link org.apache.juneau.rest.client.RestClientBuilder#interceptor(RestCallInterceptor)} and
+ {@link org.apache.juneau.rest.client.RestCall#interceptor(RestCallInterceptor)} methods can be used to
intercept responses during specific connection lifecycle events.
</p>
<p>
- The {@link org.apache.juneau.rest.client.RestCallLogger} class is an example of an intercepter that uses
+ The {@link org.apache.juneau.rest.client.RestCallLogger} class is an example of an interceptor that uses
the various lifecycle methods to log HTTP requests.
</p>
<p class='bcode'>
<jd>/**
- * Specialized intercepter for logging calls to a log file.
+ * Specialized interceptor for logging calls to a log file.
*/</jd>
<jk>public class</jk> RestCallLogger <jk>extends</jk> RestCallInterceptor {