Class NullEntity
- java.lang.Object
-
- org.apache.hc.core5.http.io.entity.NullEntity
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,EntityDetails
,HttpEntity
@Contract(threading=IMMUTABLE) public final class NullEntity extends java.lang.Object implements HttpEntity
An empty entity with no content-type. This type may be used for convenience in place of an emptyByteArrayEntity
.- Since:
- 5.1
-
-
Field Summary
Fields Modifier and Type Field Description static NullEntity
INSTANCE
-
Constructor Summary
Constructors Modifier Constructor Description private
NullEntity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
java.io.InputStream
getContent()
Returns a content stream of the entity.java.lang.String
getContentEncoding()
Returns content encoding of the entity, if known.long
getContentLength()
Returns length of the entity, if known.java.lang.String
getContentType()
Returns content type of the entity, if known.java.util.Set<java.lang.String>
getTrailerNames()
Preliminary declaration of trailing headers.Supplier<java.util.List<? extends Header>>
getTrailers()
Returns supplier of message trailers - headers sent after message body.boolean
isChunked()
Returns chunked transfer hint for this entity.boolean
isRepeatable()
Tells if the entity is capable of producing its data more than once.boolean
isStreaming()
Tells whether this entity depends on an underlying stream.void
writeTo(java.io.OutputStream outStream)
Writes the entity content out to the output stream.
-
-
-
Field Detail
-
INSTANCE
public static final NullEntity INSTANCE
-
-
Method Detail
-
isRepeatable
public boolean isRepeatable()
Description copied from interface:HttpEntity
Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.- Specified by:
isRepeatable
in interfaceHttpEntity
- Returns:
- true if the entity is repeatable, false otherwise.
-
getContent
public java.io.InputStream getContent() throws java.io.IOException, java.lang.UnsupportedOperationException
Description copied from interface:HttpEntity
Returns a content stream of the entity.Repeatable
entities are expected to create a new instance ofInputStream
for each invocation of this method and therefore can be consumed multiple times. Entities that are notrepeatable
are expected to return the sameInputStream
instance and therefore may not be consumed more than once.If this entity belongs to an incoming HTTP message, calling
InputStream.close()
on the returnedInputStream
will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the
InputStream.close()
method is invoked.- Specified by:
getContent
in interfaceHttpEntity
- Returns:
- content stream of the entity.
- Throws:
java.io.IOException
- if the stream could not be createdjava.lang.UnsupportedOperationException
- if entity content cannot be represented asInputStream
.- See Also:
HttpEntity.isRepeatable()
-
writeTo
public void writeTo(java.io.OutputStream outStream) throws java.io.IOException
Description copied from interface:HttpEntity
Writes the entity content out to the output stream.IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
- Specified by:
writeTo
in interfaceHttpEntity
- Parameters:
outStream
- the output stream to write entity content to- Throws:
java.io.IOException
- if an I/O error occurs
-
isStreaming
public boolean isStreaming()
Description copied from interface:HttpEntity
Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should returntrue
. Self-contained entities should returnfalse
. Wrapping entities should delegate this call to the wrapped entity.- Specified by:
isStreaming
in interfaceHttpEntity
- Returns:
true
if the entity content is streamed,false
otherwise
-
getTrailers
public Supplier<java.util.List<? extends Header>> getTrailers()
Description copied from interface:HttpEntity
Returns supplier of message trailers - headers sent after message body. May returnnull
if trailers are not available.- Specified by:
getTrailers
in interfaceHttpEntity
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
java.io.IOException
-
getContentLength
public long getContentLength()
Description copied from interface:EntityDetails
Returns length of the entity, if known.- Specified by:
getContentLength
in interfaceEntityDetails
-
getContentType
public java.lang.String getContentType()
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
getContentEncoding
public java.lang.String getContentEncoding()
Description copied from interface:EntityDetails
Returns content encoding of the entity, if known.- Specified by:
getContentEncoding
in interfaceEntityDetails
-
isChunked
public boolean isChunked()
Description copied from interface:EntityDetails
Returns chunked transfer hint for this entity.The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
- Specified by:
isChunked
in interfaceEntityDetails
-
getTrailerNames
public java.util.Set<java.lang.String> getTrailerNames()
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
-