@Contract(threading=IMMUTABLE) public class StringEntity extends AbstractHttpEntity
String.| Constructor and Description |
|---|
StringEntity(String string)
Creates a StringEntity with the specified content.
|
StringEntity(String string,
Charset charset)
Creates a StringEntity with the specified content and charset.
|
StringEntity(String string,
Charset charset,
boolean chunked) |
StringEntity(String string,
ContentType contentType) |
StringEntity(String string,
ContentType contentType,
boolean chunked) |
StringEntity(String string,
ContentType contentType,
String contentEncoding,
boolean chunked)
Creates a StringEntity with the specified content and content type.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Returns length of the entity, if known.
|
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(OutputStream outStream)
Writes the entity content out to the output stream.
|
getContentEncoding, getContentType, getTrailerNames, getTrailers, isChunked, toString, writeTopublic StringEntity(String string, ContentType contentType, String contentEncoding, boolean chunked)
string - content to be used. Not null.contentType - content type to be used. May be null, in which case the default
MIME type ContentType.TEXT_PLAIN is assumed.public StringEntity(String string, ContentType contentType, boolean chunked)
public StringEntity(String string, ContentType contentType)
public StringEntity(String string, Charset charset)
string - content to be used. Not null.charset - character set to be used. May be null, in which case the default
is StandardCharsets.ISO_8859_1 is assumedpublic StringEntity(String string)
ContentType.TEXT_PLAIN.string - content to be used. Not null.IllegalArgumentException - if the string parameter is nullpublic final boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntityisRepeatable in class AbstractHttpEntitypublic final long getContentLength()
EntityDetailspublic final InputStream getContent() throws IOException
HttpEntityRepeatable entities are expected
to create a new instance of InputStream for each invocation
of this method and therefore can be consumed multiple times.
Entities that are not repeatable are expected
to return the same InputStream instance and therefore
may not be consumed more than once.
If this entity belongs to an incoming HTTP message, calling
InputStream.close() on the returned InputStream 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.
IOException - if the stream could not be createdHttpEntity.isRepeatable()public final void writeTo(OutputStream outStream) throws IOException
HttpEntityIMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo in interface HttpEntitywriteTo in class AbstractHttpEntityoutStream - the output stream to write entity content toIOException - if an I/O error occurspublic final boolean isStreaming()
HttpEntitytrue. Self-contained entities should return
false. Wrapping entities should delegate this call
to the wrapped entity.true if the entity content is streamed,
false otherwisepublic final void close()
throws IOException
IOExceptionCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.