Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Mostly missing Javadoc in org.apache.hc.client5.http.entity and minor 

clean ups
This commit is contained in:
Gary Gregory 2023-06-28 21:01:50 -04:00 committed by Gary Gregory
parent 635f5f475b
commit 09ae5f212a
4 changed files with 95 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/Resource.java vendored
View File

@ -48,7 +48,7 @@ public abstract class Resource implements Serializable {
private static final long serialVersionUID = 1L;
/**
* Returns resource content as a {@link InputStream}.
* Returns resource content as an {@link InputStream}.
*
* @throws ResourceIOException
*/

3
httpclient5/src/main/java/org/apache/hc/client5/http/entity/DecompressingEntity.java
View File

@ -47,6 +47,7 @@ public class DecompressingEntity extends HttpEntityWrapper {
private static final int BUFFER_SIZE = 1024 * 2;
private final InputStreamFactory inputStreamFactory;
/**
* {@link #getContent()} method must return the same {@link InputStream}
* instance when DecompressingEntity is wrapping a streaming entity.
@ -54,7 +55,7 @@ public class DecompressingEntity extends HttpEntityWrapper {
private InputStream content;
/**
* Creates a new {@link DecompressingEntity}.
* Constructs a new {@link DecompressingEntity}.
*
* @param wrapped the non-null {@link HttpEntity} to be wrapped
* @param inputStreamFactory factory to create decompressing stream.

102
httpclient5/src/main/java/org/apache/hc/client5/http/entity/EntityBuilder.java
View File

@ -92,7 +92,9 @@ public class EntityBuilder {
}
/**
* Returns entity content as a string if set using {@link #setText(String)} method.
* Gets the entity content as a string if set using {@link #setText(String)}.
*
* @return the entity content as a string, may be null.
*/
public String getText() {
return text;
@ -106,6 +108,9 @@ public class EntityBuilder {
* {@link #setParameters(java.util.List)},
* {@link #setParameters(NameValuePair...)}
* {@link #setFile(java.io.File)} methods.
*
* @param text entity content as a string.
* @return this
*/
public EntityBuilder setText(final String text) {
clearContent();
@ -114,8 +119,10 @@ public class EntityBuilder {
}
/**
* Returns entity content as a byte array if set using
* {@link #setBinary(byte[])} method.
* Gets entity content as a byte array if set using
* {@link #setBinary(byte[])}.
*
* @return entity content as a byte array.
*/
public byte[] getBinary() {
return binary;
@ -128,7 +135,10 @@ public class EntityBuilder {
* {@link #setSerializable(java.io.Serializable)},
* {@link #setParameters(java.util.List)},
* {@link #setParameters(NameValuePair...)}
* {@link #setFile(java.io.File)} methods.
* {@link #setFile(java.io.File)}.
*
* @param binary The new entity content as a byte array.
* @return this
*/
public EntityBuilder setBinary(final byte[] binary) {
clearContent();
@ -137,21 +147,26 @@ public class EntityBuilder {
}
/**
* Returns entity content as a {@link InputStream} if set using
* Gets entity content as an {@link InputStream} if set using
* {@link #setStream(java.io.InputStream)} method.
*
* @return entity content as an {@link InputStream}
*/
public InputStream getStream() {
return stream;
}
/**
* Sets entity content as a {@link InputStream}. This method is mutually exclusive with
* Sets entity content as an {@link InputStream}. This method is mutually exclusive with
* {@link #setText(String)},
* {@link #setBinary(byte[])},
* {@link #setSerializable(java.io.Serializable)},
* {@link #setParameters(java.util.List)},
* {@link #setParameters(NameValuePair...)}
* {@link #setFile(java.io.File)} methods.
* {@link #setFile(java.io.File)}.
*
* @param stream The new entity content as an InputStream.
* @return this
*/
public EntityBuilder setStream(final InputStream stream) {
clearContent();
@ -160,9 +175,11 @@ public class EntityBuilder {
}
/**
* Returns entity content as a parameter list if set using
* Gets entity content as a parameter list if set using
* {@link #setParameters(java.util.List)} or
* {@link #setParameters(NameValuePair...)} methods.
* {@link #setParameters(NameValuePair...)}.
*
* @return entity content as a parameter list.
*/
public List<NameValuePair> getParameters() {
return parameters;
@ -174,7 +191,10 @@ public class EntityBuilder {
* {@link #setBinary(byte[])},
* {@link #setStream(java.io.InputStream)},
* {@link #setSerializable(java.io.Serializable)},
* {@link #setFile(java.io.File)} methods.
* {@link #setFile(java.io.File)}.
*
* @param parameters entity content as a parameter list.
* @return this
*/
public EntityBuilder setParameters(final List<NameValuePair> parameters) {
clearContent();
@ -188,15 +208,20 @@ public class EntityBuilder {
* {@link #setBinary(byte[])},
* {@link #setStream(java.io.InputStream)},
* {@link #setSerializable(java.io.Serializable)},
* {@link #setFile(java.io.File)} methods.
* {@link #setFile(java.io.File)}.
*
* @param parameters entity content as a parameter list.
* @return this
*/
public EntityBuilder setParameters(final NameValuePair... parameters) {
return setParameters(Arrays.asList(parameters));
}
/**
* Returns entity content as a {@link Serializable} if set using
* Gets entity content as a {@link Serializable} if set using
* {@link #setSerializable(java.io.Serializable)} method.
*
* @return entity content as a {@link Serializable}.
*/
public Serializable getSerializable() {
return serializable;
@ -209,7 +234,10 @@ public class EntityBuilder {
* {@link #setStream(java.io.InputStream)},
* {@link #setParameters(java.util.List)},
* {@link #setParameters(NameValuePair...)}
* {@link #setFile(java.io.File)} methods.
* {@link #setFile(java.io.File)}.
*
* @param serializable entity content as a {@link Serializable}.
* @return this
*/
public EntityBuilder setSerializable(final Serializable serializable) {
clearContent();
@ -218,8 +246,10 @@ public class EntityBuilder {
}
/**
* Returns entity content as a {@link File} if set using
* {@link #setFile(java.io.File)} method.
* Gets the entity content as a {@link File} if set using
* {@link #setFile(java.io.File)}.
*
* @return Gets the entity content as a {@link File}.
*/
public File getFile() {
return file;
@ -232,7 +262,10 @@ public class EntityBuilder {
* {@link #setStream(java.io.InputStream)},
* {@link #setParameters(java.util.List)},
* {@link #setParameters(NameValuePair...)}
* {@link #setSerializable(java.io.Serializable)} methods.
* {@link #setSerializable(java.io.Serializable)}.
*
* @param file entity content as a {@link File}.
* @return this
*/
public EntityBuilder setFile(final File file) {
clearContent();
@ -241,14 +274,19 @@ public class EntityBuilder {
}
/**
* Returns {@link ContentType} of the entity, if set.
* Gets the {@link ContentType} of the entity, may be null.
*
* @return the {@link ContentType} of the entity, may be null.
*/
public ContentType getContentType() {
return contentType;
}
/**
* Sets {@link ContentType} of the entity.
* Sets the {@link ContentType} of the entity.
*
* @param contentType the {@link ContentType} of the entity, may be null.
* @return this
*/
public EntityBuilder setContentType(final ContentType contentType) {
this.contentType = contentType;
@ -256,14 +294,19 @@ public class EntityBuilder {
}
/**
* Returns content encoding of the entity, if set.
* Gets the content encoding of the entity, may be null.
*
* @return the content encoding of the entity, may be null.
*/
public String getContentEncoding() {
return contentEncoding;
}
/**
* Sets content encoding of the entity.
* Sets the content encoding of the entity.
*
* @param contentEncoding the content encoding of the entity, may be null.
* @return this
*/
public EntityBuilder setContentEncoding(final String contentEncoding) {
this.contentEncoding = contentEncoding;
@ -271,14 +314,17 @@ public class EntityBuilder {
}
/**
* Returns {@code true} if entity is to be chunk coded, {@code false} otherwise.
* Tests if the entity is to be chunk coded ({@code true}), or not ({@code false}).
*
* @return {@code true} if entity is to be chunk coded, {@code false} otherwise.
*/
public boolean isChunked() {
return chunked;
}
/**
* Makes entity chunk coded.
* Sets entities to be chunked.
* @return this
*/
public EntityBuilder chunked() {
this.chunked = true;
@ -286,14 +332,18 @@ public class EntityBuilder {
}
/**
* Returns {@code true} if entity is to be GZIP compressed, {@code false} otherwise.
* Tests if entities are to be GZIP compressed ({@code true}), or not ({@code false}).
*
* @return {@code true} if entity is to be GZIP compressed, {@code false} otherwise.
*/
public boolean isGzipCompressed() {
return gzipCompressed;
}
/**
* Makes entity GZIP compressed.
* Sets entities to be GZIP compressed.
*
* @return this
*/
public EntityBuilder gzipCompressed() {
this.gzipCompressed = true;
@ -305,7 +355,9 @@ public class EntityBuilder {
}
/**
* Creates new instance of {@link HttpEntity} based on the current state.
* Builds a new instance of {@link HttpEntity} based on the current state.
*
* @return a new instance.
*/
public HttpEntity build() {
final AbstractHttpEntity e;

3
httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.java
View File

@ -302,7 +302,7 @@ public class PoolingAsyncClientConnectionManager implements AsyncClientConnectio
leaseCompleted(poolEntry);
})), Command.Priority.IMMEDIATE);
return;
} else {
}
if (LOG.isDebugEnabled()) {
LOG.debug("{} connection {} is closed", id, ConnPoolSupport.getId(connection));
}
@ -310,7 +310,6 @@ public class PoolingAsyncClientConnectionManager implements AsyncClientConnectio
}
}
}
}
leaseCompleted(poolEntry);
}