|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.StringEntity
@NotThreadSafe public class StringEntity
A self contained, repeatable entity that obtains its content from
a String.
| Field Summary | |
|---|---|
protected byte[] |
content
|
| Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
|---|
chunked, contentEncoding, contentType |
| Constructor Summary | |
|---|---|
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) |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.apache.http.entity.AbstractHttpEntity |
|---|
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final byte[] content
| Constructor Detail |
|---|
public StringEntity(String string,
ContentType contentType)
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 null
@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"
IllegalArgumentException - if the string parameter is null
UnsupportedEncodingException
public StringEntity(String string,
String charset)
throws UnsupportedEncodingException
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 assumed
IllegalArgumentException - if the string parameter is null
UnsupportedEncodingException - if the charset is not supported.
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 HTTP.DEF_CONTENT_CHARSET is assumed
IllegalArgumentException - if the string parameter is null
public StringEntity(String string)
throws UnsupportedEncodingException
ContentType.TEXT_PLAIN.
string - content to be used. Not null.
IllegalArgumentException - if the string parameter is null
UnsupportedEncodingException - if the default HTTP charset is not supported.| Method Detail |
|---|
public boolean isRepeatable()
HttpEntity
isRepeatable in interface HttpEntitypublic long getContentLength()
HttpEntity
getContentLength 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
HttpEntity
IMPORTANT: 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 to
IOException - if an I/O error occurspublic boolean isStreaming()
isStreaming in interface HttpEntityfalse
public Object clone()
throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||