You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2018/08/14 01:57:10 UTC

httpcomponents-core git commit: Javadoc. Do not nest in else clauses unnecessarily. Don't hide ivars.

Repository: httpcomponents-core
Updated Branches:
  refs/heads/4.4.x 8976ba34f -> 88a084717


Javadoc. Do not nest in else clauses unnecessarily. Don't hide ivars.

Project: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/commit/88a08471
Tree: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/tree/88a08471
Diff: http://git-wip-us.apache.org/repos/asf/httpcomponents-core/diff/88a08471

Branch: refs/heads/4.4.x
Commit: 88a0847175bd41e3d7ade6eb36fc1ce50e5df2bb
Parents: 8976ba3
Author: Gary Gregory <ga...@gmail.com>
Authored: Mon Aug 13 19:57:07 2018 -0600
Committer: Gary Gregory <ga...@gmail.com>
Committed: Mon Aug 13 19:57:07 2018 -0600

----------------------------------------------------------------------
 .../http/impl/AbstractHttpClientConnection.java | 32 ++++++++++++--------
 .../apache/http/entity/HttpEntityWrapper.java   |  4 ++-
 .../apache/http/entity/SerializableEntity.java  | 16 +++++-----
 3 files changed, 31 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/httpcomponents-core/blob/88a08471/httpcore/src/main/java-deprecated/org/apache/http/impl/AbstractHttpClientConnection.java
----------------------------------------------------------------------
diff --git a/httpcore/src/main/java-deprecated/org/apache/http/impl/AbstractHttpClientConnection.java b/httpcore/src/main/java-deprecated/org/apache/http/impl/AbstractHttpClientConnection.java
index 6f2b816..d8e02f8 100644
--- a/httpcore/src/main/java-deprecated/org/apache/http/impl/AbstractHttpClientConnection.java
+++ b/httpcore/src/main/java-deprecated/org/apache/http/impl/AbstractHttpClientConnection.java
@@ -61,6 +61,7 @@ import org.apache.http.util.Args;
  * <p>
  * The following parameters can be used to customize the behavior of this
  * class:
+ * </p>
  * <ul>
  *  <li>{@link org.apache.http.params.CoreProtocolPNames#STRICT_TRANSFER_ENCODING}</li>
  *  <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_HEADER_COUNT}</li>
@@ -91,6 +92,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * and {@link #createEntitySerializer()} methods in order to initialize
      * HTTP entity serializer and deserializer implementations for this
      * connection.
+     * </p>
      */
     public AbstractHttpClientConnection() {
         super();
@@ -113,6 +115,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * This method can be overridden in a super class in order to create
      * instances of {@link EntityDeserializer} using a custom
      * {@link org.apache.http.entity.ContentLengthStrategy}.
+     * </p>
      *
      * @return HTTP entity deserializer
      */
@@ -128,6 +131,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * This method can be overridden in a super class in order to create
      * instances of {@link EntitySerializer} using a custom
      * {@link org.apache.http.entity.ContentLengthStrategy}.
+     * </p>
      *
      * @return HTTP entity serialzier.
      */
@@ -142,6 +146,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * <p>
      * This method can be overridden in a super class in order to provide
      * a different implementation of the {@link HttpResponseFactory} interface.
+     * </p>
      *
      * @return HTTP response factory.
      */
@@ -158,6 +163,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * to pass a different implementation of the
      * {@link org.apache.http.message.LineParser} to the the
      * {@link DefaultHttpResponseParser} constructor.
+     * </p>
      *
      * @param buffer the session input buffer.
      * @param responseFactory the HTTP response factory.
@@ -180,6 +186,7 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * to pass a different implementation of
      * {@link org.apache.http.message.LineFormatter} to the the default implementation
      * {@link HttpRequestWriter}.
+     * </p>
      *
      * @param buffer the session output buffer
      * @param params HTTP parameters
@@ -211,29 +218,30 @@ public abstract class AbstractHttpClientConnection implements HttpClientConnecti
      * and {@link #createResponseParser(SessionInputBuffer, HttpResponseFactory, HttpParams)}
      * methods to initialize HTTP request writer and response parser for this
      * connection.
+     * </p>
      *
-     * @param inBuffer the session input buffer.
-     * @param outbuffer the session output buffer.
+     * @param sessionInputBuffer the session input buffer.
+     * @param sessionOutputBuffer the session output buffer.
      * @param params HTTP parameters.
      */
     protected void init(
-            final SessionInputBuffer inBuffer,
-            final SessionOutputBuffer outbuffer,
+            final SessionInputBuffer sessionInputBuffer,
+            final SessionOutputBuffer sessionOutputBuffer,
             final HttpParams params) {
-        this.inBuffer = Args.notNull(inBuffer, "Input session buffer");
-        this.outbuffer = Args.notNull(outbuffer, "Output session buffer");
-        if (inBuffer instanceof EofSensor) {
-            this.eofSensor = (EofSensor) inBuffer;
+        this.inBuffer = Args.notNull(sessionInputBuffer, "Input session buffer");
+        this.outbuffer = Args.notNull(sessionOutputBuffer, "Output session buffer");
+        if (sessionInputBuffer instanceof EofSensor) {
+            this.eofSensor = (EofSensor) sessionInputBuffer;
         }
         this.responseParser = createResponseParser(
-                inBuffer,
+                sessionInputBuffer,
                 createHttpResponseFactory(),
                 params);
         this.requestWriter = createRequestWriter(
-                outbuffer, params);
+                sessionOutputBuffer, params);
         this.metrics = createConnectionMetrics(
-                inBuffer.getMetrics(),
-                outbuffer.getMetrics());
+                sessionInputBuffer.getMetrics(),
+                sessionOutputBuffer.getMetrics());
     }
 
     @Override

http://git-wip-us.apache.org/repos/asf/httpcomponents-core/blob/88a08471/httpcore/src/main/java/org/apache/http/entity/HttpEntityWrapper.java
----------------------------------------------------------------------
diff --git a/httpcore/src/main/java/org/apache/http/entity/HttpEntityWrapper.java b/httpcore/src/main/java/org/apache/http/entity/HttpEntityWrapper.java
index 6081cbb..da91352 100644
--- a/httpcore/src/main/java/org/apache/http/entity/HttpEntityWrapper.java
+++ b/httpcore/src/main/java/org/apache/http/entity/HttpEntityWrapper.java
@@ -51,11 +51,13 @@ public class HttpEntityWrapper implements HttpEntity {
 
     /**
      * Creates a new entity wrapper.
+     *
+     * @param wrappedEntity the entity to wrap.
      */
     public HttpEntityWrapper(final HttpEntity wrappedEntity) {
         super();
         this.wrappedEntity = Args.notNull(wrappedEntity, "Wrapped entity");
-    } // constructor
+    }
 
     @Override
     public boolean isRepeatable() {

http://git-wip-us.apache.org/repos/asf/httpcomponents-core/blob/88a08471/httpcore/src/main/java/org/apache/http/entity/SerializableEntity.java
----------------------------------------------------------------------
diff --git a/httpcore/src/main/java/org/apache/http/entity/SerializableEntity.java b/httpcore/src/main/java/org/apache/http/entity/SerializableEntity.java
index 573df42..675c008 100644
--- a/httpcore/src/main/java/org/apache/http/entity/SerializableEntity.java
+++ b/httpcore/src/main/java/org/apache/http/entity/SerializableEntity.java
@@ -70,12 +70,16 @@ public class SerializableEntity extends AbstractHttpEntity {
     }
 
     /**
+     * Creates new instance of this class.
+     *
+     * @param serializable The object to serialize.
+     *
      * @since 4.3
      */
-    public SerializableEntity(final Serializable ser) {
+    public SerializableEntity(final Serializable serializable) {
         super();
-        Args.notNull(ser, "Source object");
-        this.objRef = ser;
+        Args.notNull(serializable, "Source object");
+        this.objRef = serializable;
     }
 
     private void createBytes(final Serializable ser) throws IOException {
@@ -96,11 +100,7 @@ public class SerializableEntity extends AbstractHttpEntity {
 
     @Override
     public long getContentLength() {
-        if (this.objSer ==  null) {
-            return -1;
-        } else {
-            return this.objSer.length;
-        }
+        return this.objSer ==  null ? -1 : this.objSer.length;
     }
 
     @Override