public class StringEntity extends AbstractHttpEntity implements Cloneable
String.| Modifier and Type | Field and Description |
|---|---|
protected byte[] |
content |
chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE| 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,
ContentType contentType)
Creates a StringEntity with the specified content and content type.
|
StringEntity(String string,
String charset)
Creates a StringEntity with the specified content and charset.
|
StringEntity(String string,
String mimeType,
String charset)
Deprecated.
(4.1.3) use
StringEntity(String, ContentType) |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone() |
InputStream |
getContent()
Returns a content stream of the entity.
|
long |
getContentLength()
Tells the length of the content, if known.
|
boolean |
isRepeatable()
Tells if the entity is capable of producing its data more than once.
|
boolean |
isStreaming()
Tells that this entity is not streaming.
|
void |
writeTo(OutputStream outStream)
Writes the entity content out to the output stream.
|
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toStringpublic StringEntity(String string, ContentType contentType) throws UnsupportedCharsetException
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.IllegalArgumentException - if the string parameter is nullUnsupportedCharsetException - Thrown when the named charset is not available in
this instance of the Java virtual machine@Deprecated public StringEntity(String string, String mimeType, String charset) throws UnsupportedEncodingException
StringEntity(String, ContentType)string - content to be used. Not null.mimeType - MIME type to be used. May be null, in which case the default
is HTTP.PLAIN_TEXT_TYPE i.e. "text/plain"charset - character set to be used. May be null, in which case the default
is HTTP.DEF_CONTENT_CHARSET i.e. "ISO-8859-1"UnsupportedEncodingException - If the named charset is not supported.IllegalArgumentException - if the string parameter is nullpublic StringEntity(String string, String charset) throws UnsupportedCharsetException
string - content to be used. Not null.charset - character set to be used. May be null, in which case the default
is HTTP.DEF_CONTENT_CHARSET is assumedIllegalArgumentException - if the string parameter is nullUnsupportedCharsetException - Thrown when the named charset is not available in
this instance of the Java virtual machinepublic 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 HTTP.DEF_CONTENT_CHARSET is assumedIllegalArgumentException - if the string parameter is nullpublic StringEntity(String string) throws UnsupportedEncodingException
ContentType.TEXT_PLAIN.string - content to be used. Not null.IllegalArgumentException - if the string parameter is nullUnsupportedEncodingException - if the default HTTP charset is not supported.public boolean isRepeatable()
HttpEntityisRepeatable in interface HttpEntitypublic long getContentLength()
HttpEntitygetContentLength in interface HttpEntityLong.MAX_VALUE,
a negative number is returned.public 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.
IMPORTANT: Please note all entity implementations must ensure that
all allocated resources are properly deallocated after
the InputStream.close() method is invoked.
getContent in interface HttpEntityIOException - if the stream could not be createdHttpEntity.isRepeatable()public 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 HttpEntityoutStream - the output stream to write entity content toIOException - if an I/O error occurspublic boolean isStreaming()
isStreaming in interface HttpEntityfalsepublic Object clone() throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.